解鎖 SpringBoot 的強(qiáng)大配置功能

來源｜blog.csdn.net/Mrxiao_bo/article/details/133637337

1前言

在當(dāng)今的軟件開發(fā)世界中，配置管理是至關(guān)重要的一部分。Spring框架為我們提供了多種配置方式，其中@ConfigurationProperties和@PropertySources是強(qiáng)大的工具，可以幫助我們輕松管理應(yīng)用程序的配置信息。

本博客將深入探討這兩個關(guān)鍵注解，介紹它們的用途以及如何在Spring應(yīng)用程序中使用它們。無論你是新手還是經(jīng)驗豐富的開發(fā)者，這篇博客都將為你提供有關(guān)配置文件管理的深入知識，幫助你編寫更具可維護(hù)性和可擴(kuò)展性的代碼。

2什么是@ConfigurationProperties和@PropertySources

@ConfigurationProperties 和 @PropertySources 都是與屬性配置相關(guān)的注解，用于在 Spring 應(yīng)用程序中管理和加載配置信息。

@ConfigurationProperties:

@ConfigurationProperties 是 Spring Boot 中的一個注解，用于將配置文件中的屬性值綁定到 Java Bean 上。通常，這個注解用于將外部屬性文件中的屬性值映射到應(yīng)用程序的配置類中，以便在整個應(yīng)用程序中方便地訪問和使用這些屬性。

這個注解通常與 @Configuration 或 @Component 一起使用，以將配置屬性綁定到一個特定的 Java Bean。通過在類上使用 @ConfigurationProperties，您可以將屬性文件中的鍵與 Java Bean 的字段或?qū)傩赃M(jìn)行映射。

示例：

      
      @Configuration
@ConfigurationProperties(prefix = "myapp")
public class MyAppProperties {
    private String name;
    private String version;
    // getters and setters
}

    

在上述示例中，@ConfigurationProperties 注解將以 myapp 前綴開頭的屬性映射到 MyAppProperties 類的字段中。

@PropertySources:

@PropertySources 是 Spring Framework 中的注解，用于指定多個屬性源，以便在 Spring 應(yīng)用程序中解析屬性。每個屬性源可以是一個屬性文件，用于存儲配置信息。與 @PropertySource 類似，@PropertySources 允許您在多個地方定義屬性源，以便將配置信息分散在不同的文件中。

這個注解通常與 @Configuration 一起使用，以將多個屬性源引入 Spring 應(yīng)用程序的環(huán)境中。

示例：

      
      @Configuration
@PropertySources({
    @PropertySource("classpath:application.properties"),
    @PropertySource("classpath:custom.properties")
})
public class AppConfig {
    // 這里可以注入和使用從屬性文件加載的配置屬性
}

    

在上述示例中，@PropertySources 注解指定了兩個屬性源，分別是 application.properties 和 custom.properties。

總結(jié)：

• @ConfigurationProperties 主要用于將外部屬性映射到 Java Bean，適用于 Spring Boot 應(yīng)用程序。
• @PropertySources 主要用于指定多個屬性源，以在 Spring 應(yīng)用程序中加載配置屬性，適用于標(biāo)準(zhǔn)的 Spring 應(yīng)用程序。

3@ConfigurationProperties的使用

在 Spring Boot 應(yīng)用程序中，您可以使用 @ConfigurationProperties 注解來綁定配置屬性，并將其注入到 Spring Bean 中。以下是如何執(zhí)行這些步驟的詳細(xì)說明：

步驟 1: 創(chuàng)建 Java POJO 類

首先，創(chuàng)建一個普通的 Java 類（POJO），該類的屬性將映射到您的配置屬性。這個類通常被用于存儲和操作配置屬性的值。確保為屬性提供適當(dāng)?shù)?getter 和 setter 方法。

      
      @ConfigurationProperties(prefix = "myapp")
public class MyAppProperties {
    private String name;
    private String version;
    
    // 省略構(gòu)造函數(shù)、getter 和 setter 方法
}

    

