java digester_digester解析xml文件

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

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

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

要使用digester需要引入依赖：

org.apache.commons

commons-digester3

3.2

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

1

小张

24

2

小李

24

1

小王

24

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

packagecn.lay.demo.digester.definition;/*** 学生节点

*@authorlay

* @date 2018/10/16 23:35*/

public classStudentDefinition {privateInteger no;privateString name;privateInteger age;publicInteger getNo() {returnno;

}public voidsetNo(Integer no) {this.no =no;

}publicString getName() {returnname;

}public voidsetName(String name) {this.name =name;

}publicInteger getAge() {returnage;

}public voidsetAge(Integer age) {this.age =age;

}

@OverridepublicString toString() {return "StudentDefinition{" +

"no=" + no +

", name='" + name + '\'' +

", age=" + age +

'}';

}

}packagecn.lay.demo.digester.definition;importjava.util.ArrayList;importjava.util.List;/*** 班级节点

*@authorlay

* @date 2018/10/16 23:36*/

public classClassDefinition {privateString className;private List studentDefinitionList = new ArrayList<>();publicString getClassName() {returnclassName;

}public voidsetClassName(String className) {this.className =className;

}public ListgetStudentDefinitionList() {returnstudentDefinitionList;

}public void setStudentDefinitionList(ListstudentDefinitionList) {this.studentDefinitionList =studentDefinitionList;

}public voidaddStudent(StudentDefinition studentDefinition) {

studentDefinitionList.add(studentDefinition);

}

@OverridepublicString toString() {return "ClassDefinition{" +

"className='" + className + '\'' +

", studentDefinitionList=" + studentDefinitionList +

'}';

}

}packagecn.lay.demo.digester.definition;importjava.util.ArrayList;importjava.util.List;/*** 学校节点

*@authorlay

* @date 2018/10/16 23:37*/

public classSchoolDefinition {private List classDefinitions = new ArrayList<>();public ListgetClassDefinitions() {returnclassDefinitions;

}public void setClassDefinitions(ListclassDefinitions) {this.classDefinitions =classDefinitions;

}public voidaddClass(ClassDefinition classDefinition) {

classDefinitions.add(classDefinition);

}

@OverridepublicString toString() {return "SchoolDefinition{" +

"classDefinitions=" + classDefinitions +

'}';

}

}

1、Java方式配置解析规则

rule

packagecn.lay.demo.digester.rule;importcn.lay.demo.digester.definition.ClassDefinition;importcn.lay.demo.digester.definition.SchoolDefinition;importcn.lay.demo.digester.definition.StudentDefinition;importorg.apache.commons.digester3.Digester;importjava.net.URL;/*** java方式定义解析规则

*@authorlay

* @date 2018/10/16 23:38*/

public classDigesterRule {/*** 解析

*@paramfilePath

*@return

*/

public SchoolDefinition execute(String filePath) throwsException{

Digester digester= newDigester();

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());returndigester.parse(url);

}

}

测试

@Testpublic void testJavaRule() throwsException {

SchoolDefinition schoolDefinition= new DigesterRule().execute("school.xml");

System.out.println(schoolDefinition);

}

2、xml方式配置解析规则

rule

/p>

"-//Apache Commons //DTD digester-rules XML V1.0//EN"

"http://commons.apache.org/digester/dtds/digester-rules-3.0.dtd">

测试

@Testpublic void testXmlRule() throwsException {

Digester digester= DigesterLoader.newLoader(newXmlRulesModule()).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 extendsFromXmlRulesModule {

@Overrideprotected voidloadRules() {

loadXMLRules(this.getClass().getClassLoader().getResourceAsStream("rule/schoolRule.xml"));

}

}

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

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

rule

packagecn.lay.demo.digester.definition;importorg.apache.commons.digester3.annotations.rules.ObjectCreate;importorg.apache.commons.digester3.annotations.rules.SetNext;importorg.apache.commons.digester3.annotations.rules.SetRoot;importjava.util.ArrayList;importjava.util.List;/*** 学校节点

*@authorlay

* @date 2018/10/16 23:37*/@ObjectCreate(pattern= "school/classes")public classSchoolDefinition {private List classDefinitions = new ArrayList<>();public ListgetClassDefinitions() {returnclassDefinitions;

}public void setClassDefinitions(ListclassDefinitions) {this.classDefinitions =classDefinitions;

}

@SetNextpublic voidaddClass(ClassDefinition classDefinition) {

System.out.println("执行了addClass");

classDefinitions.add(classDefinition);

}

@OverridepublicString toString() {return "SchoolDefinition{" +

"classDefinitions=" + classDefinitions +

'}';

}

}packagecn.lay.demo.digester.definition;import org.apache.commons.digester3.annotations.rules.*;importjava.util.ArrayList;importjava.util.List;/*** 班级节点

*@authorlay

* @date 2018/10/16 23:36*/@ObjectCreate(pattern= "school/classes/class")public classClassDefinition {

@SetProperty(pattern= "school/classes/class")privateString className;private List studentDefinitionList = new ArrayList<>();publicString getClassName() {returnclassName;

}public voidsetClassName(String className) {this.className =className;

}public ListgetStudentDefinitionList() {returnstudentDefinitionList;

}public void setStudentDefinitionList(ListstudentDefinitionList) {this.studentDefinitionList =studentDefinitionList;

}

@SetNextpublic voidaddStudent(StudentDefinition studentDefinition) {

System.out.println("执行了addStudent");

studentDefinitionList.add(studentDefinition);

}

@OverridepublicString toString() {return "ClassDefinition{" +

"className='" + className + '\'' +

", studentDefinitionList=" + studentDefinitionList +

'}';

}

}packagecn.lay.demo.digester.definition;importorg.apache.commons.digester3.annotations.rules.BeanPropertySetter;importorg.apache.commons.digester3.annotations.rules.ObjectCreate;/*** 学生节点

*@authorlay

* @date 2018/10/16 23:35*/@ObjectCreate(pattern= "school/classes/class/student")public classStudentDefinition {

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

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

@BeanPropertySetter(pattern= "school/classes/class/student/age")privateInteger age;publicInteger getNo() {returnno;

}public voidsetNo(Integer no) {this.no =no;

}publicString getName() {returnname;

}public voidsetName(String name) {this.name =name;

}publicInteger getAge() {returnage;

}public voidsetAge(Integer age) {this.age =age;

}

@OverridepublicString toString() {return "StudentDefinition{" +

"no=" + no +

", name='" + name + '\'' +

", age=" + age +

'}';

}

}

测试

@Testpublic void testAnnotationRule() throwsException {

Digester digester= DigesterLoader.newLoader(newFromAnnotationsRuleModule() {

@Overrideprotected voidconfigureRules() {//这里只添加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);

}