Skip to content

Stork Spring Boot Config#

Stork seamlessly supports Spring Boot configuration, facilitating access to configuration properties. This documentation elaborates on how Spring Boot developers can use Stork in their Spring Boot applications and configure it using the application.properties file.

Dependency setup#

To enable Spring Boot configuration integration in Stork, you need to include the following dependency:

<dependency>
    <groupId>io.smallrye.stork</groupId>
    <artifactId>stork-spring-boot-config</artifactId>
    <version>2.6.0</version>
</dependency>

Initializing Stork#

Since Spring Boot lacks a pre-configured Stork instance, you’ll need create one. It can be done by providing a Spring bean performing Stork initialization:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
package examples;

import io.smallrye.stork.Stork;
import io.smallrye.stork.springboot.SpringBootApplicationContextProvider;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.DependsOn;

@SpringBootApplication
public class SpringBootInitializationExample {

    public static void main(String[] args) {
        SpringApplication.run(SpringBootInitializationExample.class, args);
    }

    @Bean
    @DependsOn("springBootApplicationContextProvider")
    public Stork stork() {
        Stork.initialize();
        Stork stork = Stork.getInstance();
        return stork;
    }

    @Bean
    public SpringBootApplicationContextProvider springBootApplicationContextProvider() {
        return new SpringBootApplicationContextProvider();
    }
}
Upon initialization, Stork scans for the io.smallrye.stork.springboot.SpringBootConfigProvider SPI provider and CDI beans (from version 2.x onwards). It then builds a comprehensive list of managed services by parsing the properties configuration files.

Please note the importance of the io.smallrye.stork.springboot.SpringBootApplicationContextProvider bean in our setup. This bean has a critical role by granting Stork access to the current org.springframework.context.ApplicationContext. It enables it to retrieve configuration details effectively. Consequently, it’s imperative that this bean is instantiated prior to initiating the Stork initialization process. In this case, we utilize the @DependsOn annotation for that. It allows us controlling the bean creation order.

Comprehensive Example#

You can check our Guitar Hero Application showcasing the seamless integration of Stork with Spring Boot Configuration.