在上面的示例中，@ConfigurationProperties 注解指定了一個前綴 "myapp"，這意味著配置文件中的屬性鍵應(yīng)以 "myapp" 開頭。例如，myapp.name 和 myapp.version。

步驟 2: 配置類

接下來，創(chuàng)建一個配置類，用于加載配置屬性并將它們綁定到您的 Java POJO 類。通常，這個配置類應(yīng)該使用 @Configuration 注解進(jìn)行標(biāo)記。

      
      import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableConfigurationProperties(MyAppProperties.class)
public class AppConfig {
}

    

@EnableConfigurationProperties 注解用于啟用對 MyAppProperties 類的配置屬性綁定。

步驟 3: 配置文件

在 application.properties 或 application.yml 文件中，添加與您的配置屬性相關(guān)的屬性鍵和值。確保它們以與 @ConfigurationProperties 注解中指定的前綴匹配的方式進(jìn)行命名。

      
      myapp.name=My Spring Boot App
myapp.version=1.0

    

或者，使用 YAML 格式：

      
      myapp:
  name: My Spring Boot App
  version: 1.0

    

步驟 4: 注入配置屬性

最后，在您的 Spring Bean 中注入 MyAppProperties 類，以訪問配置屬性的值。您可以通過構(gòu)造函數(shù)注入或使用 @Autowired 注解進(jìn)行注入。

      
      import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class MyService {
    private final MyAppProperties myAppProperties;

    @Autowired
    public MyService(MyAppProperties myAppProperties) {
        this.myAppProperties = myAppProperties;
    }

    public void doSomething() {
        String appName = myAppProperties.getName();
        String appVersion = myAppProperties.getVersion();
        
        // 使用配置屬性進(jìn)行操作
        System.out.println("App Name: " + appName);
        System.out.println("App Version: " + appVersion);
    }
}

    

現(xiàn)在，您的 MyService Bean 可以訪問通過 @ConfigurationProperties 注解綁定的配置屬性。

通過上述步驟，您可以成功地在 Spring Boot 應(yīng)用程序中使用 @ConfigurationProperties 注解將配置屬性綁定到 Java POJO 類，并將其注入到 Spring Bean 中，以便在應(yīng)用程序中使用這些屬性的值。這種方式使配置屬性的管理和使用變得非常方便。

4@PropertySources的使用

在 Spring Boot 中，通常使用 @PropertySource 注解和 application.properties（或 application.yml）文件來管理應(yīng)用程序的配置屬性。雖然 @PropertySources 注解在標(biāo)準(zhǔn) Spring 應(yīng)用程序中更常見，但在 Spring Boot 中，通常使用 @PropertySource 和默認(rèn)的 application.properties 或 application.yml 更為常見。

不過，我可以提供一個示例，演示如何在 Spring Boot 中使用 @PropertySources 注解來指定多個屬性源。

以下是一個示例：

• 創(chuàng)建一個 Spring Boot 項目。
• 創(chuàng)建一個配置類，例如 AppConfig.java，并使用 @PropertySources 注解來指定多個屬性源。

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

@Configuration
@PropertySources({
    @PropertySource("classpath:default.properties"), // 默認(rèn)屬性源
    @PropertySource("classpath:custom.properties")  // 自定義屬性源
})
public class AppConfig {
}

    

在上述示例中，我們在 AppConfig 類上使用 @PropertySources 注解，并指定了兩個屬性源，分別是 default.properties 和 custom.properties。這兩個屬性源位于類路徑下，可以包含不同的配置屬性。

創(chuàng)建屬性文件 default.properties 和 custom.properties 并放置在 src/main/resources 目錄下。示例 default.properties 文件內(nèi)容如下：

      
      app.name=My Spring Boot App (Default)
app.version=1.0 (Default)

    

示例 custom.properties 文件內(nèi)容如下：

      
      app.name=My Custom Spring Boot App

    

創(chuàng)建一個服務(wù)類，例如 MyService.java，并使用 @Value 注解來注入屬性。

      
      import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;

@Service
public class MyService {

    @Value("${app.name}")
    private String appName;

    @Value("${app.version}")
    private String appVersion;

