如何在 Spring Boot 應用程式中使用 Spring 設定文件

Spring Profiles 提供了一種強大的方法來隔離應用程式配置的各個部分，並使其僅在某些環境中可用。此功能對於在不更改程式碼的情況下處理開發、測試和生產環境的不同配置特別有用。

什麼是 Spring 設定檔？

Spring 配置檔案可讓您根據活動設定檔有條件地註冊 Bean。這意味著您可以定義多個相同類型的 bean，並指定在給定環境中應啟動哪個 bean。

設定彈簧配置檔案

1. 建立設定檔

Spring Boot 使用一組 application-{profile}.properties 或 application-{profile}.yml 檔案進行設定。這些檔案包含特定於設定檔的配置，並根據活動設定檔載入。

預設配置（application.yml）

spring:
  application:
    name: MySpringApp

server:
  port: 8080  # Default port

開發配置（application-dev.yml）

spring:
  datasource:
    url: jdbc:h2:mem:devdb
    username: sa
    password: ""
    driver-class-name: org.h2.Driver
  jpa:
    hibernate:
      ddl-auto: update
    show-sql: true

server:
  port: 8081  # Development port

生產配置（application-prod.yml）

spring:
  datasource:
    url: jdbc:mysql://prod-db-server:3306/proddb
    username: prod_user
    password: prod_password
    driver-class-name: com.mysql.cj.jdbc.Driver
  jpa:
    hibernate:
      ddl-auto: validate
    show-sql: false

server:
  port: 8082  # Production port

啟動彈簧配置文件

2. 透過命令列啟動設定文件

您可以在執行 Spring Boot 應用程式時使用 --spring.profiles.active 參數啟動設定檔：

java -jar my-spring-app.jar --spring.profiles.active=dev

3. 透過應用程式屬性啟動設定文件

或者，您可以在 application.yml 檔案中指定活動設定檔：

spring:
  profiles:
    active: dev  # or prod

4.透過環境變數啟動設定檔

您也可以使用環境變數來設定活動設定檔：

export SPRING_PROFILES_ACTIVE=dev

在程式碼中使用設定檔

Spring 提供了 @Profile 註解來根據活動設定檔有條件地註冊 Bean。這是一個例子：

配置類別範例

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;

@Configuration
public class AppConfig {

    @Bean
    @Profile("dev")
    public DataSource devDataSource() {
        return new HikariDataSource();  // Development-specific DataSource
    }

    @Bean
    @Profile("prod")
    public DataSource prodDataSource() {
        return new HikariDataSource();  // Production-specific DataSource
    }
}

在此範例中，僅當 dev 設定檔處於活動狀態時才會建立 devDataSource bean，而當 prod 設定檔處於活動狀態時才會建立 prodDataSource bean。

測試特定於設定檔的 Bean

編寫測試時，您可以使用 @ActiveProfiles 註解指定哪些設定檔應處於活動狀態：

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.ActiveProfiles;

@SpringBootTest
@ActiveProfiles("dev")
public class DevProfileTests {

    @Autowired
    private DataSource dataSource;

    @Test
    public void testDataSource() {
        // Test code using the development DataSource
    }
}

特定於設定檔的屬性

有時，您可能希望根據活動設定檔載入不同的屬性檔。您可以使用 @PropertySource 註解來實現此目的：

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

@Configuration
@PropertySource("classpath:application-${spring.profiles.active}.properties")
public class PropertyConfig {
}

結論

Spring Profiles 是一種強大且靈活的方式來管理各種環境的不同配置。透過根據設定檔分離配置屬性和 Bean，您可以確保應用程式在每個環境中都能正確運行，無論是開發、測試還是生產。使用本文概述的技術，您可以輕鬆地在 Spring Boot 應用程式中設定和管理設定檔。

以上是如何在 Spring Boot 應用程式中使用 Spring 設定文件的詳細內容。更多資訊請關注PHP中文網其他相關文章！