java如何實時動態獲取properties文件的內容

Posted on by

實時動態獲取properties文件的內容

用“ClassLoader.getResourceAsStream”讀取properties文件時會發現修改瞭.properties後，即使重新執行，讀入的仍為修改前的參數。

此問題的原因在於ClassLoader.getResourceAsStream讀入後，會將.properties保存在緩存中，重新執行時會從緩存中讀取，而不是再次讀取.properties文件。

動態讀取的代碼

import java.util.Properties; 
/**
 * 實時動態獲取properties文件的值
 * @author Administrator
 *
 */
public class demo01 {
 /**
  * 根據配置變量實時獲取配置文件中的值
  * @param key 配置名
  * @param filePath 配置文件路徑名，例如：test.properties
  * @return 配置值
  */
 public static String getCurrentPropertiesValue(String key,String filePath){
  String value="";
  Properties p = new Properties();
  try {
   //非實時動態獲取
   //p.load(new InputStreamReader(this.class.getClassLoader().getResourceAsStream(filePath), "UTF-8"));
   //下面為動態獲取
   String path = Thread.currentThread().getContextClassLoader().getResource("").getPath();
   InputStream is = new FileInputStream(path +File.separator+ filePath);
   p.load(is);
   value=p.getProperty(key);
  } catch (UnsupportedEncodingException e) {
   e.printStackTrace();
  } catch (IOException e) {
   e.printStackTrace();
  }
  return value;
 }
}

讀取配置文件 Properties VS ResourceBundle

在java開發中, 對於一些常用的配置性的信息, 通常會采用存放在屬性文件中, 因為修改配置文件無須重新編譯jar包. 對於屬性文件,通常可以使用Properties和ResourceBundle 兩個類來解析. 需要註意的是, 默認情況下java工程中的*.properties文件編碼格式是ISO-8859-1, Properties和ResourceBundle也是按照ISO-8859-1格式來解析屬性文件中字符串的. 所以對於解析包含中文的熟悉文件時,需要額外註意.

  • ResourceBundle: 通常用於解析國際化資源屬性文件, 會根據本地環境自動選擇對應的國際化資源.
  • Properties: 用來解析普通屬性文件

1. 常用API

1.1 Properties 常用API

Properties 繼承Hashtable<Object,Object>類.

