Java 與 XML 常被視為絕配,網路上探討兩者結合的文章不計其數。談到 XML,多數人的第一聯想到的往往是電子商務中的資料交換標準,但如果你做的是一般的企業內部系統,幾乎碰不到跨組織交換資料的場景,是否就與 XML 無緣?答案當然是否定的。
近年來一個明顯的趨勢是,Java 程式的設定檔正在全面改用 XML 格式。早期大家習慣沿用類似 Windows INI 的「鍵=值」寫法,Java 平台甚至提供了 Properties 這個專門處理這類屬性檔的類別。但自從 Tomcat 的安裝設定、J2EE 的各種部署描述檔相繼採用 XML 之後,XML 當設定檔的價值已經很清楚了:結構分明、可加註解、易於擴充,而且 tooling 支援完整。
關鍵問題只剩一個:怎麼把 XML 設定檔讀進來?Java 世界常見的解析方案有 DOM 與 SAX 兩大流派。Apache 的 XML 專案群(Xerces、Xalan、Cocoon)各自負責不同層面;Tomcat 本身採用 Sun 的 JAXP,而 XSL Taglib 專案則選用 Xerces 解析器。
幾乎每個系統都需要一些隨主機環境而變的參數,最典型的就是資料庫的連線資訊與帳號密碼。開發機、測試機、正式機的設定往往不同,如果這些值寫死在程式碼裡,每次部署都得重新編譯一次。把它們抽到 XML 設定檔中,換環境只要換檔案即可。
<myenv>
<datasource>
<dbhost>localhost</dbhost>
<dbname>sqlname</dbname>
<dbuser>username</dbuser>
<dbpassWord>password</dbpassWord>
</datasource>
</myenv>
這份 myenv.xml 一般放在 Tomcat 的 WEB-INF/classes 目錄下,讓 class loader 能直接以 classpath 資源的方式找到它。
DOM 會把整份文件一次讀進記憶體,形成可隨意走訪的樹狀結構,但文件一大就吃記憶體;SAX 則是逐行、逐事件往下讀,非常適合大型檔案。設定檔本身很小,兩者皆可,但 SAX 更輕巧,也不必額外保留整棵樹,因此這裡採用 SAX。
需要提醒的是,SAX 解析器多年來演進幅度不小,網路上不少教學仍針對舊版本 API 撰寫。若你使用 JDK 1.4 以上,可以直接沿用 JAXP 的標準套件 javax.xml.parsers,下面的程式即是依此改寫並實際除錯後的版本。
繼承 DefaultHandler 的好處是不必實作介面中所有方法,只覆寫我們感興趣的三個回呼即可。
import org.xml.sax.Attributes;
import org.xml.sax.helpers.DefaultHandler;
import org.xml.sax.SAXException;
import java.util.Properties;
public class ConfigParser extends DefaultHandler {
// 用 Properties 存放 dbhost、dbuser、dbpassWord 等鍵值
private Properties props;
private String currentName;
private StringBuffer currentValue = new StringBuffer();
public ConfigParser() {
this.props = new Properties();
}
public Properties getProps() {
return this.props;
}
// 進入 <xxx> 時,清空上一輪累積的值並記住元素名稱
public void startElement(String uri, String localName,
String qName, Attributes attributes)
throws SAXException {
currentValue.delete(0, currentValue.length());
this.currentName = qName;
}
// <xxx> 與 </xxx> 之間的文字會被逐段送進來
public void characters(char[] ch, int start, int length)
throws SAXException {
currentValue.append(ch, start, length);
}
// 遇到 </xxx> 時,把名稱與值配對存進 Properties
public void endElement(String uri, String localName, String qName)
throws SAXException {
props.put(qName.toLowerCase(), currentValue.toString().trim());
}
}
解析 XML 其實就是這麼直觀:進元素時記名字,讀到字元就累加,出元素時把配對收起來。
上面的處理器只活在解析過程當中,其他程式還拿不到資料,因此我們再包一層。
import java.util.Properties;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import java.net.URL;
public class ParseXML {
private Properties props;
public Properties getProps() {
return this.props;
}
public void parse(String filename) throws Exception {
ConfigParser handler = new ConfigParser();
// 取得 SAX 工廠,關閉驗證與命名空間支援
SAXParserFactory factory = SAXParserFactory.newInstance();
factory.setNamespaceAware(false);
factory.setValidating(false);
SAXParser parser = factory.newSAXParser();
// 以 class loader 定位 myenv.xml(Tomcat 中即位於 WEB-INF/classes)
// BeansConstants 可用你自己專案中的任一類別取代
URL confURL =
BeansConstants.class.getClassLoader().getResource(filename);
try {
parser.parse(confURL.toString(), handler);
// 解析完成後即可取得屬性集合
props = handler.getProps();
} finally {
factory = null;
parser = null;
handler = null;
}
}
}
由於 XML 採用最單純的結構,解析器寫得簡單也就足夠應付日常設定檔的需求。之後任何程式只要呼叫 getProps(),就能取出 dbhost、dbuser、dbpassWord 等鍵值。
判斷一套系統是否夠現代,看它的設定檔往往比看功能列表更準。如果設定還停留在 xxx=123 這類 INI 風格的寫法,多少令人覺得少了點時代感;改用 XML 之後,設定內容不但結構清楚,也更容易隨需求擴充。