在Spring中怎樣引用外部屬性文件

這篇文章給大家分享的是有關在Spring中怎樣引用外部屬性文件的內(nèi)容。小編覺得挺實用的，因此分享給大家做個參考，一起跟隨小編過來看看吧。

進行數(shù)據(jù)源或者 FTP 服務器等資源配置時，我們可以將這些配置信息放到一個獨立的外部屬性文件中，并在 Spring 配置文件中通過形如 ${user}、${password} 的占位符方式來引用屬性文件中的屬性項 。

這種方式的配置有兩個好處：

1. 減少了維護的工作量 - 資源的配置信息可以被多個應用共享，如果資源的配置信息發(fā)生了變更，那么我們只需要調(diào)整這個獨立的配置文件就可以啦。

2. 部署更加簡單 - 通過一個獨立的屬性文件來存放這些配置信息，則部屬人員只需要調(diào)整這個屬性文件即可，無須關注結(jié)構(gòu)復雜、信息量大的 Spring 配置文件咯。

Spring 提供了一個 PropertyPlaceholderConfigurer ，它能夠在裝載 Bean 時引用外部屬性文件 。PropertyPlaceholderConfigurer 實現(xiàn)了 BeanFactoryPostProcessorBean 接口，所以它是一個 Bean 工廠后處理器。

1 基本引用

1.1 PropertyPlaceholderConfigurer 方式（XML 配置）

假設需要在 Bean 中定義一個數(shù)據(jù)源：

<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"
 destroy-method="close"
 p:driverClassName="com.mysql.jdbc.Driver"
 p:url="jdbc:mysql://127.0.0.1:3306/spring4"
 p:username="root"
 p:password=""/>

這里把驅(qū)動類名 、JDBC 的 URL 以及數(shù)據(jù)庫的用戶名和密碼都直接寫在了 XML 中 。 這樣在部署時，如果需要改動數(shù)據(jù)庫的配置信息，那么首先需要先找到這個 XML，然后再進行修改，不方便 。

建議將這些信息抽取到一個配置文件中，假設取名為 system.priperties：

driverClassName=com.mysql.jdbc.Driver
url=jdbc:mysql://127.0.0.1:3306/spring4
username=root
password=

屬性文件可以定義多個屬性，每個屬性的格式為：屬性名=屬性值

spring 配置：

<!-- 引入外部屬性文件-->
<bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"
  p:location="classpath:system.properties"
  p:fileEncoding="utf-8"/>

<!-- 數(shù)據(jù)源-->
<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"
  destroy-method="close"
  p:driverClassName="${driverClassName}"
  p:url="${url}"
  p:username="${username}"
  p:password="${password}"/>

通過這樣配置之后，我們在部署時，僅需關注這個配置文件即可。

PropertyPlaceholderConfigurer 屬性說明如下：

1.2 context:property-placehoder 方式（XML 配置）

可以使用 context 命名空間來定義屬性文件，相對于 PropertyPlaceholderConfigurer 的配置方式，這種方式更優(yōu)雅。

<context:property-placeholder location="classpath:system.properties"
         file-encoding="utf-8"/>

這種方式雖然如果希望對屬性進行加密或者使用數(shù)據(jù)庫表保存配置信息等的高級功能，就必須擴展 PropertyPlaceholderConfigurer 的類，然后采用之前所說的 Bean 配置方式 。

1.3 @value 方式（基于注解或 JAVA 類的配置）

基于注解的 Bean 可以通過 @Value 注解為 Bean 的成員變量或者方法入?yún)⒆詣幼⑷雽傩灾?。

@Component
public class CustomDataSource {

 @Value("${driverClassName}")
 private String driverClassName;

 @Value("${url}")
 private String url;

 @Value("${username}")
 private String username;

 @Value("${password}")
 private String password;

 //省略 getter/setter
}

而基于 JAVA 類注解 @Configuration 的類本身就標注了 @Component，所以它引用屬性的方式和基于注解配置的引用方式是一樣的 。

注意：使用過程中要確保所引用的屬性值在屬性文件中存在并且類型匹配，否則會拋出異常。

2 加密屬性值

