春のブートプロファイルの例

Spring Bootプロファイルの例

この記事では、Spring Bootで@Profileを使用する方法と、それをテストする方法を紹介します。

テスト済み：

Spring Boot 2.1.2.RELEASE
メーベン3

1. プロジェクト構造

標準のMavenプロジェクト構造。

2. プロジェクトの依存関係

pom.xml


    4.0.0

    spring-boot-profile
    jar
    Spring Boot Profiles Example
    Spring Boot Profiles Example
    https://www.example.com
    1.0

    
        org.springframework.boot
        spring-boot-starter-parent
        2.1.2.RELEASE
    

    
        1.8
    

    
        
            org.springframework.boot
            spring-boot-starter
        
        
            org.springframework.boot
            spring-boot-starter-test
            test
        
    

    
        
            
            
                org.springframework.boot
                spring-boot-maven-plugin
            

            
                org.apache.maven.plugins
                maven-surefire-plugin
                2.22.0

3. 春のブーツ

Spring Bootでは、デフォルトのプロファイルは ‘default‘です。次の気象サービスを確認します。

3.1 An interface.

WeatherService.java

package com.example.service;

public interface WeatherService {

    String forecast();

}

3.2 Profile : sunny and default.

SunnyDayService.java

package com.example.service;

import org.springframework.context.annotation.Profile;
import org.springframework.stereotype.Service;

@Service
@Profile({"sunny", "default"})
public class SunnyDayService implements WeatherService {

    @Override
    public String forecast() {
        return "Today is sunny day!";
    }

}

3.3 Profile : raining.

RainingDayService.java

package com.example.service;

import org.springframework.context.annotation.Profile;
import org.springframework.stereotype.Service;

@Service
@Profile("raining")
public class RainingDayService implements WeatherService {

    @Override
    public String forecast() {
        return "Today is raining day!";
    }

}

3.4 Start Spring Boot application.

Application.java

package com.example;

import com.example.service.WeatherService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application implements CommandLineRunner {

    @Autowired
    private WeatherService weatherService;

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

    @Override
    public void run(String... args) {
        System.out.println(weatherService.forecast());
    }

}

3.5 A properties file.

application.properties

# default profile is 'default'
#spring.profiles.active=sunny

logging.level.=error
spring.main.banner-mode=off

4. 単体テスト

単体テストの例。

4.1 Unit test a service class. @ActiveProfilesを介してアクティブなプロファイルを設定します

TestWeatherService.java

package com.example;

import com.example.service.WeatherService;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.ActiveProfiles;
import org.springframework.test.context.junit4.SpringRunner;

import static org.assertj.core.api.Assertions.assertThat;

@RunWith(SpringRunner.class)
@SpringBootTest
@ActiveProfiles("raining")
public class TestWeatherService {

    @Autowired
    WeatherService weatherService;

    @Test
    public void testRainingProfile() {
        String output = weatherService.forecast();
        assertThat(output).contains("Today is raining day!");
    }
}

4.2 Unit test a Spring Boot application. プロパティspring.profiles.activeを介してアクティブなプロファイルを設定できます

TestApplication.java

package com.example;

import org.junit.After;
import org.junit.Rule;
import org.junit.Test;
import org.springframework.boot.test.rule.OutputCapture;

import static org.assertj.core.api.Assertions.assertThat;

public class TestApplication {

    @Rule
    public OutputCapture outputCapture = new OutputCapture();

    @Test
    public void testDefaultProfile() {
        Application.main(new String[0]);
        String output = this.outputCapture.toString();
        assertThat(output).contains("Today is sunny day!");
    }

    @Test
    public void testRainingProfile() {
        System.setProperty("spring.profiles.active", "raining");
        Application.main(new String[0]);
        String output = this.outputCapture.toString();
        assertThat(output).contains("Today is raining day!");
    }

    @Test
    public void testRainingProfile_withDoption() {
        Application.main(new String[]{"--spring.profiles.active=raining"});
        String output = this.outputCapture.toString();
        assertThat(output).contains("Today is raining day!");
    }

    @After
    public void after() {
        System.clearProperty("spring.profiles.active");
    }

}

P.S Credit to this Spring Boot SampleProfileApplicationTests

5. DEMO

パッケージ化して実行します。

$ mvn package

#default profile, sunny day!
$ java -jar target/spring-boot-profile-1.0.jar
Today is sunny day!

# set a profile
$ java -jar -Dspring.profiles.active=raining target/spring-boot-profile-1.0.jar
Today is raining day!

ソースコードをダウンロード

$ git clone https://github.com/example/spring-boot.git
$ cd profile-simple
$ mvn package
$ java -jar -Dspring.profiles.active=raining target/spring-boot-profile-1.0.jar

TOC