SpringBoot配置中@ConfigurationProperties和@Value的區別

基本特征

@ConfigurationProperties

• 與@Bean結合為屬性賦值
• 與@PropertySource（只能用於properties文件）結合讀取指定文件
• 與@Validation結合，支持JSR303進行配置文件值的校驗，如@NotNull@Email等

@Value

• 為單個屬性賦值
• 支持屬性上的SpEL表達式

兩者比較

	@ConfigurationProperties	@Value
功能	批量注入配置文件中的屬性	一個個指定
松散綁定	支持	不支持
SpEL	不支持	支持
JSR303數據校驗	支持	不支持
復雜類型封裝	支持	不支持

我們用簡單的例子來說明一下。

假設在application.properties文件中這樣寫道：

student.name=zhangsan
student.age=25
student.class=mba
student.squad-leader=false
student.mail=[e-mail]

student.maps.k1=aaa
student.maps.k2=bbb
student.maps.k3=ccc

student.lists=a,b,c

student.score.english=95
student.score.math=90

分別用上面兩種綁定屬性的方式寫兩個bean:

StudentCP類使用@ConfigurationProperties的方式來綁定屬性，相關比較內容可以看代碼上面的注釋。

@Component
// @PropertySource表示加載指定文件
// @PropertySource(value = {"classpath:student.properties"})
@ConfigurationProperties(prefix = "student")
// prefiex表示指定統一前綴，下面就不用再寫了
@Validated // ConfigurationProperties形式下支持JSR303校驗
public class StudentCP {

    private String name;

    private Integer age;

    // 支持松散綁定，可以將連接符轉成駝峰命名
    private Boolean squadLeader;

    // 當前形式下支持JSR303數據校驗，表示此屬性值必須是email的格式
    @Email
    private String mail;

    // 支持復雜類型封裝對應
    private Map<String, Object> maps;

    private List<Object> lists;

    private Score score;

}

StudentV類使用@Value的方式來綁定屬性，注釋中給出了簡單的說明。

public class StudentV {

    // 使用@Value的話只能給屬性一一指定映射

    @Value("student.name")
    private String name;

    // @Value形式支持SpEL表達式
    @Value("#{13*2}")
    // @Value("student.age")
    private Integer age;

    // @Value("true") // 可直接賦值
    // 不能支持松散語法的綁定
    @Value("student.squad-leader")
    private Boolean squadLeader;

    @Value("student.mail")
    private String mail;

    // 之后的map、list和對象等復雜形式對象@Value無法支持

}

小結

配置文件格式是yml或者properties兩者都能夠獲取值；

如果說只想在某個業務邏輯中獲取一下配置文件中的某個值，使用@Value；

如果說專門編寫一個JavaBean來和配置文件進行映射，那么就使用@ConfigurationProperties.

其他

@ConfigurationProperties默認從全局配置文件中獲取值，如果要從指定配置文件中獲取值，那么需要通過@PropertySource來聲明指定。

@PropertySource(value = "classpath:student.properties")

@ImportResource：導入Spring的配置文件，讓配置文件里面的內容生效。 

我們自定義的配置文件，默認是不能注入（加載）到Spring的IoC容器中的，如果想在項目中使用自定義的配置文件，則需要通過@ImportResource來指定注入才能夠最終使用。

@ImportResource(location = {"classpath:my-beans.xml"})

以前的項目中，我們都在xml中配置bean，但是實際當中（目前），我們不會使用這種方式來給項目添加組件，SpringBoot有推薦的方式，即使用注解。

@Configuration標注一個類，指明當前類是一個配置類，就是用來替代之前Spring使用xml配置的方式。（<bean id="" class=""></bean>）

@Configuration
public class MyConfig {
    
    /**
    * 將方法的返回值注入到容器中，容器中這個組件默認的id就是方法名
    */
    @Bean
    public HelloService helloService() {
        return new HelloService();
    }
}

配置文件占位符

可以在***.properties中使用占位符使用一些函數，或者調用之前配置的一些內容：

${ramdom.value}
${random.int(10)}
${student.name}
// 獲取student.hobit的值，沒有的話取冒號后面的缺省值
${student.hobit:football}