    public String getAppInfo() {
        return "App Name: " + appName + ", App Version: " + appVersion;
    }
}

    

在上述示例中，我們使用 @Value 注解來注入屬性 app.name 和 app.version，這些屬性的值將從屬性源中獲取。

創(chuàng)建一個控制器類，例如 MyController.java，并在其中使用 MyService 來獲取屬性值并返回給客戶端。

      
      import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

    private final MyService myService;

    @Autowired
    public MyController(MyService myService) {
        this.myService = myService;
    }

    @GetMapping("/app-info")
    public String getAppInfo() {
        return myService.getAppInfo();
    }
}

    

啟動應(yīng)用程序，并訪問 /app-info 路徑，您將看到根據(jù)不同屬性源獲取的應(yīng)用程序信息。

在這個示例中，我們使用了 @PropertySources 注解來指定多個屬性源，并在服務(wù)類中使用 @Value 注解來注入屬性。這使得應(yīng)用程序能夠根據(jù)屬性源的不同而獲取不同的屬性值。

不過需要注意，在 Spring Boot 中，通常更常見的做法是使用默認(rèn)的 application.properties（或 application.yml）文件以及 @ConfigurationProperties 注解來管理配置屬性。

5@PropertySources與@ConfigurationProperties的區(qū)別

@PropertySources 注解是 Spring 框架中用于指定多個屬性源的注解。它的主要作用是允許您在 Spring 應(yīng)用程序中定義多個屬性源，以便在不同位置或不同配置文件中存儲和管理配置屬性。這有助于將配置信息分散在多個文件中，使應(yīng)用程序更加模塊化和可維護(hù)。

下面詳細(xì)介紹 @PropertySources 注解的作用以及與 @ConfigurationProperties 的關(guān)系：

@PropertySources 注解的作用：

• 指定多個屬性源： @PropertySources 允許您在一個配置類中指定多個屬性源，每個屬性源對應(yīng)一個屬性文件。這些屬性源可以包含應(yīng)用程序的配置信息，如數(shù)據(jù)庫連接參數(shù)、日志級別、服務(wù)端口等。
• 模塊化配置： 通過將配置信息分散在多個屬性文件中，您可以將應(yīng)用程序的配置模塊化，使每個模塊負(fù)責(zé)自己的配置。這使得代碼更易于維護(hù)和理解，特別是在大型應(yīng)用程序中。
• 環(huán)境適應(yīng)性： 您可以為不同的環(huán)境（如開發(fā)、測試、生產(chǎn)）或不同的配置需求定義不同的屬性源。這使得應(yīng)用程序能夠在不同環(huán)境中使用不同的配置，而不必修改代碼。
• 屬性源優(yōu)先級： 如果存在多個屬性源，Spring 將按照它們在 @PropertySources 注解中的順序來解析屬性。這意味著后面的屬性源可以覆蓋前面的屬性源中的屬性值。

與 @ConfigurationProperties 的關(guān)系：

• @PropertySources 和 @ConfigurationProperties 都用于處理配置屬性，但它們的關(guān)注點和使用方式不同。
• @PropertySources 主要用于定義屬性源，將配置信息存儲在不同的屬性文件中，并在不同環(huán)境或模塊之間共享配置。它不直接與 Java Bean 綁定。
• @ConfigurationProperties 主要用于將配置屬性綁定到 Java Bean 上。它通常與 @Configuration 或 @Component 注解一起使用，以將外部屬性文件中的屬性值映射到一個特定的 Java Bean。
• 通常情況下，您會使用 @PropertySources 來定義屬性源，然后使用 @ConfigurationProperties 來將屬性源中的屬性值綁定到 Java Bean，以便在整個應(yīng)用程序中使用這些屬性。這兩個注解可以協(xié)同工作，但它們的功能不同，各自有其用途。

綜上所述，@PropertySources 注解用于管理多個屬性源，而 @ConfigurationProperties 注解用于將配置屬性綁定到 Java Bean。它們可以一起使用，以實現(xiàn)更靈活和模塊化的配置管理。