Spring Profiles使用方法詳解

2022-12-03 14:01:23

Spring Profiles

今天學習下，Spring的核心功能之一 profiles，該特性允許開發者將beans對映到不同的環境中，如dev、test、prod。開發者啟動服務時，可以根據自身需要在不同的環境中啟用不同的設定。

bean使用profile註解

先來學習一個最簡單profle的使用方式，學習如何讓bean屬於特定的環境。假設一個場景：一個普通的bean，只在開發期間有效，其他環境無效。

@Component
@Profile("dev")
public class DevDatasourceConfig{
}

如上述程式碼，只需要在宣告bean時，配合@Profile註解，並指定特定的環境即可。根據上面的場景，反過來看：假設一個bean除了在開發期間無效，在其他環境（如test、prod）有效。@Profile支援NOT操作，只需要在前面加上 ! 符號。例如 !dev, 就可以將dev環境排除。

@Component
@Profile("!dev")
// @Profile(value={"dev & local"})
public class DevDatasourceConfig{
}

XML宣告profile

在XML組態檔中也可以設定profiles屬性, 標籤中定義了一個 profile 屬性，多個屬性值可以使用逗號分隔

<beans profile="dev">
    <bean id="devDatasourceConfig" 
      class="org.baeldung.profiles.DevDatasourceConfig" />
</beans>

設定profile

可以通過多種方式設定profile向容器中註冊bean。

WebApplicationInitializer 介面

web環境中，可以通過實現WebApplicationInitializer介面設定ServletContext上下文。

@Configuration
public class MyWebApplicationInitializer 
  implements WebApplicationInitializer {
    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        servletContext.setInitParameter(
          "spring.profiles.active", "dev");
    }
}

ConfigurableEnvironment 介面

通過ConfigurableEnvironment介面直接設定profile

@Autowired
private ConfigurableEnvironment env;
...
env.setActiveProfiles("someProfile");

Web.xml

web開發者可以在web.xml中使用context param啟用profile屬性

<context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>/WEB-INF/app-config.xml</param-value>
</context-param>
<context-param>
    <param-name>spring.profiles.active</param-name>
    <param-value>dev</param-value>
</context-param>

JVM 設定

profiles屬性也可以通過JVM系統引數設定，並在應用啟動時啟用相關屬性

-Dspring.profiles.active=dev

系統環境變數

Unix系統中，profiles可以通過宣告系統變數來啟用

export spring_profiles_active=dev

Maven設定

Spring profiles屬性通過maven組態檔宣告啟用。

<profiles>
    <profile>
        <id>dev</id>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
        <properties>
            <spring.profiles.active>dev</spring.profiles.active>
        </properties>
    </profile>
    <profile>
        <id>prod</id>
        <properties>
            <spring.profiles.active>prod</spring.profiles.active>
        </properties>
    </profile>
</profiles>

在編譯打包時，通過以下動態引數傳遞，直接指定profile屬性，開發不需要改動任何程式碼。這種方式在實際開發中經常使用，編譯打包完成後，直接交付給運維團隊

mvn clean package -Pprod

Profiles In Test

開發測試時，使用@ActiveProfile註解指定需要啟用的profile。

@ActiveProfiles("dev")

目前為止，已知多種方式啟用profile屬性，它們的優先順序，從高到低分別為：

Context parameter in web.xml
WebApplicationInitializer
JVM System parameter
Environment variable
Maven profile

預設Profile

如果沒有指定profile，Spring啟用預設的profile - default, 可以在屬性檔案值修改 spring.profiles.default 的值，從而修改預設profile的名字

spring.profiles.default=none

獲取生效的Profiles

Spring通過@Profile註解啟用/禁止beans, 但是開發者希望獲取生效的Profiles列表。有兩種方式可以實現：

使用 Environment 物件
獲取spring.profiles.active屬性值

使用Environment

通過注入Environment bean獲取啟用的profiles

public class ProfileManager {
    @Autowired
    private Environment environment;
    public void getActiveProfiles() {
        for (String profileName : environment.getActiveProfiles()) {
            System.out.println("Currently active profile - " + profileName);
        }  
    }
}

使用spring.profiles.active

此外，可以通過注入spring.profiles.active屬性值來獲取有效的profiles。

public class ProfileManager {
    //如果設定多個屬性，則覆蓋get方法 迭代出每一個有效的profile
    @Value("${spring.profiles.active}")
    private String activeProfiles;
    public String getActiveProfiles() {
        for (String profileName : activeProfiles.split(",")) {
            System.out.println("Currently active profile - " + profileName);
        }
    }
}

但是，如果應用中沒有profile，上述程式碼，由於缺少設定將會導致應用啟動失敗，為了避免這種情況，可以定義個 kong的字串作為預設值。

//@Value("${spring.profiles.active}")
@Value("${spring.profiles.active:}")
private String activeProfile;

SpringBoot Profiles

Spring Boot 支援以上所有的功能，並增加了一些額外的特性。

設定Profiles

在Spring Boot 預設的組態檔 - application.properties 啟用

spring.profiles.active=dev

通過啟動類設定profile

//setAdditionalProfiles 不是靜態方法，在實際使用中需要注意
SpringApplication.setAdditionalProfiles("dev");

使用spring-boot-maven-plugin外掛

<plugins>
    <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
        <configuration>
            <profiles>
                <profile>dev</profile>
            </profiles>
        </configuration>
    </plugin>
    ...
</plugins>

執行maven命令

mvn spring-boot:run

Profile-specific Properties Files

Spring Boot 核心特性之一是定義了基於profile的組態檔解析規則。組態檔必須以-{profile}.properties格式命名。Spring Boot自動載入解析application.properties檔案，並根據profile指定，載入特定的 -{profile}.properties 檔案。

例如，需要設定開發/生產兩種資料來源，名稱分別為application-dev.properties、application-production.properties。

application-production.properties使用MYSQL資料來源

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/db
spring.datasource.username=root
spring.datasource.password=root

application-dev.properties 使用記憶體資料庫

spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.url=jdbc:h2:mem:db;DB_CLOSE_DELAY=-1
spring.datasource.username=sa
spring.datasource.password=sa

單檔案設定

為了簡化不同環境的設定，開發者可以在同一個檔案中定義所有屬性，並使用分隔符來指定組態檔。

my.prop=used-always-in-all-profiles
#---
spring.config.activate.on-profile=dev
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/db
spring.datasource.username=root
spring.datasource.password=root
#---
spring.config.activate.on-profile=production
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.url=jdbc:h2:mem:db;DB_CLOSE_DELAY=-1
spring.datasource.username=sa
spring.datasource.password=sa