寫在前面
很多小夥伴都在問：冰河，你的Spring專題更新完了嗎？怎麼感覺像是寫了一半啊？我：沒有更新完呀，整個專題預計會有70多篇。那怎麼更新了一半就去寫別的了呢？那是因為有很多其他的小夥伴在後臺留言說：急需學習一些其他的技術，所以，臨時調整的。放心，Spring專題會持續更新的！這不，今天，我們就繼續更新Spring專題。不出意外的話，會一直持續更新完！！
專案工程原始碼已經提交到GitHub：https://github.com/sunshinelyz/spring-annotation
@PropertySource註解概述
@PropertySource註解是Spring 3.1開始引入的配置類註解。通過@PropertySource註解將properties配置檔案中的值儲存到Spring的 Environment中，Environment介面提供方法去讀取配置檔案中的值，引數是properties檔案中定義的key值。也可以使用@Value 註解用${}佔位符注入屬性。
@PropertySource註解的原始碼如下所示。
package org.springframework.context.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.core.io.support.PropertySourceFactory;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(PropertySources.class)
public @interface PropertySource {
String name() default "";
String[] value();
boolean ignoreResourceNotFound() default false;
String encoding() default "";
Class<? extends PropertySourceFactory> factory() default PropertySourceFactory.class;
}
從@PropertySource的原始碼可以看出，我們可以通過@PropertySource註解指定多個properties檔案，可以使用如下形式進行指定。
@PropertySource(value={"classpath:xxx.properties", "classpath:yyy.properties"})
細心的讀者可以看到，在@PropertySource註解類的上面標註瞭如下的註解資訊。
@Repeatable(PropertySources.class)
看到這裡，小夥伴們是不是有種恍然大悟的感覺呢？沒錯，我們也可以使用@PropertySources註解來指定properties配置檔案。
@PropertySources註解
首先，我們也是看下@PropertySources註解的原始碼，如下所示。
package org.springframework.context.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface PropertySources {
PropertySource[] value();
}
@PropertySources註解的原始碼比較簡單，只有一個PropertySource[]陣列型別的屬性value，那我們如何使用@PropertySources註解指定配置檔案呢？其實也很簡單，就是使用如下所示的方式就可以了。
@PropertySources(value={
@PropertySource(value={"classpath:xxx.properties"}),
@PropertySource(value={"classpath:yyy.properties"}),
})
是不是很簡單呢？接下來，我們就以一個小案例來說明@PropertySource註解的用法。
案例準備
首先，我們在工程的src/main/resources目錄下建立一個配置檔案person.properties檔案，檔案的內容如下所示。
person.nickName=zhangsan
接下來，我們在Person類中新增一個欄位nickName，如下所示。
package io.mykit.spring.plugins.register.bean;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;
import org.springframework.beans.factory.annotation.Value;
import java.io.Serializable;
/**
* @author binghe
* @version 1.0.0
* @description 測試實體類
*/
@Data
@ToString
@NoArgsConstructor
@AllArgsConstructor
public class Person implements Serializable {
private static final long serialVersionUID = 7387479910468805194L;
@Value("binghe")
private String name;
@Value("#{20-2}")
private Integer age;
private String nickName;
}
目前，我們並沒有為Person類的nickName欄位賦值，所以，此時Person類的nickName欄位的值為空。我們執行下PropertyValueTest類的testPropertyValue01()方法來看下輸出結果，如下所示。
org.springframework.context.annotation.internalConfigurationAnnotationProcessor
org.springframework.context.annotation.internalAutowiredAnnotationProcessor
org.springframework.context.annotation.internalCommonAnnotationProcessor
org.springframework.context.event.internalEventListenerProcessor
org.springframework.context.event.internalEventListenerFactory
propertyValueConfig
person
================================
Person(name=binghe, age=18, nickName=null)
Process finished with exit code 0
可以看出，Person類的nickName欄位的值確實輸出了null。
使用xml檔案方式獲取值
如果我們需要在xml檔案中獲取person.properties檔案中的值，則我們首先需要在Spring的xml檔案中引入context名稱空間，並且使用context名稱空間匯入person.properties檔案，之後在bean的屬性欄位中使用如下方式將person.properties檔案中的值注入到Person類的nickName欄位上。
<context:property-placeholder location="classpath:person.properties" />
<bean id = "person" class="io.mykit.spring.plugins.register.bean.Person">
<property name="name" value="binghe"></property>
<property name="age" value="18"></property>
<property name="nickName" value="${person.nickName}"></property>
</bean>
整個bean.xml檔案的內容如下所示。
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/context/spring-context.xsd ">
<context:property-placeholder location="classpath:person.properties"/>
<bean id = "person" class="io.mykit.spring.plugins.register.bean.Person">
<property name="name" value="binghe"></property>
<property name="age" value="18"></property>
<property name="nickName" value="${person.nickName}"></property>
</bean>
</beans>
這樣就可以將person.properties檔案中的值注入到Person的nickName欄位上。接下來，我們在PropertyValueTest類中建立testPropertyValue02()測試方法，如下所示。
@Test
public void testPropertyValue02(){
ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("classpath:beans.xml");
Person person = (Person) context.getBean("person");
System.out.println(person);
}
我們執行PropertyValueTest類中建立的testPropertyValue02()方法，輸出的結果資訊如下所示。
Person(name=binghe, age=18, nickName=zhangsan)
使用註解方式獲取值
如果我們使用註解的方式該如何做呢？首先，我們需要在PropertyValueConfig配置類上新增@PropertySource註解，如下所示。
package io.mykit.spring.plugins.register.config;
import io.mykit.spring.plugins.register.bean.Person;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
/**
* @author binghe
* @version 1.0.0
* @description 測試屬性賦值
*/
@PropertySource(value = {"classpath:person.properties"})
@Configuration
public class PropertyValueConfig {
@Bean
public Person person(){
return new Person();
}
}
這裡使用的@PropertySource(value = {"classpath:person.properties"})就相當於xml檔案中使用的<context:property-placeholder location="classpath:person.properties"/>。
接下來，我們就可以在Person類的nickName欄位上使用@Value註解來獲取person.properties檔案中的值了，如下所示。
@Value("${person.nickName}")
private String nickName;
配置完成後，我們再次執行PropertyValueTest類的testPropertyValue01()方法來看下輸出結果，如下所示。
org.springframework.context.annotation.internalConfigurationAnnotationProcessor
org.springframework.context.annotation.internalAutowiredAnnotationProcessor
org.springframework.context.annotation.internalCommonAnnotationProcessor
org.springframework.context.event.internalEventListenerProcessor
org.springframework.context.event.internalEventListenerFactory
propertyValueConfig
person
================================
Person(name=binghe, age=18, nickName=zhangsan)
可以看到，此時Person類的nickName欄位已經注入了“zhangsan”這個值。
使用Environment獲取值
這裡，我們在PropertyValueTest類中建立testPropertyValue03()方法，來使用Environment獲取person.properties中的值，如下所示。
@Test
public void testPropertyValue03(){
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(PropertyValueConfig.class);
Environment environment = context.getEnvironment();
String nickName = environment.getProperty("person.nickName");
System.out.println(nickName);
}
執行PropertyValueTest類中的testPropertyValue03()方法，輸出的結果資訊如下所示。
zhangsan
可以看到，使用Environment確實能夠獲取到person.properties中的值。
重磅福利
關注「 冰河技術 」微信公眾號，後臺回覆 “設計模式” 關鍵字領取《深入淺出Java 23種設計模式》PDF文件。回覆“Java8”關鍵字領取《Java8新特性教程》PDF文件。回覆“限流”關鍵字獲取《億級流量下的分散式限流解決方案》PDF文件，三本PDF均是由冰河原創並整理的超硬核教程，面試必備！！
好了，今天就聊到這兒吧！別忘了點個贊，給個在看和轉發，讓更多的人看到，一起學習，一起進步！！
寫在最後
如果你覺得冰河寫的還不錯，請微信搜尋並關注「 冰河技術 」微信公眾號，跟冰河學習高併發、分散式、微服務、大資料、網際網路和雲原生技術，「 冰河技術 」微信公眾號更新了大量技術專題，每一篇技術文章乾貨滿滿！不少讀者已經通過閱讀「 冰河技術 」微信公眾號文章，吊打面試官，成功跳槽到大廠；也有不少讀者實現了技術上的飛躍，成為公司的技術骨幹！如果你也想像他們一樣提升自己的能力，實現技術能力的飛躍，進大廠，升職加薪，那就關注「 冰河技術 」微信公眾號吧，每天更新超硬核技術乾貨，讓你對如何提升技術能力不再迷茫！
