Spring加載properties文件的兩種方式

 在項目中若是有些參數常常須要修改，或者後期可能須要修改，那咱們最好把這些參數放到properties文件中，源代碼中讀取properties裏面的配置，這樣後期只須要改動properties文件便可，不須要修改源代碼，這樣更加方便。在Spring中也能夠這麼作，並且Spring有兩種加載properties文件的方式：基於xml方式和基於註解方式。下面分別討論下這兩種方式。

1. 經過xml方式加載properties文件

        咱們以Spring實例化dataSource爲例，咱們通常會在beans.xml文件中進行以下配置：

 

<!-- com.mchange.v2.c3p0.ComboPooledDataSource類在c3p0-0.9.5.1.jar包的com.mchange.v2.c3p0包中 -->  
<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">  
    <property name="driverClass" value="com.mysql.jdbc.Driver" />  
    <property name="jdbcUrl" value="jdbc:mysql://localhost:3306/shop" />  
    <property name="user" value="root" />  
    <property name="password" value="root" />  
</bean>  

 

 

        如今若是咱們要改變dataSource，咱們就得修改這些源代碼，可是咱們若是使用properties文件的話，只須要修改那裏面的便可，就無論源代碼的東西了。那麼如何作呢？

 

        Spring中有個<context:property-placeholder location=""/>標籤，能夠用來加載properties配置文件，location是配置文件的路徑，咱們如今在工程目錄的src下新建一個conn.properties文件，裏面寫上上面dataSource的配置：

 

dataSource=com.mchange.v2.c3p0.ComboPooledDataSource  
driverClass=com.mysql.jdbc.Driver  
jdbcUrl=jdbc\:mysql\://localhost\:3306/shop  
user=root  
password=root  

 

        如今只須要在beans.xml中作以下修改便可：

 

 

<context:property-placeholder location="classpath:conn.properties"/><!-- 加載配置文件 -->  
  
<!-- com.mchange.v2.c3p0.ComboPooledDataSource類在c3p0-0.9.5.1.jar包的com.mchange.v2.c3p0包中 -->  
 <bean id="dataSource" class="${dataSource}"> <!-- 這些配置Spring在啓動時會去conn.properties中找 -->  
    <property name="driverClass" value="${driverClass}" />  
    <property name="jdbcUrl" value="${jdbcUrl}" />  
    <property name="user" value="${user}" />  
    <property name="password" value="${password}" />  
 </bean>  

 

        <context:property-placeholder location=""/>標籤也能夠用下面的<bean>標籤來代替，<bean>標籤咱們更加熟悉，可讀性更強：

 

 

<!-- 與上面的配置等價，下面的更容易理解 -->  
<bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">  
    <property name="locations"> <!-- PropertyPlaceholderConfigurer類中有個locations屬性，接收的是一個數組，即咱們能夠在下面配好多個properties文件 -->  
        <array>  
            <value>classpath:conn.properties</value>  
        </array>  
    </property>  
</bean>  

 

        雖然看起來沒有上面的<context:property-placeholder location=""/>簡潔，可是更加清晰，建議使用後面的這種。可是這個只限於xml的方式，即在beans.xml中用${key}獲取配置文件中的值value。

 

2. 經過註解方式加載properties文件

        還有一種就是經過註解的方式，在java代碼中使用@Value註解來加載配置文件中的值。

        咱們來看一個例子：假如咱們要在程序中獲取某個文件的絕對路徑，咱們很天然會想到不能在程序中寫死，那麼咱們也能夠卸載properties文件中。仍是在src目錄下新建一個public.properties文件，假設裏面寫了一條記錄：

filePath=E\:\\web\\apache-tomcat-8.0.26\\webapps\\E_shop\\image  

 

        若是想在java代碼中經過註解來獲取這個filePath的話，首先得在beans.xml文件中配置一下註解的方式：

 

 

<!-- 第二種方式是使用註解的方式注入，主要用在java代碼中使用註解注入properties文件中相應的value值 -->  
<bean id="prop" class="org.springframework.beans.factory.config.PropertiesFactoryBean">  
    <property name="locations"><!-- 這裏是PropertiesFactoryBean類，它也有個locations屬性，也是接收一個數組，跟上面同樣  
        <array>  
            <value>classpath:public.properties</value>  
        </array>  
    </property>  
</bean>  

 

        如今咱們能夠在java代碼中使用註解來獲取filePath的值了：

 

 

@Component("fileUpload")  
public class FileUploadUtil implements FileUpload {  
      
    private String filePath;  
    @Value("#{prop.filePath}")   
    //@Value表示去beans.xml文件中找id="prop"的bean，它是經過註解的方式讀取properties配置文件的，而後去相應的配置文件中讀取key=filePath的對應的value值  
    public void setFilePath(String filePath) {  
        System.out.println(filePath);  
        this.filePath = filePath;  
    }  

 

        注意要有set方法才能被注入進來，註解寫在set方法上便可。在setFilePath方法中經過控制檯打印filePath是爲了在啓動tomcat的時候，觀察控制檯有沒有輸出來，若是有，說明Spring在啓動時，已經將filePath給加載好了，咱們看一下控制檯的啓動信息：

        以上就是Spring加載properties配置文件的兩種方式。實際上，上面基於xml方式中的PropertyPlaceholderConfigurer類和這裏基於註解方式的PropertiesFactoryBean類都是繼承PropertiesLoaderSupport，都是用來加載properties配置文件的

 

【當你用心寫完每一篇博客以後,你會發現它比你用代碼實現功能更有成就感!】