digester解析xml文件

最新推荐文章于 2025-07-26 13:01:10 发布
转载 最新推荐文章于 2025-07-26 13:01:10 发布 · 529 阅读 · 0
本文介绍Apache Commons Digester库，用于将复杂XML文件解析为Java对象。通过Java配置、XML配置和注解三种方式定义解析规则，简化XML到Java对象的转换过程。

正文

在我们的项目中或多或少会采用xml来做配置文件，你可以采用Java原生支持的sax、DOM或者第三方的dom4j等。虽然提供了各式各样的解析方式，但是解析一个复杂的xml所编写的Java代码是非常麻烦的，尤其是当xml做了修改，你会发现你又要修改Java代码。

 Apache的commons项目中Digester项目解决了这个问题，它可以很轻易地将xml文件解析成Java对象，让你直接去使用，而你仅仅需要去预定义一份解析规则。

而对于解析规则，你可以采用Java的方式定义、xml的方式定义亦或者annotation的方式定义。

要使用digester需要引入依赖：

<!--apache commons digester-->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-digester3</artifactId>
            <version>3.2</version>
        </dependency>

假设我们要解析如下school.xml文件

复制代码

<?xml version="1.0" encoding="utf-8" ?>
<school>
    <classes>
        <class className="classOne">
            <student>
                <no>1</no>
                <name>小张</name>
                <age>24</age>
            </student>
            <student>
                <no>2</no>
                <name>小李</name>
                <age>24</age>
            </student>
            <student>
                <no>1</no>
                <name>小王</name>
                <age>24</age>
            </student>
        </class>
    </classes>
</school>

复制代码

我们需要预定义Student、Class、School节点的Java类与之对应

复制代码

package cn.lay.demo.digester.definition;

/**
 * 学生节点
 * @author lay
 * @date 2018/10/16 23:35
 */
public class StudentDefinition {

    private Integer no;

    private String name;

    private Integer age;

    public Integer getNo() {
        return no;
    }

