この記事では、Spring Bootで `@ Profile`を使う方法と、それをテストする方法について説明します。
使用されるツール:
-
春のブート1.5.1.RELEASE
-
Maven
1.プロジェクトの構成
標準のMavenプロジェクト構造。
プロジェクトの依存関係
標準的な「スプリングブートスターター」と「スプリングブートスターターテスト」
pom.xml
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <artifactId>spring-boot-profile</artifactId> <packaging>jar</packaging> <name>Spring Boot Profiles Example</name> <description>Spring Boot Profiles Example</description> <url>/</url> <version>1.0</version> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.4.2.RELEASE</version> </parent> <properties> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> </dependencies> <build> <plugins> <!-- Package as an executable jar/war --> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>
3.春のブート
Spring Bootでは、デフォルトのプロファイルは
` default
‘です。以下の天気予報を見直す。
3.1インターフェース。
WeatherService.java
package com.mkyong.service; public interface WeatherService { String forecast(); }
3.2プロフィール:陽気でデフォルト。
SunnyDayService.java
package com.mkyong.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プロフィール:雨。
RainingDayService.java
package com.mkyong.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 Spring起動アプリケーションを起動します。
Application.java
package com.mkyong; import com.mkyong.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; @Override public void run(String... args) throws Exception { //weather forecast, default is sunny day! System.out.println(weatherService.forecast()); } public static void main(String[]args) throws Exception { SpringApplication.run(Application.class, args); } }
3.5プロパティファイル。
application.properties
# default profile is 'defau;t' #spring.profiles.active=sunny logging.level.=error spring.main.banner-mode=off
ユニットテスト
ユニットテストの例
4.1サービスクラスのユニットテスト。 `@ ActiveProfiles`を介してアクティブなプロファイルを設定する
TestWeatherService.java
package com.mkyong; import com.mkyong.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() throws Exception { String output = weatherService.forecast(); assertThat(output).contains("Today is raining day!"); } }
4.2 Springブートアプリケーションのユニットテスト。 `spring.profiles.active`プロパティを使ってアクティブなプロファイルを設定することができます
TestApplication.java
package com.mkyong; 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() throws Exception { Application.main(new String[0]); String output = this.outputCapture.toString(); assertThat(output).contains("Today is sunny day!"); } @Test public void testRainingProfile() throws Exception { 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() throws Exception { 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はこのSpringブートに貢献しています。https://github.com/spring-projects/spring-boot/blob/master/spring-boot-samples/spring-boot-sample-profile/src/test/java/sample/プロファイル/SampleProfileApplicationTests.java[SampleProfileApplicationTests]example.
デモ
パッケージ化して実行します。
$ 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!
ソースコードをダウンロードする
ダウンロード:
spring-boot-profile-example.zip
(5 KB)
参考文献
ブート – プロパティ
ブートプロファイル]