方法簽名 方法描述
public String getProperty(String key 獲取屬性文件中的Key, 如果key不存在返回Null
public String getProperty(String key, String defaultValue) 獲取屬性文件中key對象的value, 如果key不存在則返回默認值defaultValue
public Object get(String key) 父類HashTable中的方法, 返回值類型為Object

1.2 ResourceBundle 常用API

ResourceBundle 是一個接口, 默認使用PropertyResourceBundle來解析屬性文件.

方法簽名 方法描述
public Locale getLocale() 獲取本地國際化環境
public Enumeration getKeys() 獲取屬性文件中所有key
public final String getString(String key) 獲取屬性文件中key對應的value, 返回值為String, 如果不存在, 則拋出異常
public final Object getObject(String key) 獲取屬性文件中key對應的value, 返回值為Object, 如果不存在, 則拋出異常

2. Properties 解析屬性文件

默認使用ISO-8859-1 解析配置文件中的字符串, 所以會導致中文亂碼.

2.1 解析純英文配置文件

// 默認編碼(ISO-8859-1)讀取屬性文件, 中文亂碼
@Test
public void test_properties_en() throws IOException{
 
 // 屬性文件位置, 相對路徑為src/main/resources 或 src/test/resources, 不能添加classpath:/前綴
 String propertyFileName = "jdbc.properties";
 
 // 獲取字節流
 InputStream is = getClass().getClassLoader().getResourceAsStream(propertyFileName);
 
 // 創建屬性文件, 並加載文件內容
 Properties properties = new Properties();
 properties.load(is); 
 String username = properties.getProperty("jdbc.username");
 String password = properties.getProperty("jdbc.password");
 System.out.println("username:" + username + ", password:" + password); 
}

2.2 解析含中文配置文件

默認使用ISO-8859-1, 采用InputStreamReader轉換為UTF8字符流.

// 指定讀取文件編碼方式,支持讀取中文
@Test
public void test_properties_zh() throws IOException{
 
 // 屬性文件位置, 相對路徑為src/main/resources 或 src/test/resources, 不能添加classpath:/前綴
 String propertyFileName = "jdbc.properties";
 
 // 獲取字節流
 InputStream is = getClass().getClassLoader().getResourceAsStream(propertyFileName);
 
 // 轉換為UTF-8格式字符流
 InputStreamReader isr = new InputStreamReader(is, "UTF-8");
 
 // 創建屬性文件, 並加載文件內容
 Properties properties = new Properties();
 properties.load(isr); 
 String username = properties.getProperty("jdbc.username");
 String password = properties.getProperty("jdbc.password");
 System.out.println("username:" + username + ", password:" + password); 
}

3. ResourceBundle 解析屬性文件

3.1 解析純英文配置文件

@Test
public void testRb_en() {
 // 資源配置文件,無須寫文件後綴名, 默認尋找properties文件
 String bundleName = "jdbc";
 
 // 設置本地默認環境為英文環境
 Locale.setDefault(Locale.ENGLISH);
 
 // 指定加載
 ResourceBundle rb = ResourceBundle.getBundle(bundleName);
 
 String username = rb.getString("jdbc.username");
 String password = rb.getString("jdbc.password");
 System.out.println("username:" + username + ", password:" + password);
}

3.2 解析含中文配置文件

// 處理中文
@Test
public void testRb_zh() {
 // 資源配置文件,無須寫文件後綴名, 默認尋找properties文件
 String bundleName = "jdbc";
 
 // 根據本地默認環境加載資源配置文件
 ResourceBundle rb = ResourceBundle.getBundle(bundleName); 
 String username = iso2Utf8(rb.getString("jdbc.username"));
 String password = iso2Utf8(rb.getString("jdbc.password"));
 System.out.println("username:" + username + ", password:" + password); 
}
/**
 * @Description iso編碼格式字符串轉換為UTF8格式
 * @param str iso 編碼字符串
 * @return
 * @author zongf
 * @date 2019年1月8日-下午3:55:29
 */
private String iso2Utf8(String str) {
 if(null == str) return null;
 
 try {
  return new String(str.getBytes("ISO-8859-1"), "UTF-8");
 } catch (UnsupportedEncodingException e) {
  e.printStackTrace();
 }
 return null;
}

4. 屬性文件

筆者創建的是maven 工程, 使用的是junit 單元測試, 所以筆者的配置文件存放在 src/test/resources 目錄下.

jdbc.properties

jdbc.username=張三
jdbc.password=123456

jdbc_zh.properties

jdbc.username=張三
jdbc.password=123456

jdbc_en.properties

jdbc.username=zhangsan
jdbc.password=123456

5. 實戰推薦

筆者認為, 一個設計良好的屬性配置類應該是一個常量類, 至少需要符合兩個設計原則:

屬性一旦設置不可動態修改, 即使在編譯環境也不能調用修改方法.

能夠直接通過類屬性進行訪問, 無須通過類對象訪問

自動裝配屬性, 而無須手動解析熟悉文件(spring中可借助自帶註解或自定義註解實現)

public class JdbcProperty { 
 /** 用戶名 */
 public static final String username;
 
 /** 用戶密碼 */
 public static final String password;
 
 // 在Spring應用中,可借助註解或自定義註解進行自動裝配,筆者此處隻針對一般java應用
 static {
  
  // 加載屬性文件
  ResourceBundle resourceBundle = ResourceBundle.getBundle("jdbc");
  
  // 初始化屬性
  username = resourceBundle.getString("jdbc.username");
  password = resourceBundle.getString("jdbc.password");  
 }
}

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：