對于那些不敏感的屬性信息，在屬性文件中以明文形式出現(xiàn)是合理的，但是如果屬性信息是敏感信息（比如數(shù)據(jù)庫用戶名和密碼等），建議以密文的方式保存 。 因為如果敏感信息密文保存，那么任何擁有服務器登陸權(quán)限的人就有可能看到機密信息，從而影響系統(tǒng)安全。

對于那些對安全要求特別高的系統(tǒng)（銀行、公安系統(tǒng)等），這些敏感信息應該只掌握在少數(shù)特定的維護人員手里。所以，我們需要對這些信息進行加密，Spring 容器讀取文件后，再對其進行解密。

PropertyPlaceholderConfigurer 繼承自 PlaceholderConfigurerSupport 類，后者設計了一些方法，用于在屬性被使用之前對它們進行轉(zhuǎn)換：

默認情況下，這三個都是空方法，我們可以擴展 PropertyPlaceholderConfigurer ，覆蓋相應的轉(zhuǎn)換方法，從而支持帶加密后的屬性值文件。

2.1 DES 加密解密工具類

信息的加密分為對稱和非對稱兩種方式， 對稱表示加密后的信息可以解密出來，而非對稱方式則不能根據(jù)加密后的信息解密為原值 。 MD5 屬于非對稱加密， DES 屬于對稱加密 。所以這里我們使用 DES 加密屬性值；讀取屬性值時，再使用 DES 進行解密 。

DES 加密解密工具類源代碼請點擊這里。

DES 加解密使用說明：

我們使用 DES 加解密工具，通過命令行的方式，對數(shù)據(jù)庫的賬號與密碼進行加密；接著，把加密后的字符串寫入 system.properties，形如：

username=q5L+2PPrsPQ=
password=UdyjsvkXc/Q=

2.2 對屬性文件的值進行加密

首先自定義屬性配置器，支持解密轉(zhuǎn)換：

public class CustomPropertyPlaceholderConfigurer extends PropertyPlaceholderConfigurer {

 /**
  * DES 密鑰
  */
 private static final String KEY_STR = "123456";

 /**
  * 值加密過的屬性名稱組
  */
 public static final String[] ENCRYPT_PROPERTY_NAMES = new String[]{"username", "password"};

 @Override
 protected String convertProperty(String propertyName, String propertyValue) {
  if (!isDecrypt(propertyName)) {
   return propertyValue;
  }

  //解密
  return new DES(KEY_STR).decrypt(propertyValue);
 }

 /**
  * 是否需要解密
  *
  * @param propertyName 屬性名稱
  * @return
  */
 private boolean isDecrypt(String propertyName) {
  return ArrayUtils.contains(ENCRYPT_PROPERTY_NAMES, propertyName);
 }
}

注意：

1. 這里的 DES 密鑰必須與之前加密的密鑰相同。

2. ArrayUtils 來源于 commons-lang3。

然后通過 <bean> 的方式來配置自定義的屬性文件：

 <bean class="net.deniro.spring4.properties.CustomPropertyPlaceholderConfigurer"
 p:location="classpath:system.properties"
 p:fileEncoding="utf-8"/>

這樣，Spring 容器就可以加載被加密過的屬性文件啦，是不是很簡單呀
O(∩_∩)O哈哈~

3 對自身的引用

Spring 既允許在 Bean 定義中通過 ${propName}引用屬性的值，也允許在屬性文件中使用 ${propName} 實現(xiàn)屬性之間的相互引用 。

database=spring4

driverClassName=com.mysql.jdbc.Driver
url=jdbc:mysql://127.0.0.1:3306/${database}

這里通過 ${database}引用了另外一個屬性的值（數(shù)據(jù)庫實例名）。因此，對于一些復雜的屬性，我們可以通過這種方式將屬性變化的部分抽取出來，從而實現(xiàn)配置的最小化 。

注意：如果一個屬性值太長，我們可以在每一行的最后加上 “\”，就可以把屬性值劃分為多行，就像這樣：

profile.jdbc.url=jdbc:mysql://127.0.0.1:3306/dbName?useUnicode=true&characterEncoding\
 =UTF-8\
 &zeroDateTimeBehavior=convertToNull

感謝各位的閱讀！關于“在Spring中怎樣引用外部屬性文件”這篇文章就分享到這里了，希望以上內(nèi)容可以對大家有一定的幫助，讓大家可以學到更多知識，如果覺得文章不錯，可以把它分享出去讓更多的人看到吧！