    public void setNo(Integer no) {
        this.no = no;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "StudentDefinition{" +
                "no=" + no +
                ", name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

package cn.lay.demo.digester.definition;

import java.util.ArrayList;
import java.util.List;

/**
 * 班级节点
 * @author lay
 * @date 2018/10/16 23:36
 */
public class ClassDefinition {

    private String className;

    private List<StudentDefinition> studentDefinitionList = new ArrayList<>();

    public String getClassName() {
        return className;
    }

    public void setClassName(String className) {
        this.className = className;
    }

    public List<StudentDefinition> getStudentDefinitionList() {
        return studentDefinitionList;
    }

    public void setStudentDefinitionList(List<StudentDefinition> studentDefinitionList) {
        this.studentDefinitionList = studentDefinitionList;
    }

    public void addStudent(StudentDefinition studentDefinition) {
        studentDefinitionList.add(studentDefinition);
    }

    @Override
    public String toString() {
        return "ClassDefinition{" +
                "className='" + className + '\'' +
                ", studentDefinitionList=" + studentDefinitionList +
                '}';
    }
}

package cn.lay.demo.digester.definition;

import java.util.ArrayList;
import java.util.List;

/**
 * 学校节点
 * @author lay
 * @date 2018/10/16 23:37
 */
public class SchoolDefinition {

    private List<ClassDefinition> classDefinitions = new ArrayList<>();

    public List<ClassDefinition> getClassDefinitions() {
        return classDefinitions;
    }

    public void setClassDefinitions(List<ClassDefinition> classDefinitions) {
        this.classDefinitions = classDefinitions;
    }

    public void addClass(ClassDefinition classDefinition) {
        classDefinitions.add(classDefinition);
    }

    @Override
    public String toString() {
        return "SchoolDefinition{" +
                "classDefinitions=" + classDefinitions +
                '}';
    }
}

复制代码

回到顶部

1、Java方式配置解析规则

rule

复制代码

package cn.lay.demo.digester.rule;

import cn.lay.demo.digester.definition.ClassDefinition;
import cn.lay.demo.digester.definition.SchoolDefinition;
import cn.lay.demo.digester.definition.StudentDefinition;
import org.apache.commons.digester3.Digester;

import java.net.URL;

/**
 * java方式定义解析规则
 * @author lay
 * @date 2018/10/16 23:38
 */
public class DigesterRule {

    /**
     * 解析
     * @param filePath
     * @return
     */
    public SchoolDefinition execute(String filePath) throws Exception{
        Digester digester = new Digester();
        digester.setValidating(false);
        // classes node
        digester.addObjectCreate("school/classes", SchoolDefinition.class);
        // class node
        digester.addObjectCreate("school/classes/class", ClassDefinition.class);
        // set properties
        digester.addSetProperties("school/classes/class");
        // student node
        digester.addObjectCreate("school/classes/class/student", StudentDefinition.class);
        // set properties
        digester.addBeanPropertySetter("school/classes/class/student/no");
        digester.addBeanPropertySetter("school/classes/class/student/name");
        digester.addBeanPropertySetter("school/classes/class/student/age");
        // add student
        digester.addSetNext("school/classes/class/student", "addStudent");
        // add class
        digester.addSetNext("school/classes/class", "addClass");
        // parse
        URL url = this.getClass().getClassLoader().getResource(filePath);
        System.out.println("url=" + url.toString());
        return digester.parse(url);
    }
}

复制代码

测试

@Test
    public void testJavaRule() throws Exception {
        SchoolDefinition schoolDefinition = new DigesterRule().execute("school.xml");
        System.out.println(schoolDefinition);
    }

 

回到顶部

2、xml方式配置解析规则

rule

复制代码

<!DOCTYPE digester-rules PUBLIC
        "-//Apache Commons //DTD digester-rules XML V1.0//EN"
        "http://commons.apache.org/digester/dtds/digester-rules-3.0.dtd">
<digester-rules>
    <!--school node-->
    <pattern value="school/classes">
        <object-create-rule classname="cn.lay.demo.digester.definition.SchoolDefinition"/>
        <!--class node-->
        <pattern value="class">
            <object-create-rule classname="cn.lay.demo.digester.definition.ClassDefinition"/>
            <set-properties-rule/>
            <!--student node-->
            <pattern value="student">
                <object-create-rule classname="cn.lay.demo.digester.definition.StudentDefinition"/>
                <bean-property-setter-rule pattern="no"/>
                <bean-property-setter-rule pattern="name"/>
                <bean-property-setter-rule pattern="age"/>
                <set-next-rule methodname="addStudent"/>
            </pattern>
            <set-next-rule methodname="addClass"/>
        </pattern>
    </pattern>

</digester-rules>

复制代码

测试

复制代码

@Test
    public void testXmlRule() throws Exception {
        Digester digester = DigesterLoader.newLoader(new XmlRulesModule()).newDigester();
        URL url = this.getClass().getClassLoader().getResource("school.xml");
        System.out.println("url=" + url);
        SchoolDefinition schoolDefinition = digester.parse(url);
        System.out.println(schoolDefinition);
    }

    
    class XmlRulesModule extends FromXmlRulesModule {

        @Override
        protected void loadRules() {
            loadXMLRules(this.getClass().getClassLoader().getResourceAsStream("rule/schoolRule.xml"));
        }
    }

复制代码

回到顶部

 3、注解方式配置解析规则

基于零配置思想，digester支持采用annotation来注解相应的解析规则。

rule

复制代码

package cn.lay.demo.digester.definition;

import org.apache.commons.digester3.annotations.rules.ObjectCreate;
import org.apache.commons.digester3.annotations.rules.SetNext;
import org.apache.commons.digester3.annotations.rules.SetRoot;

import java.util.ArrayList;
import java.util.List;

/**
 * 学校节点
 * @author lay
 * @date 2018/10/16 23:37
 */
@ObjectCreate(pattern = "school/classes")
public class SchoolDefinition {

    private List<ClassDefinition> classDefinitions = new ArrayList<>();

    public List<ClassDefinition> getClassDefinitions() {
        return classDefinitions;
    }

    public void setClassDefinitions(List<ClassDefinition> classDefinitions) {
        this.classDefinitions = classDefinitions;
    }

    @SetNext
    public void addClass(ClassDefinition classDefinition) {
        System.out.println("执行了addClass");
        classDefinitions.add(classDefinition);
    }

    @Override
    public String toString() {
        return "SchoolDefinition{" +
                "classDefinitions=" + classDefinitions +
                '}';
    }
}

package cn.lay.demo.digester.definition;

import org.apache.commons.digester3.annotations.rules.*;

import java.util.ArrayList;
import java.util.List;

/**
 * 班级节点
 * @author lay
 * @date 2018/10/16 23:36
 */
@ObjectCreate(pattern = "school/classes/class")
public class ClassDefinition {

    @SetProperty(pattern = "school/classes/class")
    private String className;

    private List<StudentDefinition> studentDefinitionList = new ArrayList<>();

    public String getClassName() {
        return className;
    }

    public void setClassName(String className) {
        this.className = className;
    }

    public List<StudentDefinition> getStudentDefinitionList() {
        return studentDefinitionList;
    }

    public void setStudentDefinitionList(List<StudentDefinition> studentDefinitionList) {
        this.studentDefinitionList = studentDefinitionList;
    }

    @SetNext
    public void addStudent(StudentDefinition studentDefinition) {
        System.out.println("执行了addStudent");
        studentDefinitionList.add(studentDefinition);
    }

    @Override
    public String toString() {
        return "ClassDefinition{" +
                "className='" + className + '\'' +
                ", studentDefinitionList=" + studentDefinitionList +
                '}';
    }
}

package cn.lay.demo.digester.definition;

import org.apache.commons.digester3.annotations.rules.BeanPropertySetter;
import org.apache.commons.digester3.annotations.rules.ObjectCreate;

/**
 * 学生节点
 * @author lay
 * @date 2018/10/16 23:35
 */
@ObjectCreate(pattern = "school/classes/class/student")
public class StudentDefinition {

    @BeanPropertySetter(pattern = "school/classes/class/student/no")
    private Integer no;

    @BeanPropertySetter(pattern = "school/classes/class/student/name")
    private String name;

    @BeanPropertySetter(pattern = "school/classes/class/student/age")
    private Integer age;

    public Integer getNo() {
        return no;
    }

    public void setNo(Integer no) {
        this.no = no;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "StudentDefinition{" +
                "no=" + no +
                ", name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

复制代码

测试

复制代码

@Test
    public void testAnnotationRule() throws Exception {
        Digester digester = DigesterLoader.newLoader(new FromAnnotationsRuleModule() {
            @Override
            protected void configureRules() {
                // 这里只添加SchoolDefinition即可
                bindRulesFrom(SchoolDefinition.class);
            }
        }).newDigester();
        URL url = this.getClass().getClassLoader().getResource("school.xml");
        System.out.println("url=" + url);
        SchoolDefinition schoolDefinition = digester.parse(url);
        System.out.println(schoolDefinition);
    }

复制代码

commons-digester3-3.2-API文档-中文版.zip
05-09
赠送jar包：commons-digester3-3.2.jar； 赠送原API文档：commons-digester3-3.2-javadoc.jar； 赠送源代码：commons-digester3-3.2-sources.jar； 赠送Maven依赖信息文件：commons-digester3-3.2.pom； 包含翻译后的API文档：commons-digester3-3.2-javadoc-API文档-中文(简体)版.zip； Maven坐标：org.apache.commons:commons-digester3:3.2； 标签：apache、commons、digester3、jar包、java、中文文档； 使用方法：解压翻译后的API文档，用浏览器打开“index.html”文件，即可纵览文档内容。 人性化翻译，文档中的代码和结构保持不变，注释和说明精准翻译，请放心使用。
commons-digester3-3.2-API文档-中英对照版.zip
05-04
赠送jar包：commons-digester3-3.2.jar； 赠送原API文档：commons-digester3-3.2-javadoc.jar； 赠送源代码：commons-digester3-3.2-sources.jar； 赠送Maven依赖信息文件：commons-digester3-3.2.pom； 包含翻译后的API文档：commons-digester3-3.2-javadoc-API文档-中文(简体)-英语-对照版.zip； Maven坐标：org.apache.commons:commons-digester3:3.2； 标签：apache、commons、digester3、jar包、java、中英对照文档； 使用方法：解压翻译后的API文档，用浏览器打开“index.html”文件，即可纵览文档内容。 人性化翻译，文档中的代码和结构保持不变，注释和说明精准翻译，请放心使用。 双语对照，边学技术、边学英语。
Apache Commons Digester 3.0的新增功能是什么？
07-02 292
最近发布了Apache Commons Digester项目的3.0版 ，主要重写了原始的Apache Commons Digester实现。 在这次采访中，我们就最新版本中的新增功能与ASF PMC成员Simone Tripodi进行了交谈。 JAXenter：您可以向我们介绍Apache Commons Digester项目吗？ Simone Tripodi： Apache Com...
digester java_commons-digester 升级到 commons-digester3 的坑
weixin_35017289的博客
02-23 411
如果你也遇到同样的报错问题, 查看本文章,可以直接帮你节省大约2小时时间commons-digester 已经很久没有维护了, 这次在升级 feilong 到3 的时候, 顺便也升级下 commons-digester3 依赖1. 升级依赖的jarorg.apache.commonscommons-digester33.22 报错 1 DigesterLoader.createDigester升级...
commons-digester3-3.2.jar中文文档.zip
05-08
# 压缩文件中包含： 中文文档 jar包下载地址 Maven依赖 Gradle依赖 源代码下载地址 # 本文件关键字： jar中文文档.zip,java,jar包,Maven,第三方jar包,组件,开源组件,第三方组件,Gradle,中文API文档,手册,开发手册,使用手册,参考手册 # 使用方法： 解压最外层zip，再解压其中的zip包，双击 【index.html】 文件，即可用浏览器打开、进行查看。 # 特殊说明： ·本文档为人性化翻译，精心制作，请放心使用。 ·只翻译了该翻译的内容，如：注释、说明、描述、用法讲解 等； ·不该翻译的内容保持原样，如：类名、方法名、包名、类型、关键字、代码 等。 # 温馨提示： （1）为了防止解压后路径太长导致浏览器无法打开，推荐在解压时选择“解压到当前文件夹”（放心，自带文件夹，文件不会散落一地）； （2）有时，一套Java组件会有多个jar，所以在下载前，请仔细阅读本篇描述，以确保这就是你需要的文件；
Apache Commons Digester 三（规则注解）
weixin_33736649的博客
06-07 227
前言 Digester规则的定义除了可以在代码中直接new规则添加到 Digester对象外，还可以用xml配置规则，如下所示： &lt;digester-rules&gt; &lt;pattern value="*/foo"&gt; &lt;object-create-rule pattern="bar" classname="Foobar" /&gt; &
Apache Commons Digester 快速入门及实战指南
gitblog_01145的博客
08-07 488
Apache Commons Digester 快速入门及实战指南 项目介绍 Apache Commons Digester 是一款功能强大的XML解析器，它构建在SAX基础之上但提供了一个更为简单易用的高级接口。相比于直接使用SAX或DOM进行XML文件解析，Digester允许开发者以“事件驱动”的方式处理XML文档，即当识别出特定的XML元素时，自动触发一系列预定义的操作，比如对象创建、方法...
Digester解析XML文件
weixin_45324483的博客
11-10 972
这是我的第一篇博客，基本都是从多个博客中借鉴过来，然后按照自己的理解整理了一下写的，第一次写博客不知道该注意什么，有不好的地方请指出，非常感谢 一、前言 SAX是基于文件流来解析xml文件的，在读取xml文件流时，SAX会通过节点来触发相应的操作，也可以说SAX是基于文件流的事情触发机制来解析xml文件的。 Digeter是apache的common项目，作用是将XML转化成对象，使...
java用Digester解析xml文件——高效率的xml解析
热门推荐
敲码农的小代码　　　;
05-02 15万+
Digester不是jdk里面自带的，有依赖包
java digester_digester解析xml文件
weixin_31578739的博客
02-16 359
在我们的项目中或多或少会采用xml来做配置文件，你可以采用Java原生支持的sax、DOM或者第三方的dom4j等。虽然提供了各式各样的解析方式，但是解析一个复杂的xml所编写的Java代码是非常麻烦的，尤其是当xml做了修改，你会发现你又要修改Java代码。Apache的commons项目中Digester项目解决了这个问题，它可以很轻易地将xml文件解析成Java对象，让你直接去使用，而你仅仅...
Digester解析xml文件
xiaomin1991222的专栏
03-10 232
刚刚学了一下Digester如何解析xml文件，所以记录下来，方便以后查看。       一般用来读取xml文件的工具包有DOM、SAX和JDOM等，但用过的人都知道，它们属于比较底层的API，写起来代码量很大，而且如果修改了xml文件的格式，代码也要做大幅度的改动。而使用Apache Jakarta的Digester，解析XML文件非常方便且不需要过多的关心底层的具体解析过程。Digeste
Digester解析xml文档
yufei2999的专栏
11-12 605
依赖apache的四个包： commons-digester-2.1.jar commons-logging-1.1.1.jar commons-beanutils-1.8.3.jar commons-collections-3.2.1.jar 用到类Digester、DigesterLoader等，引入commons-digester-2.1.jar 用到类Log、LogFactor
commons-digester3-3.2.jar
06-27
commons-digester3-3.2.jar
commons-digester3-3.2-bin.zip
09-21
digester组件简化了xml文件处理操作，能将xml文件按照事先确定的规则（采用编码形式或xml配置文件形式），映射成java对象。digester组件现在最新版本是2.0,它所依赖的组件是：commons-logging(推荐1.1版本)，BeanUtils(推荐1.8版本)，还有需要jdk1.5.
apache-comnons系列之commons-digester 3.3.2 学习笔记
undergrowth的专栏
09-07 703
apache-comnons系列之commons-digester 3.3.2 学习笔记概述 参考 http://www.blogjava.net/tw-ddm/archive/2006/07/20/59299.html http://macken.iteye.com/blog/1379181 Digester—->入口解析 Rules rules—->存放预先注册的规则与模式 利用堆存放创建的对
Apache Commons Digester组件解析与应用
最新发布
weixin_42388898的博客
07-26 388
Rule可以分为以下几类：实例化规则（Instantiation Rules）：当遇到特定的XML节点时，用于创建对象的规则。属性规则（Property Rules）：用于设置对象属性的规则。操作规则（Action Rules）：执行自定义方法或者脚本的规则。特殊规则（Special Rules）：如等，它们具有特定的目的和功能。
解析XML工具之Digester详细说明
roach
10-31 1818
XML作为web应用的重要部分，所以很多程序有使用xml作为服务配置。现在解析XML的组件有很多，比如DOM，xquery，xpath等。 本文介绍一种XML的方法，digester工具类。 Digester简介： Digester框架属于Jakarta   Commons，它以规则和模式为基础处理XML文档。与SAX和DOM之类的标准API相比，Digester不涉及太多的细节问题，非常适
digester3解析xml(rss)手记
是非一念间
03-07 382
因为需要写个程序解析RSS，于是下载了最新的digester3版本：commons-digester3-3.2-bin.zip [url]http://commons.apache.org/proper/commons-logging/download_logging.cgi[/url] 用以前的惯常写法，一直不行。 [code="java"] public static void m...
利用commons-digester3-30.jar解析xml文件
shihuan830619的专栏
08-28 288
此方式解析需要commons-beanutils-1.8.3.jar的支持 Person.java类： [code="java"]import java.io.Serializable; public class Person implements Serializable { public String id; public String name; public ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值