DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> XML學習教程 >> XML詳解
用 SAX 讀取 XML 設定檔:一個可重複使用的解析器
編輯:XML詳解     

在一個 MIS 專案裡,我決定把散落在程式碼各處的設定值抽到一個外部設定檔,理由是實在不想再看到硬編碼的字串被複製到第七個地方。

格式選 XML 幾乎不需要猶豫。J2EE 的世界裡設定檔早就以 XML 為主流,還在用 ini 反而顯得格格不入。剩下真正的問題是:用什麼來讀?dom4j 與 SAX 都是當時的熱門選項,我平常習慣用 dom4j,但手上的 WebLogic Workshop 自帶的是 SAX,實在不想再為此多引入一套套件,於是就決定走 SAX 這條路。

一、設定檔長什麼樣子

reportenv.xml 的內容刻意保持簡單,只放資料庫連線所需的最小資訊:

<?XML version="1.0" encoding="utf-8"?>
<reportenv>
  <datasource>
    <username>sqlname</username>
    <passWord>password</passWord>
  </datasource>
</reportenv>

二、ConfigParser:繼承 DefaultHandler 的解析器

SAX 是串流式的解析模型,它不幫你建樹,而是遇到什麼就回報什麼。因此我們自己維護一個 Properties 當容器,靠三個回呼方法把「元素名稱」與「元素內容」配對起來:

package com.infoearth.report;

import java.util.Properties;
import org.xml.sax.Attributes;
import org.xml.sax.helpers.DefaultHandler;
import org.xml.sax.SAXException;

public class ConfigParser extends DefaultHandler {

    private Properties props;                    // 存放解析結果
    private String currentName;                  // 目前遇到的元素名
    private StringBuffer currentValue = new StringBuffer();

    public ConfigParser() {
        this.props = new Properties();
    }

    public Properties getProps() {
        return this.props;
    }

    // 進入一個元素:清空暫存區,記下標籤名稱
    public void startElement(String uri, String localName, String qName, Attributes attributes)
            throws SAXException {
        currentValue.delete(0, currentValue.length());
        this.currentName = qName;
    }

    // 元素內的文字內容,可能被分成好幾段回報,所以要累加
    public void characters(char[] ch, int start, int length) throws SAXException {
        currentValue.append(ch, start, length);
    }

    // 離開元素:把名稱與值配對存起來
    public void endElement(String uri, String localName, String qName) throws SAXException {
        props.put(qName.toLowerCase(), currentValue.toString().trim());
    }
}

這裡最容易踩的坑是 characters()。SAX 不保證一次就把節點內的文字交給你,遇到長字串或夾雜實體參照時,它可能拆成好幾次呼叫,所以一定要用 StringBuffer 累加,不能只在裡面做指派。另外 endElement() 中的 trim 也不可省,XML 裡為了排版而產生的換行與縮排空白都會被算進內容。

三、ParseXML:把工廠、解析器、處理器串起來

第二個類別負責組裝 SAX 的標準三件套:SAXParserFactory 產生 SAXParser,SAXParser 帶著 handler 去解析檔案。

package com.infoearth.report;

import java.util.Properties;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;

public class ParseXML {

    private Properties props;

    public Properties getProps() {
        return this.props;
    }

    public void parse(String filename) throws Exception {
        ConfigParser handler = new ConfigParser();

        SAXParserFactory factory = SAXParserFactory.newInstance();
        factory.setNamespaceAware(false);
        factory.setValidating(false);

        SAXParser parser = factory.newSAXParser();
        try {
            parser.parse(filename, handler);
            props = handler.getProps();
        } finally {
            // 協助釋放,大型專案或反覆呼叫時尤其值得這麼寫
            factory = null;
            parser = null;
            handler = null;
        }
    }
}

四、ReadConfigXML:給呼叫端一個好懂的介面

最後包一層語意明確的外殼,讓使用的地方不必知道底下是 SAX 還是 DOM:

package com.infoearth.report;

import java.util.Properties;

public class ReadConfigXML {

    private Properties props;

    public ReadConfigXML(String url) {
        ParseXML myRead = new ParseXML();
        try {
            myRead.parse(url);
            props = myRead.getProps();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    public String getUserName() {
        return props.getProperty("username");
    }

    public String getPassWord() {
        return props.getProperty("passWord");
    }
}

呼叫端於是只剩下三行,可讀性比原本散落的判斷好上太多:

ReadConfigXML xmlread = new ReadConfigXML("reportenv.xml");
String username = xmlread.getUserName();
String passWord = xmlread.getPassWord();

五、關於這個三層結構的一點自省

前兩個類別其實已經足夠通用——任何 XML 的「標籤名/標籤值」結構都能被讀進 Properties,取用時不必再關心檔案長相。第三個類別嚴格說來是多餘的,當初之所以還是寫了出來,是因為不想更動既有專案的呼叫架構,於是多了這麼一層包装。

這在教學上算是畫蛇添足,但在真實專案裡,這種「為了不驚動既有程式而多包一層」的取捨幾乎天天上演。技術上的優雅與現實中的兼容,往往就得這樣妥協。

最後要提醒的是:把帳號密碼以純文字放在 XML 設定檔裡,只適合內部的低敏感場景。若要上 production,仍應改用加密設定或外部的憑證管理機制,並限制檔案的讀取權限。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved