SpringBoot-初期データのロード

この投稿では、後でSpringBootアプリケーションで使用するためにデータベースに初期データをロードする方法について説明します。

まず、初期データが必要になる理由を見てみましょう。

• 最初の使用例は、アプリケーションの開始後に、データベースにすでに作成されているデータが必要になる場合があることです。Webサイトをスクレイプして大量のデータを収集し、それをアプリケーションの通常のフローで使用することを計画している状況を想像してみてください。このような状況が発生した場合は、アプリケーションの起動直後に収集したデータを読み込む必要があります。
• 別のユースケースは、テスト目的で初期データをロードすることです。テストデータのセットを準備し、アプリケーションを開始した直後にそれらをロードすると、アプリケーションをテストフェーズに進めることができます。

• @PostConstruct、アプリケーションの起動直後に実行されるメソッドで使用されるメインのアノテーション。
• @Profile、本番やテストなどのフェーズに応じて実行するクラスを決定するためのサイドアノテーション。

@Component
@Profile("dev")
public class UserInit {
    private final BCryptPasswordEncoder bCryptPasswordEncoder;
    private final UserRepository userRepository;
    @Autowired
    public UserInit(BCryptPasswordEncoder bCryptPasswordEncoder, UserRepository userRepository) {
        this.bCryptPasswordEncoder = bCryptPasswordEncoder;
        this.userRepository = userRepository;
    }
    @PostConstruct
    public void createTestUsers() {
        if (!userRepository.findByUsername("admin").isPresent()) {
            User admin = new User()
                    .setUsername("admin")
                    .setPassword(bCryptPasswordEncoder.encode("123"))
                    .setRoles(Arrays.asList(Role.ADMIN))
                    .setEmail("[email protected]");
            userRepository.save(admin);
        }
        if (!userRepository.findByUsername("user").isPresent()) {
            User user = new User()
                    .setUsername("user")
                    .setPassword(bCryptPasswordEncoder.encode("123"))
                    .setRoles(Arrays.asList(Role.USER))
                    .setEmail("[email protected]");
            userRepository.save(user);
        }
    }
}

spring.profiles.active=dev

別の状況を想像することができます。たとえば、アプリケーションを開始する前に、xmlファイルからデータセットをロードする必要があるとします。同じ方法でそれを実現し、PostConstructでメソッドにアノテーションを付けてから、ロジックをその中に入れます。

@PostConstruct
public void loadFromXml() {
    // some code to read xml that is not our focus right now
    for (XmlObject xmlObject : XmlFile) {
        repository.save(xmlObject);   
    }
}

もちろん、これは初期データのロードに限定されるものではなく、アプリケーションの起動後に実行するロジックを使用することもできます。

この記事では、アプリケーションに初期データをロードする方法について説明しました。楽しんでいただき、お役に立てば幸いです。