您现在的位置：程式碼之家 >> 編程語言 > >> Java 程式設計 >> Java 相關知識

Apache Commons Digester 實戰指南：XML 轉 JavaBean 的高效實踐

編輯：Java 相關知識

簡介

Apache Commons Digester 並非一個 XML 解析器，而是對 SAX 解析器的高層封裝。它讓開發者無需深入了解 SAX 或 DOM 的解析細節，只需定義解析規則，即可將 XML 文檔直接映射為 JavaBean 對象。Digester 內部使用堆疊機制管理 XML 節點：解析到開始標籤時將對象壓入堆疊，解析完所有子節點後彈出。其核心優勢在於使用模式匹配來表達 XML 節點間的父子關係，使配置直觀且強大。

範例場景：學生班級資料

假設我們有一個 students.xml 文件，描述班級及其學生信息：

<?xml version="1.0" encoding="UTF-8" ?>
<stuClass name="fddfdf">
  <student>
    <name from="cn">Java Boy</name>
    <course>JSP</course>
  </student>
  <student>
    <name>Java Girl</name>
    <course>EJB</course>
  </student>
</stuClass>

領域模型類

Student.java

package demo.javabean;

public class Student {
    private String name;
    private String from;
    private String course;

    public String getName() { return name; }
    public void setName(String name) { this.name = name; }
    public String getFrom() { return from; }
    public void setFrom(String from) { this.from = from; }
    public String getCourse() { return course; }
    public void setCourse(String course) { this.course = course; }
}

StuClass.java

package demo.javabean;

import java.util.Vector;

public class StuClass {
    private String name;
    private Vector<Student> students = new Vector<>();

    public String getName() { return name; }
    public void setName(String name) { this.name = name; }
    public Vector<Student> getStudents() { return students; }
    public void setStudents(Vector<Student> students) { this.students = students; }
    public void addStudent(Student student) { students.add(student); }
}

Digester 解析規則配置與執行

以下測試類展示如何配置 Digester 規則並解析 XML：

package demo;

import org.apache.commons.digester.Digester;
import demo.javabean.StuClass;
import java.io.InputStream;

public class DigestStudents {
    public static void main(String[] args) {
        new DigestStudents().digest();
    }

    private void digest() {
        try {
            Digester digester = new Digester();
            digester.setValidating(false);

            // 1. 建立 StuClass 實例並壓入堆疊
            digester.addObjectCreate("stuClass", "demo.javabean.StuClass");
            // 2. 將 stuClass 節點的 name 屬性映射到 StuClass 的 name 屬性
            digester.addSetProperties("stuClass", "name", "name");

            // 3. 遇到 student 子節點時建立 Student 實例
            digester.addObjectCreate("stuClass/student", "demo.javabean.Student");
            // 4. 調用 Student.setName()，參數為 name 節點的文本內容
            digester.addCallMethod("stuClass/student/name", "setName", 0);
            // 5. 將 name 節點的 from 屬性映射到 Student.from
            digester.addSetProperties("stuClass/student/name", "from", "from");
            // 6. 將 course 節點文本內容映射到 Student.course
            digester.addBeanPropertySetter("stuClass/student/course");

            // 7. 當 student 解析完成，調用 StuClass.addStudent() 將其加入集合
            digester.addSetNext("stuClass/student", "addStudent", "demo.javabean.Student");

            // 執行解析
            InputStream input = this.getClass().getClassLoader().getResourceAsStream("demo/students.xml");
            StuClass ds = (StuClass) digester.parse(input);

            System.out.println("班級名稱: " + ds.getName());
            System.out.println("學生列表: " + ds.getStudents());
        } catch (Exception ex) {
            ex.printStackTrace();
        }
    }
}

關鍵規則解析

addObjectCreate(pattern, className)：匹配到 pattern 時實例化指定類，並將實例壓入堆疊頂端。
addSetProperties(pattern, attrName, propName)：將 XML 節點的屬性值設置到對象的對應屬性。
addCallMethod(pattern, methodName, paramCount)：調用堆疊頂端對象的方法，參數來自節點文本或屬性。
addBeanPropertySetter(pattern)：將節點文本內容直接設置給對象的同名屬性（等同於 addCallMethod 配合 setter）。
addSetNext(pattern, methodName, paramType)：當子節點解析完成，調用堆疊中次頂端對象（父對象）的方法，將頂端對象（子對象）傳入。