實現對properties文件的有序讀寫
最近遇到一項需求，要求把properties文件中的內容讀取出來供用戶修改，修改完後需要再重新保存到properties文件中。很簡單的需求吧，可問題是Properties是繼承自HashTable的，直接通過keySet()、keys()或entrySet()方法對Properties中的元素進行遍歷時取出來的內容順序與properties文件中的順序不一致，這是問題一；問題二是就算取出來的時候是有序的，保存到文件中時又是無序的了。
當然，解決這兩個問題的方法有很多。我最終採用的方法是自定義一個PropertiesUtil類，該類繼承自Properties。PropertiesUtil提供一個返回由key按照存入順序組成的List的方法，getKeyList()，這樣問題一就解決了。那如何保證getKeyList()方法返回的就是有序的key組成的集合呢？我查看了一下Properties方法的源碼，發現其setProperty()方法實際上就是調用了父類HashTable的put()方法，其次Properties在從文件中加載內容時是按照文件順序進行讀取，然後調用父類HashTable的put()方法進行儲存。所以問題的解決辦法就是PropertiesUtil持有一個私有的可以有序存儲key的集合，然後重寫父類的put()方法，在方法體中照常通過super.put()進行屬性的存儲，同時將key添加到存儲key的集合中。
Properties提供有save()方法和store()方法可以將當前對象的內容存放到指定的輸出流中，但它們的底層邏輯都是一樣的。通過調用keys()方法獲取一個Enumeration，然後對該Enumeration進行遍歷，依次將對應的key和value寫入到輸出流中，所以要保證寫入是有序的，就要保證遍歷keys()返回的Enumeration時取出的元素key是有序的。所以解決方法是重寫keys()方法，保證遍歷返回的Enumeration時得到的key是有序的。完整代碼如下：
import java.io.BufferedWriter;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.Properties;
public class PropertiesUtil extends Properties {
private static final long serialVersionUID = 1L;
private List<Object> keyList = new ArrayList<Object>();
/**
* 默認構造方法
*/
public PropertiesUtil() {
}
/**
* 從指定路徑加載信息到Properties
* @param path
*/
public PropertiesUtil(String path) {
try {
InputStream is = new FileInputStream(path);
this.load(is);
} catch (FileNotFoundException e) {
e.printStackTrace();
throw new RuntimeException("指定文件不存在！");
} catch (IOException e) {
e.printStackTrace();
}
}
/**
* 重寫put方法，按照property的存入順序保存key到keyList，遇到重複的後者將覆蓋前者。
*/
@Override
public synchronized Object put(Object key, Object value) {
this.removeKeyIfExists(key);
keyList.add(key);
return super.put(key, value);
}
/**
* 重寫remove方法，刪除屬性時清除keyList中對應的key。
*/
@Override
public synchronized Object remove(Object key) {
this.removeKeyIfExists(key);
return super.remove(key);
}
/**
* keyList中存在指定的key時則將其刪除
*/
private void removeKeyIfExists(Object key) {
keyList.remove(key);
}
/**
* 獲取Properties中key的有序集合
* @return
*/
public List<Object> getKeyList() {
return keyList;
}
/**
* 保存Properties到指定文件，默認使用UTF-8編碼
* @param path 指定文件路徑
*/
public void store(String path) {
this.store(path, "UTF-8");
}
/**
* 保存Properties到指定文件，並指定對應存放編碼
* @param path 指定路徑
* @param charset 文件編碼
*/
public void store(String path, String charset) {
if (path != null && !"".equals(path)) {
try {
OutputStream os = new FileOutputStream(path);
BufferedWriter bw = new BufferedWriter(new OutputStreamWriter(os, charset));
this.store(bw, null);
bw.close();
} catch (FileNotFoundException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
} else {
throw new RuntimeException("存儲路徑不能爲空!");
}
}
/**
* 重寫keys方法，返回根據keyList適配的Enumeration，且保持HashTable keys()方法的原有語義，
* 每次都調用返回一個新的Enumeration對象，且和之前的不產生衝突
*/
@Override
public synchronized Enumeration<Object> keys() {
return new EnumerationAdapter<Object>(keyList);
}
/**
* List到Enumeration的適配器
*/
private class EnumerationAdapter<T> implements Enumeration<T> {
private int index = 0;
private final List<T> list;
private final boolean isEmpty;
public EnumerationAdapter(List<T> list) {
this.list = list;
this.isEmpty = list.isEmpty();
}
public boolean hasMoreElements() {
//isEmpty的引入是爲了更貼近HashTable原有的語義，在HashTable中添加元素前調用其keys()方法獲得一個Enumeration的引用，
//之後往HashTable中添加數據後，調用之前獲取到的Enumeration的hasMoreElements()將返回false，但如果此時重新獲取一個
//Enumeration的引用，則新Enumeration的hasMoreElements()將返回true，而且之後對HashTable數據的增、刪、改都是可以在
//nextElement中獲取到的。
return !isEmpty && index < list.size();
}
public T nextElement() {
if (this.hasMoreElements()) {
return list.get(index++);
}
return null;
}
}
}