{"id":7636,"date":"2021-09-26T07:20:48","date_gmt":"2021-09-26T11:20:48","guid":{"rendered":"https:\/\/springframework.guru\/?p=7636"},"modified":"2022-02-04T12:30:05","modified_gmt":"2022-02-04T17:30:05","slug":"bootstrapping-data-in-spring-boot","status":"publish","type":"post","link":"https:\/\/springframework.guru\/bootstrapping-data-in-spring-boot\/","title":{"rendered":"Bootstrapping Data in Spring Boot"},"content":{"rendered":"

While developing a Spring Boot Application, sometimes we need to run a piece of code at startup. This code can be anything. You might want to log certain information or run some cron jobs or send some notifications. Or you might even want to start the application with seed data in the database.<\/p>\n

In this post, We will take a look at different approaches to bootstrap a Spring Boot application during startup.<\/p>\n

Bootstrapping with Spring Boot<\/h2>\n

Spring Boot offers different ways to execute logic on startup. One of the common ways is to use the CommandLineRunner<\/code> Interface.<\/p>\n

Using CommandLineRunner<\/h2>\n

CommandLineRunner<\/code> is an interface used to indicate that a bean should run when it is contained within a SpringApplication.<\/p>\n

In this example code, I will create a domain object to model meme creaters. I will use the embedded H2<\/code> database for the demo.<\/p>\n

Maven Dependency<\/h2>\n

For this demo, you need the following core dependencies in your pom.xml<\/code> file.<\/p>\n

pom.xml<\/strong><\/p>\n

\t<dependency>\r\n\t    <groupId>org.springframework.boot<\/groupId>\r\n            lt;artifactId>spring-boot-starter-web<\/artifactId>\r\n        <\/dependency>\r\n\r\n       <dependency>\r\n            <groupId>com.h2database<\/groupId>\r\n            <artifactId>h2<\/artifactId>\r\n            <scope>runtime<\/scope>\r\n        <\/dependency>\r\n\r\n        <dependency>\r\n            <groupId>org.springframework.boot<\/groupId>\r\n            <artifactId>spring-boot-starter-data-jpa<\/artifactId>\r\n        <\/dependency>\r\n        <dependency>\r\n           <groupId>org.projectlombok<\/groupId>\r\n             <artifactId>lombok<\/artifactId>\r\n              <scope>provided<\/scope>\r\n\t<\/dependency>\r\n<\/pre>\n
The Domain Class<\/strong><\/p>\n
The code of the MemeMaker<\/code> domain class is this.<\/p>\n
MemeMaker.java<\/strong><\/p>\n
@Entity\r\n@Table(name = \"memes\")\r\n@Getter\r\n@Setter\r\npublic class MemeMaker {\r\n\r\n    @Id\r\n    @GeneratedValue(strategy = GenerationType.AUTO)\r\n    private int memeId;\r\n    private String memeMaker;\r\n    private String memeLevel;\r\n    private String memeCategory;\r\n\r\n    public MemeMaker() {\r\n    }\r\n\r\n    public MemeMaker(String memeMaker, String memeLevel, String memeCategory) {\r\n        this.memeMaker = memeMaker;\r\n        this.memeLevel = memeLevel;\r\n        this.memeCategory = memeCategory;\r\n    }\r\n}\r\n<\/pre>\n
The preceding code uses Lombok<\/code> to reduce boilerplate code. If you are new to Lombok<\/code>, I suggest going through my post on Lombok<\/a>.<\/p>\n
The code of the Repository Interface is this.<\/p>\n
MemeRepository<\/strong><\/p>\n
@Repository\r\npublic interface MemeRepository extends CrudRepository<MemeMaker, Integer> {\r\n}\r\n<\/pre>\n
The configuration properties for H2 in-memory database is set in the application.properties<\/code> file.<\/p>\n
application.properties<\/strong><\/p>\n
spring.h2.console.enabled=true\r\nspring.datasource.url=jdbc:h2:mem:memedb\r\n<\/pre>\n
The h2 console is set to true in Line 1 which enables the h2-console view in the browser, and the datasource.url<\/code> is set to jdbc:h2:mem:memedb<\/code> where memedb<\/code> is the set database name.<\/p>\n
The code for BootstrapCommandLineRunner<\/code> class, that bootstraps the application with seed data, is this.<\/p>\n
BootstrapCommandLineRunner.java<\/strong><\/p>\n
@Component\r\npublic class BootstrapCommandLineRunner implements CommandLineRunner {\r\n\r\n    private MemeRepository memeRepository;\r\n\r\n    @Autowired\r\n    public BootstrapCommandLineRunner(MemeRepository memeRepository) {\r\n        this.memeRepository = memeRepository;\r\n    }\r\n\r\n    @Override\r\n    public void run(String... args) throws Exception {\r\n\r\n        memeRepository.save(new MemeMaker(\"Alex\",\"Novice\", \"Sports\"));\r\n        memeRepository.save(new MemeMaker(\"John\",\"OG\", \"Wholesome\"));\r\n        memeRepository.findAll().forEach((meme) -> {\r\n        });\r\n    }\r\n}\r\n<\/pre>\n
The preceding code annotates the class with @Component<\/code> so that Spring detects it during component scanning. When you start the application, the overriden run()<\/code> method will execute.<\/p>\n
With the @Autowired<\/code> annotation in Line 6, we inject the MemeRepository<\/code> bean into the repository field.<\/p>\n
The run()<\/code> method uses the @Autowired<\/code> \u00a0MemeRepository<\/code>\u00a0to create two Meme<\/code> objects and stores them in the H2<\/code> database.<\/p>\n
Note<\/strong>: A Spring Boot application can have multiple beans implementing CommandLineRunner<\/code>. These can be ordered with @Order<\/code> annotation.<\/p>\n
Bootstrapping with Spring Framework<\/h2>\n
The Spring Framework provides the ApplicationListener<\/code> interface that allows you to tap into various events of the framework. One such event that you can handle to bootstrap data is ContextRefreshedEvent<\/code>.<\/p>\n
The following code shows how to use the ApplicationListener<\/code> interface.<\/p>\n
BootstrapApplicationListener.java<\/strong><\/p>\n
@Component\r\npublic class BootstrapApplicationListener implements ApplicationListener {\r\n\r\n    private MemeRepository memeRepository;\r\n\r\n    @Autowired\r\n    public BootstrapApplicationListener(MemeRepository memeRepository) {\r\n        this.memeRepository = memeRepository;\r\n    }\r\n\r\n    @Override\r\n    public void onApplicationEvent(ContextRefreshedEvent contextRefreshedEvent) {\r\n        memeRepository.save(new MemeMaker(\"Bob\",\"Noobie\", \"Horror\"));\r\n        memeRepository.save(new MemeMaker(\"Hitman\",\"OG\", \"Global\"));\r\n\r\n    }\r\n}\r\n<\/pre>\n
The preceding code overrides the overloaded onApplicationEvent(ContextRefreshedEvent contextRefreshedEvent)<\/code>\u00a0 method of ApplicationListener<\/code>. Inside this method, the code uses the autowired repository to create and save two Memes objects.<\/p>\n
Console Output<\/h2>\n
After you login to the H2 database on the URL localhost:8080\/h2-console<\/code> using the JDBC URL set in application.properties<\/code>, you will see the following output.<\/p>\n
\"\"<\/a><\/p>\n
Summary<\/h2>\n
In addition to the most common bootstrapping approaches I have shown, there are also other ways to do the same thing. One is using the @PostConstruct<\/code> annotation. Another is to use ApplicationRunner<\/code> instead of CommandLineRunner<\/code>. Although both are different ways to do the same things, they are different based on what the run()<\/code> method accepts. The run()<\/code> method of CommandLineRunner<\/code> accepts raw Strings. On the other hand, ApplicationRunner<\/code> accepts an instance of ApplicationArguments<\/code>\u00a0so that you can access the bootstrap arguments passed when initializing the application.<\/p>\n
You can find the source code of this post here on Github<\/a>.<\/p>\n
For in-depth knowledge on executing logic on Startup, you can check my Udemy Best Seller Course Spring Framework 5: Beginner to Guru<\/a>
\n\"\"<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
While developing a Spring Boot Application, sometimes we need to run a piece of code at startup. This code can be anything. You might want to log certain information or run some cron jobs or send some notifications. Or you might even want to start the application with seed data in the database. In this […]Continue reading<\/a><\/p>\n","protected":false},"author":111,"featured_media":4655,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_lmt_disableupdate":"","_lmt_disable":"","_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"_uf_show_specific_survey":0,"_uf_disable_surveys":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","enabled":false},"version":2}},"categories":[21,104],"tags":[379,40,29],"class_list":["post-7636","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-spring","category-spring-boot","tag-bootstrap-data","tag-spring","tag-spring-boot"],"jetpack_publicize_connections":[],"aioseo_notices":[],"modified_by":"jt","jetpack_sharing_enabled":true,"jetpack_featured_media_url":"https:\/\/springframework.guru\/wp-content\/uploads\/2017\/07\/NewBannerBOOTSWeb.jpg","jetpack_shortlink":"https:\/\/wp.me\/p5BZrZ-1Za","_links":{"self":[{"href":"https:\/\/springframework.guru\/wp-json\/wp\/v2\/posts\/7636"}],"collection":[{"href":"https:\/\/springframework.guru\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/springframework.guru\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/springframework.guru\/wp-json\/wp\/v2\/users\/111"}],"replies":[{"embeddable":true,"href":"https:\/\/springframework.guru\/wp-json\/wp\/v2\/comments?post=7636"}],"version-history":[{"count":35,"href":"https:\/\/springframework.guru\/wp-json\/wp\/v2\/posts\/7636\/revisions"}],"predecessor-version":[{"id":7766,"href":"https:\/\/springframework.guru\/wp-json\/wp\/v2\/posts\/7636\/revisions\/7766"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/springframework.guru\/wp-json\/wp\/v2\/media\/4655"}],"wp:attachment":[{"href":"https:\/\/springframework.guru\/wp-json\/wp\/v2\/media?parent=7636"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/springframework.guru\/wp-json\/wp\/v2\/categories?post=7636"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/springframework.guru\/wp-json\/wp\/v2\/tags?post=7636"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}