在Java早期的開發中，經常使用*.properties文件存儲一些配置信息。其文件中的信息主要是以key=value的方式進行存儲，在早期受到普遍的應用。然後隨着xml使用的普遍，其位置漸漸被取代，不過，目前仍有一些框架如log4J在使用它。最近在弄本身的小玩意兒的時候也用到了它，順便加深了一下了解，在此分享。 html
Java在對*.properties文件進行操做的時候，其實是經過IO對文檔進行逐行的掃描，而後將文中非註釋的部分存放在一個properties對象中。Properties 其實是繼承了hashtable，實現了Map接口。能夠這樣理解，它是進行了進一步封裝的HashMap。存放到properties中後，能夠對properties進行一系列的操做，此時的數據保存在內存中。最後，當須要保存數據的時候，是將properties中全部的鍵值從新寫入到文件中去。 對properties文件的操做，jdk提供了一系列的API。一下是一個工具類，實現了對properties文件的增刪查改的功能。java
1 package com.sean.file.properties;
2
3 import java.io.File;
4 import java.io.FileOutputStream;
5 import java.io.IOException;
6 import java.io.InputStreamReader;
7 import java.io.OutputStreamWriter;
8 import java.io.UnsupportedEncodingException;
9 import java.util.Enumeration;
10 import java.util.HashMap;
11 import java.util.Map;
12 import java.util.Properties;
13 /**
14 * Java 操做Properties的工具類
15 * 實現功能：
16 * 一、Properties文件的增刪查改功能
17 * 二、解決讀寫中文亂碼問題
18 * @author Sean
19 *
20 */
21 public class PropertiesUtil {
22
23 /**
24 * Properties地址值，不須要加根標記"/"
25 */
26 private String src = "";
27 private InputStreamReader inputStream = null;
28 private OutputStreamWriter outputStream = null;
29 private String encode="utf-8";
30 public Properties properties ;
31
32 /**
33 * 默認構造函數
34 */
35 public PropertiesUtil() {
36 }
37
38 /**
39 * 構造函數
40 *
41 * @param src 傳入Properties地址值，不須要加根標記"/"
42 */
43 public PropertiesUtil(String src) {
44 this.src = src;
45 }
46
47
48 /**
49 * 構造函數，提供設置編碼模式
50 * @param src 傳入Properties地址值，不須要加根標記"/"
51 * @param encode 傳入對應的編碼模式，默認是utf-8
52 */
53 public PropertiesUtil(String src, String encode) {
54 this(src);
55 this.encode = encode;
56 }
57
58 /**
59 * 加載properties文件
60 * @author Sean
61 * @date 2015-6-5
62 * @return 返回讀取到的properties對象
63 */
64 public Properties load(){
65 if(src.trim().equals("")){
66 throw new RuntimeException("The path of Properties File is need");
67 }
68 try {
FileInputStream fis = new FileInputStream(src);
69 inputStream=new InputStreamReader(fis/*ClassLoader.getSystemResourceAsStream(src)*/,encode);
70 } catch (UnsupportedEncodingException e1) {
71 e1.printStackTrace();
72 }
73 properties=new Properties();
74 try {
75 properties.load(inputStream);
76 } catch (IOException e) {
77 e.printStackTrace();
78 }
79 return properties;
80 }
81
82 /**
83 * 將配置寫入到文件
84 * @author Sean
85 * @date 2015-6-5
86 * @throws Exception
87 */
88 public void write2File() throws Exception{
89 //獲取文件輸出流
90 outputStream=new OutputStreamWriter(new FileOutputStream(new File(src/*ClassLoader.getSystemResource(src).toURI()*/)),encode);
91 properties.store(outputStream, null);
92 close();
93 }
94
95
96 /**
97 * 經過關鍵字獲取值
98 * @author Sean
99 * @date 2015-6-5
100 * @param key 須要獲取的關鍵字
101 * @return 返回對應的字符串，若是無，返回null
102 */
103 public String getValueByKey(String key){
104 properties=load();
105 String val =properties.getProperty(key.trim());
106 close();
107 return val;
108
109 }
110
111 /**
112 * 經過關鍵字獲取值
113 * @author Sean
114 * @date 2015-6-5
115 * @param key 須要獲取的關鍵字
116 * @param defaultValue 若找不到對應的關鍵字時返回的值
117 * @return 返回找到的字符串
118 */
119 public String getValueByKey(String key ,String defaultValue){
120 properties=load();
121 String val =properties.getProperty(key.trim(),defaultValue.trim());
122 close();
123 return val;
124 }
125
126 /**
127 * 關閉輸入輸出流
128 * @author Sean
129 * @date 2015-6-5
130 */
131 public void close(){
132 try {
133 if(inputStream!=null){inputStream.close();}
134 if(outputStream!=null){outputStream.close();}
135 } catch (IOException e) {
136 e.printStackTrace();
137 }
138 }
139
140 /**
141 * 獲取Properties全部的值
142 * @author Sean
143 * @date 2015-6-5
144 * @return 返回Properties的鍵值對
145 */
146 public Map<String,String> getAllProperties(){
147 properties=load();
148 Map<String,String> map=new HashMap<String,String>();
149 //獲取全部的鍵值
150 Enumeration enumeration=properties.propertyNames();
151 while(enumeration.hasMoreElements()){
152 String key=(String) enumeration.nextElement();
153 String value=getValueByKey(key);
154 map.put(key, value);
155 }
156 close();
157 return map;
158 }
159
160 /**
161 * 往Properties寫入新的鍵值
162 * @author Sean
163 * @date 2015-6-5
164 * @param key 對應的鍵
165 * @param value 對應的值
166 */
167 public void addProperties(String key,String value){
168 properties=load();
169 properties.put(key, value);
170 try {
171 write2File();
172 } catch (Exception e) {
173 e.printStackTrace();
174 }
175 }
176
177 /**
178 * 添加Map中全部的值
179 * @author Sean
180 * @date 2015-6-5
181 * @param map 對應的鍵值對集合
182 */
183 public void addAllProperties(Map<String,String> map){
184 properties=load();
185 properties.putAll(map);
186 try {
187 write2File();
188 } catch (Exception e) {
189 e.printStackTrace();
190 throw new RuntimeException("write fail");
191 }
192 }
193
194 /**
195 * 更新配置文件
196 * @author Sean
197 * 2015-6-5
198 * @param key 須要更新的鍵值
199 * @param value 對應的值
200 */
201 public void update(String key,String value){
202 properties=load();
203 if(!properties.containsKey(key)){
204 throw new RuntimeException("not such key");
205 }
206 properties.setProperty(key, value);
207 try {
208 write2File();
209 } catch (Exception e) {
210 e.printStackTrace();
211 throw new RuntimeException("write fail");
212 }
213 }
214
215 /**
216 * 刪除某一鍵值對
217 * @author Sean
218 * 2015-6-5
219 * @param key 對應的鍵值
220 */
221 public void deleteKey(String key){
222 properties=load();
223 if(!properties.containsKey(key)){
224 throw new RuntimeException("not such key");
225 }
226 properties.remove(key);
227 try {
228 write2File();
229 } catch (Exception e) {
230 e.printStackTrace();
231 throw new RuntimeException("write fail");
232 }
233 }
234
235 /**
236 * 設置path值
237 * @author Sean
238 * @date 2015-6-5
239 * @param src 對應文件值
240 */
241 public void setSrc(String src) {
242 this.src = src;
243 }
244 }
基本上，經常使用的對properties的操做採用這個工具類都能完成。值得注意的是，由於程序在對properties進行掃描的時候，忽略了註釋的內容，而當從新寫內容入文字的時候，程序也只會將properties中的值寫入，這樣會註釋丟失的狀況。這種狀況，網上有人的解決方案是本身新建一個繼承了properties的類，而後將程序讀取到的信息包括註釋放入到LinkedHashMap中，這樣就能夠保存註釋了。apache
不過，一樣的功能，經過Apache 上的開源項目commons-configuration也能實現。commons-configuration 主要是實現對如xml, properties等配置文件操做的API。經過它，一樣能實現對properties的操做，同時，在操做的時候，也能夠保存文件中的註釋。api
在使用commons-configuration進行properties的文件操做的時候，不只須要導入commons-configuration.jar 包，還須要導入另外幾個依賴包才能實現。框架
如下是本能採用commons-configuration提供的api進行properties操做的一個Demo函數
package com.sean;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.net.URISyntaxException;
import org.apache.commons.configuration.Configuration;
import org.apache.commons.configuration.ConfigurationException;
import org.apache.commons.configuration.PropertiesConfiguration;
public class PropertiesUtil {
private String src="";
private PropertiesConfiguration pcf=null;
private String encode="utf-8";
/**
* 默認構造函數
*/
public PropertiesUtil(){};
/**
* 傳參構造函數
* @param src 傳入對應文件地址
*/
public PropertiesUtil(String src){
this.src=src;
try {
pcf=new PropertiesConfiguration(src);
} catch (ConfigurationException e) {
e.printStackTrace();
}
pcf.setEncoding(encode);
}
/**
* 獲取特定key的值
* @param key 對應的鍵值
* @return 返回對應value值，找不到返回null;
*/
public String getValue(String key){
String s=pcf.getString(key);
return s;
}
/**
* 更新對應的值
* @param key 對應的關鍵字
* @param value 對應的值
*/
public void updateValue(String key,String value) {
if(!pcf.containsKey(key)){
throw new RuntimeException("not such key");
}
try {
pcf.save(new FileOutputStream(new File(ClassLoader.getSystemResource(src).toURI())),"utf-8");
} catch (ConfigurationException e) {
e.printStackTrace();
} catch (FileNotFoundException e) {
e.printStackTrace();
} catch (URISyntaxException e) {
e.printStackTrace();
}
}
/**
* 添加鍵值對
* @param key 關鍵字
* @param value 值
*/
public void addValue(String key,String value){
pcf.addProperty(key, value);
try {
pcf.save(new FileOutputStream(new File(ClassLoader.getSystemResource(src).toURI())),"utf-8");
} catch (ConfigurationException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (FileNotFoundException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (URISyntaxException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
/**
* 刪除關鍵字
* @param key 關鍵字
*/
public void delValue(String key){
pcf.clearProperty(key);
try {
pcf.save(new FileOutputStream(new File(ClassLoader.getSystemResource(src).toURI())),"utf-8");
} catch (ConfigurationException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (FileNotFoundException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (URISyntaxException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
能夠看出，commons-configuration提供的api操做起來簡單多了。但是，由於commons-configuration是國外的開源項目，因此其對中文的支持存在一些問題。儘管API中提供了設置字符編碼的功能，可是仍是沒有可以很是好的解決中文的問題。相對而言，原生的API實現起來比較的簡單。工具
最後作下總結，關於對properties 的操做，jdk和commons-configuration都提供了較好的支持，關於使用原生仍是框架，應該根據具體條件而定。不過咱們在不重複造輪的狀況下，仍是應該保持對原理的探討post