java操作properties配置檔案
阿新 • • 發佈:2019-02-05
Java中有個類Properties(Java.util.Properties),主要用於讀取Java的配置檔案,將一些可能需要變化的值存放在properties中進行配置,通常為為.properties檔案,其實就是普通的文字檔案,檔案的內容的格式是“鍵=值”的格式,文字註釋資訊可以用"#"來註釋。儘量使用UTF-8格式儲存。jdk自身提供的類有缺點,所以我們通常使用 commons-configuration框架進行解析。
1.1.1. Properties類圖
1.1.2. 讀取Properties配置檔案比較常用的方式
1。使用java.lang.Class類的getResourceAsStream(String name)方法 InputStream in = getClass().getResourceAsStream("檔名稱");
2.使用流的方式操作
InputStream in = new BufferedInputStream(new FileInputStream(filepath));
1.1.3. 缺點
1.格式必須是k=v 不能有空格。
2.不能定時重新整理變化的值(比如線上環境修改值程式讀取到的還是舊值)。需要自己寫程式控制。
3.值都是string型別需要自己獲取的時候根據需求轉換。
基於上面的缺點我們可以使用org.apache.commons.configuration類解決下面是日常開發中讀取properties 封裝。
1.1.4. commons-configuration框架的使用
1.1.4.1. maven包匯入
<dependency>
<groupId>commons-configuration</groupId>
<artifactId>commons-configuration</artifactId>
<version>1.8</version>
</dependency>
1.1.4.2. 工具類封裝
package cn.xhgg.common.configuration; import java.util.HashMap; import java.util.Iterator; import java.util.List; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import org.apache.commons.configuration.ConfigurationException; import org.apache.commons.configuration.PropertiesConfiguration; import org.apache.commons.configuration.reloading.FileChangedReloadingStrategy; import org.apache.commons.lang.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * 這個型別的配置,檔案首先需要有配置檔案,其次配置檔案應該寫入該類,再則配置檔案的編碼方式必須是UTF8 */ public class PropertiesConfigUtil { private static Logger log = LoggerFactory.getLogger(PropertiesConfigUtil.class); public static final String PROPS_SUFFIX = ".properties"; private static Map<String, PropertiesConfiguration> configMap = new ConcurrentHashMap<String, PropertiesConfiguration>(); private static PropertiesConfiguration getConfig(String configName) { //去除空格 configName = configName.trim(); //有後綴使用字尾 沒後綴 新增字尾 String configSig = StringUtils.endsWith(configName, PROPS_SUFFIX) ? configName : configName+PROPS_SUFFIX; if (configMap.containsKey(configSig)) { return configMap.get(configSig); } PropertiesConfiguration config = null; try { config=new PropertiesConfiguration(); config.setEncoding("UTF-8"); config.load(configSig); //預設五秒檢查一次 config.setReloadingStrategy(new FileChangedReloadingStrategy()); config.setThrowExceptionOnMissing(true); configMap.put(configSig, config); } catch (ConfigurationException e) { e.printStackTrace(); } return config; } public static Map<String, String> getKeyValuePairs(String configSig) { PropertiesConfiguration config = getConfig(configSig); if (config == null) { return null; } Iterator<String> iters = config.getKeys(); Map<String, String> retMap = new HashMap<String, String>(); while (iters.hasNext()) { String beforeKey = iters.next(); if (retMap.containsKey(beforeKey)) { log.warn(configSig + " configKey:" + beforeKey + " repeated!!"); } retMap.put(beforeKey, config.getString(beforeKey)); } return retMap; } /** * 通過PropertiesConfiguration取得引數的方法 * <p> * * @return 。 */ static public String getString(String configSig, String key) { return getConfig(configSig).getString(key); } static public String getString(String configSig, String key, String defaultValue) { return getConfig(configSig).getString(key, defaultValue); } static public int getInt(String configSig, String key) { return getConfig(configSig).getInt(key); } static public int getInt(String configSig, String key, int defaultValue) { return getConfig(configSig).getInt(key, defaultValue); } static public boolean getBoolean(String configSig, String key) { return getConfig(configSig).getBoolean(key); } static public boolean getBoolean(String configSig, String key, boolean defaultValue) { return getConfig(configSig).getBoolean(key, defaultValue); } static public double getDouble(String configSig, String key) { return getConfig(configSig).getDouble(key); } static public double getDouble(String configSig, String key, double defaultValue) { return getConfig(configSig).getDouble(key, defaultValue); } static public float getFloat(String configSig, String key) { return getConfig(configSig).getFloat(key); } static public float getFloat(String configSig, String key, float defaultValue) { return getConfig(configSig).getFloat(key, defaultValue); } static public long getLong(String configSig, String key) { return getConfig(configSig).getLong(key); } static public long getLong(String configSig, String key, long defaultValue) { return getConfig(configSig).getLong(key, defaultValue); } static public short getShort(String configSig, String key) { return getConfig(configSig).getShort(key); } static public short getShort(String configSig, String key, short defaultValue) { return getConfig(configSig).getShort(key, defaultValue); } static public List<Object> getList(String configSig, String key) { return getConfig(configSig).getList(key); } static public List<Object> getList(String configSig, String key, List<Object> defaultValue) { return getConfig(configSig).getList(key, defaultValue); } static public byte getByte(String configSig, String key) { return getConfig(configSig).getByte(key); } static public byte getByte(String configSig, String key, byte defaultValue) { return getConfig(configSig).getByte(key, defaultValue); } static public String[] getStringArray(String configSig, String key) { return getConfig(configSig).getStringArray(key); } }
1.1.4.3. 引入properties測試檔案
rabbitmq.properties配置如下:
#rpc 模式rmq
rpc.rabbit.host=l-opsdev3.ops.bj0.jd.com
rpc.rabbit.port=5672
rpc.rabbit.username=jd_vrmphoto
rpc.rabbit.password=jd_vrmphoto
rpc.rabbit.vhost=jd/vrmphoto
rpc.rabbit.queue=rpc_queue
rpc.rabbit.exchange=photoworker
rpc.rabbit.key=photoworker.rpc
1.1.4.4. 測試
PropertiesConfigUtil config=new PropertiesConfigUtil();
String username = config.getString("rabbitmq", "rpc.rabbit.username");
System.out.println(username);
輸出結果:
jd_vrmphoto
ok,大功告成。
1.1.4.5. 注意事項
1.編碼最好UTF-8統一。
ReloadingStrategy策略選擇。可以看具體的實現類和使用場景。我用的一般是FileChangedReloadingStrategy類。