Digester解析xml文件

XML 前端之家
前端之家收集整理的这篇文章主要介绍了Digester解析xml文件，前端之家小编觉得挺不错的，现在分享给大家，也给大家做个参考。

刚刚学了一下Digester如何解析xml文件，所以记录下来，方便以后查看。

一般用来读取xml文件的工具包有DOM、SAX和JDOM等，但用过的人都知道，它们属于比较底层的API，写起来代码量很大，而且如果修改了xml文件的格式，代码也要做大幅度的改动。而使用Apache Jakarta的Digester，解析XML文件非常方便且不需要过多的关心底层的具体解析过程。Digester本来仅仅是Jakarta Struts中的一个工具，用于处理struts-config.xml配置文件。显然，将XML文件转换成相应的Java对象是一项很通用的功能，这个工具理应具有更广泛的用途，所以很快它就在Jakarta Commons项目(用于提供可重用的Java组件库)中有了一席之地。Digester由"事件"驱动，通过调用预定义的规则操作对象栈，将XML文件转换为Java对象。

工作原理如下: Digester底层采用SAX(Simple API for XML)析XML文件，所以很自然的，对象转换由"事件"驱动，在遍历每个节点时，检查是否有匹配模式，如果有，则执行规则定义的操作，比如创建特定的Java对象，或调用特定对象的方法等。此处的XML元素根据匹配模式(matching pattern)识别，而相关操作由规则(rule)定义。

如下xml代码，右边是左边元素对应的匹配模式：

[xhtml] view plain copy
  1. <datasources>'datasources'
  2. <datasource>'datasources/datasource'
  3. <name/>'datasources/datasource/name'
  4. <driver/>'datasources/datasource/driver'
  5. </datasource>
  6. <datasource>'datasources/datasource'
  7. <name/>'datasources/datasource/name'
  8. <driver/>'datasources/datasource/driver'
  9. </datasource>
  10. </datasources>

例子1：

下面介绍解析xml文件的代码

下面是存放地址及编码的xml文件viewcache.xml(片段)：

[xhtml] view plain copy
  1. <?xmlversion="1.0"encoding="UTF-8"?>
  2. <viewcache>
  3. <areas>
  4. <area>
  5. <id>1098</id>
  6. <parentId>1001</parentId>
  7. <areaType>province</areaType>
  8. <name>北京</name>
  9. <ordering>1867</ordering>
  10. </area>
  11. <area>
  12. <id>1099</id>
  13. <parentId>1098</parentId>
  14. <areaType>capital</areaType>
  15. <name>北京</name>
  16. <ordering>1868</ordering>
  17. <phoneArea>010</phoneArea>
  18. </area>
  19. <area>
  20. <id>4476</id>
  21. <parentId>1099</parentId>
  22. <areaType>county</areaType>
  23. <name>北京市朝阳区</name>
  24. <ordering>1869</ordering>
  25. <phoneArea>010</phoneArea>
  26. </area>
  27. <area>
  28. <id>4477</id>
  29. <parentId>1099</parentId>
  30. <areaType>county</areaType>
  31. <name>北京市崇文区</name>
  32. <ordering>1870</ordering>
  33. <phoneArea>010</phoneArea>
  34. </area>
  35. <area>
  36. <id>4478</id>
  37. <parentId>1099</parentId>
  38. <areaType>county</areaType>
  39. <name>北京市大兴区</name>
  40. <ordering>1871</ordering>
  41. <phoneArea>010</phoneArea>
  42. </area>
  43. </areas>
  44. </viewcache>

此xml文件分3层结构，分别为：

<viewcache>节点 其下包含1个<areas>节点

<areas>节点 其下包含多个<area>节点

<area>节点，其下包含各种信息节点 ： 如：<id> 、<name>等。

我们的操作目标是把area中的信息节点的内容提取出来。
把每个<arrea>看做为一个对象，<area>中信息节点的内容为对象中的元素。
设定一个类Area.java 其内容如下：

[java] view plain copy
  1. publicclassArea{
  2. privateintid;
  3. privateStringname;
  4. privateStringareaType;
  5. privateintparentId;
  6. privateintordering;
  7. privateStringzip;
  9. privateStringphoneArea;
  11. publicintgetOrdering(){
  12. returnordering;
  13. }
  14. publicvoidsetOrdering(intordering){
  15. this.ordering=ordering;
  16. }
  17. publicStringgetAreaType(){
  18. returnareaType;
  19. }
  20. publicvoidsetAreaType(StringareaType){
  21. this.areaType=areaType;
  22. }
  23. publicintgetId(){
  24. returnid;
  25. }
  26. publicvoidsetId(intid){
  27. this.id=id;
  28. }
  29. publicStringgetName(){
  30. returnname;
  31. }
  32. publicvoidsetName(Stringname){
  33. this.name=name;
  34. }
  35. publicintgetParentId(){
  36. returnparentId;
  37. }
  38. publicvoidsetParentId(intparentId){
  39. this.parentId=parentId;
  40. }
  42. publicStringgetZip(){
  43. returnzip;
  44. }
  46. publicvoidsetZip(Stringzip){
  47. this.zip=zip;
  48. }
  50. publicStringgetPhoneArea(){
  51. returnphoneArea;
  52. }
  54. publicvoidsetPhoneArea(StringphoneArea){
  55. this.phoneArea=phoneArea;
  56. }
  57. }

创建一个ViewCache类，用来保存解析后的所有对象：

[java] view plain copy
  1. publicclassViewCache{
  2. privateListareaList=newArrayList();
  3. publicListgetAreaList(){
  4. returnareaList;
  5. }
  6. publicvoidsetAreaList(ListareaList){
  7. this.areaList=areaList;
  8. }
  10. //供Digester调用的方法
  11. publicvoidaddArea(Areaarea){
  12. this.areaList.add(area);
  13. }
  14. }

创建一个类AreaDigester，对xml文件进行解析：

[java] view plain copy
  1. publicclassAreaDigester{
  3. publicViewCachedigester()throwsException{
  4. Digesterdigester=newDigester();
  5. digester.setValidating(false);
  6. digester.addObjectCreate("viewcache/areas",ViewCache.class);
  7. //指明匹配模式和要创建的类
  8. digester.addObjectCreate("viewcache/areas/area",Area.class);
  9. //设置对象属性,与xml文件对应,不设置则是默认
  10. digester.addBeanPropertySetter("viewcache/areas/area/id","id");
  11. digester.addBeanPropertySetter("viewcache/areas/area/parentId","parentId");
  12. digester.addBeanPropertySetter("viewcache/areas/area/name","name");
  13. digester.addBeanPropertySetter("viewcache/areas/area/areaType","areaType");
  14. digester.addBeanPropertySetter("viewcache/areas/area/ordering","ordering");
  15. digester.addBeanPropertySetter("viewcache/areas/area/zip","zip");
  16. digester.addBeanPropertySetter("viewcache/areas/area/phoneArea","phoneArea");
  17. //当移动到下一个标签中时的动作
  18. digester.addSetNext("viewcache/areas/area","addArea");
  20. ViewCachevc=null;
  21. try{
  22. vc=(ViewCache)digester.parse("viewcache.xml");
  23. }catch(IOExceptione){
  24. thrownewException(e);
  25. }catch(SAXExceptione){
  26. thrownewException(e);
  27. }
  28. returnvc;
  29. }
  30. }

调用AreaDigester的digester方法，即可把解析后的所有地址对象，存放在ViewCache的list中。

例子2：

要解析的xml文件books.xml如下：

[xhtml] view plain copy
  1. <?xmlversion="1.0"encoding="UTF-8"?>
  2. <libraryname="alibaba图书馆">
  3. <booktitle="thinkinginjava"author="xxx">
  4. <chapter>
  5. <no>第一章</no>
  6. <caption>第一章的标题</caption>
  7. </chapter>
  8. <chapter>
  9. <no>第二章</no>
  10. <caption>第二章的标题</caption>
  11. </chapter>
  12. </book>
  13. <booktitle="effectivejava"author="yyy">
  14. <chapter>
  15. <no>第一章</no>
  16. <caption>第一章的标题</caption>
  17. </chapter>
  18. </book>
  19. </library>

Library类如下：

[java] view plain copy
  1. publicclassLibrary{
  2. privateStringname;
  3. privateList<Book>bookList=newArrayList<Book>();
  5. publicStringgetName(){
  6. returnname;
  7. }
  9. publicvoidsetName(Stringname){
  10. this.name=name;
  11. }
  13. publicList<Book>getBookList(){
  14. returnbookList;
  15. }
  17. publicvoidaddBook(Bookbook){
  18. bookList.add(book);
  19. }
  20. }

Book类如下：

[java] view plain copy
  1. publicclassBook{
  3. privateStringtitle;
  4. privateStringauthor;
  5. privateList<Chapter>chapters=newArrayList<Chapter>();
  7. /**
  8. *这个方法，用来演示xml的解析时用的另一种方式
  9. *@paramtitle
  10. *@paramauthor
  11. */
  12. publicvoidsetBookInfo(Stringtitle,Stringauthor){
  13. this.title=title;
  14. this.author=author;
  15. }
  17. publicvoidaddChapter(Chapterchapter){
  18. this.chapters.add(chapter);
  19. }
  21. publicStringgetTitle(){
  22. returntitle;
  23. }
  25. publicvoidsetTitle(Stringtitle){
  26. this.title=title;
  27. }
  29. publicStringgetAuthor(){
  30. returnauthor;
  31. }
  33. publicvoidsetAuthor(Stringauthor){
  34. this.author=author;
  35. }
  37. publicList<Chapter>getChapters(){
  38. returnchapters;
  39. }
  41. publicvoidsetChapters(List<Chapter>chapters){
  42. this.chapters=chapters;
  43. }
  44. }

Chapter类如下：

[java] view plain copy
  1. publicclassChapter{
  3. privateStringno;
  4. privateStringcaption;
  6. publicStringgetNo(){
  7. returnno;
  8. }
  10. publicvoidsetNo(Stringno){
  11. this.no=no;
  12. }
  14. publicStringgetCaption(){
  15. returncaption;
  16. }
  18. publicvoidsetCaption(Stringcaption){
  19. this.caption=caption;
  20. }
  21. }

解析xml的类如下：

[java] view plain copy
  1. publicclassMainTest{
  3. /**
  4. *@paramargs
  5. */
  6. publicstaticvoidmain(String[]args){
  7. //建立一个Digester对象
  8. Digesterdigester=newDigester();
  9. //指定它不要用DTD验证XML文档的合法性——这是因为我们没有为XML文档定义DTD
  10. digester.setValidating(false);
  11. //从library标签开始解析,并新建一个Library对象做为根对象
  12. digester.addObjectCreate("library",Library.class);
  13. //根据library标签属性值设置对象的属性,一次可以设置多个属性
  14. digester.addSetProperties("library");
  15. //也可以用下面的方法，指定propertyName
  16. //digester.addSetProperties("library","name","name");
  18. //-----第1层元素开始
  19. digester.addObjectCreate("library/book",Book.class);
  20. //digester.addSetProperties("library/book");
  21. //可以用以下三条语句代替
  22. digester.addCallMethod("library/book","setBookInfo",2);
  23. digester.addCallParam("library/book",0,"title");
  24. digester.addCallParam("library/book",1,"author");
  25. /**
  26. *addCallParam(Stringrule,intparaIndex,StringattributeName)
  27. *该方法与addCallMethod配合使用
  28. *intparaIndex:表明需要填充的方法形参序号,从0开始,方法由addCallMethod指定
  29. *StringattributeName:指定标签属性名称
  30. */
  33. //-----第2层元素开始
  34. digester.addObjectCreate("library/book/chapter",Chapter.class);
  35. /**addBeanPropertySetter()是将子节点转换为对象的属性，这个方法还可以有第二个参数，当对象的属性名和子节点的名字不一样时用来指定对象的属性名
  36. 该方法的作用及使用方法类似于addSetProperties,只不过它是用Stringrule规则所指定标签的值(而不是标签的属性)来调用对象的setter*/
  37. digester.addBeanPropertySetter("library/book/chapter/no");
  38. //digester.addBeanPropertySetter("library/book/chapter/no","no");
  40. /**addCallMethod(Stringrule,StringmethodName,intparaNumber)方法
  41. *同样是设置对象的属性,但是方式更加灵活,不需要对象具有setter
  42. *当paraNumber=0时,可以单独使用(表明为标签的值来调用),不然需要配合addCallParam方法
  43. */
  44. //digester.addBeanPropertySetter("library/book/chapter/caption");
  45. //下面的方法，可以用来代替上一句，作用是一样的
  46. digester.addCallMethod("library/book/chapter/caption","setCaption",0);
  48. //addSetNext()是说在再次遇到匹配节点后，调用当前对象(Chapter类的对象)的父对象(Book类的对象)的方法，方法参数是当前层元素的对象
  49. digester.addSetNext("library/book/chapter","addChapter");
  50. //-----第2层元素结束
  52. digester.addSetNext("library/book","addBook");
  53. //-----第1层元素结束
  55. try{
  56. //解析XML文件,并得到ROOT元素
  57. Librarylibrary=(Library)digester.parse(MainTest.class.getResourceAsStream("books.xml"));
  58. System.out.println("图书馆:"+library.getName());
  59. System.out.println("共藏书:"+library.getBookList().size()+"本");
  60. System.out.println("*****************************");
  62. for(Bookbook:library.getBookList()){
  63. System.out.println("书名:"+book.getTitle()+"作者:"+book.getAuthor());
  64. System.out.println("------------------------------");
  65. //显示章节
  66. System.out.println("共"+book.getChapters().size()+"章");
  67. for(Chapterchapter:book.getChapters()){
  68. System.out.println(chapter.getNo()+":"+chapter.getCaption());
  69. }
  70. System.out.println("------------------------------");
  71. }
  72. }catch(IOExceptione){
  73. e.printStackTrace();
  74. }catch(SAXExceptione){
  75. e.printStackTrace();
  76. }
  77. }
  78. }

例子3：

Digester解析xml的规则，除了在java类中描述设置之外，还可以把解析规则放在xml文件中。以例子2中的代码为例，规则在books-rule.xml文件中，内容如下：(The DTD is distributed in thecommons-digester.jar. It can be found atorg/apache/commons/digester/xmlrules/digester-rules.dtd，通过查看DTD文件，可以知道有哪些标签可以使用)

[xhtml] view plain copy
  1. <?xmlversion="1.0"encoding="UTF-8"?>
  2. <!DOCTYPEdigester-rulesPUBLIC
  3. "-//JakartaApache//DTDdigester-rulesXMLV1.0//EN"
  4. "digester-rules.dtd">
  5. <digester-rules>
  6. <object-create-rulepattern="library"classname="com.alibaba.chj.digester.Library"/>
  7. <set-properties-rulepattern="library">
  8. <aliasattr-name="name"prop-name="name"/>
  9. </set-properties-rule>
  10. <patternvalue="library/book">
  11. <object-create-ruleclassname="com.alibaba.chj.digester.Book"/>
  12. <set-properties-rule/>
  13. <patternvalue="chapter">
  14. <object-create-ruleclassname="com.alibaba.chj.digester.Chapter"/>
  15. <bean-property-setter-rulepattern="no"propertyname="no"/>
  16. <bean-property-setter-rulepattern="caption"propertyname="caption"/>
  17. <set-next-rulemethodname="addChapter"/>
  18. </pattern>
  19. <set-next-rulemethodname="addBook"/>
  20. </pattern>
  21. </digester-rules>

解析xml类的代码，修改为：

[java] view plain copy
  1. publicclassMainTest{
  3. /**
  4. *@paramargs
  5. */
  6. publicstaticvoidmain(String[]args){
  7. try{
  8. Digesterdigester=DigesterLoader.createDigester(DigesterXmlRuleTest.class.getResource("books-rule.xml"));
  9. Librarylibrary=(Library)digester.parse(DigesterXmlRuleTest.class.getResourceAsStream("books.xml"));
  10. System.out.println("图书馆:"+library.getName());
  11. System.out.println("共藏书:"+library.getBookList().size()+"本");
  12. System.out.println("*****************************");
  14. for(Bookbook:library.getBookList()){
  15. System.out.println("书名:"+book.getTitle()+"作者:"+book.getAuthor());
  16. System.out.println("------------------------------");
  17. //显示章节
  18. System.out.println("共"+book.getChapters().size()+"章");
  19. for(Chapterchapter:book.getChapters()){
  20. System.out.println(chapter.getNo()+":"+chapter.getCaption());
  21. }
  22. System.out.println("------------------------------");
  23. }
  24. }catch(IOExceptione){
  25. e.printStackTrace();
  26. }catch(SAXExceptione){
  27. e.printStackTrace();
  28. }
  29. }
  30. }

用于规则放在xml文件中，所以解析的类，显得更加简洁一些。

Digester FAQ:http://wiki.apache.org/commons/Digester/FAQ

版权声明：本文为博主原创文章，未经博主允许不得转载。

http://www.jb51.cc/article/p-dthhuuou-tb.html

v

猜你在找的XML相关文章

10分钟掌握XML、JSON及其解析
引言 NOKIA 有句著名的广告语：“科技以人为本”。任何技术都是为了满足人的生产生活需要而...
[CXF REST标准实战系列] 一、JAXB xml与javaBean的转换
Writer：BYSocket（泥沙砖瓦浆木匠） 微博：BYSocket 豆瓣：BYSocket Reprint it anywhere...
[CXF REST标准实战系列] 一、JAXB xml与javaBean的转换
Writer：BYSocket（泥沙砖瓦浆木匠） 微博：BYSocket 豆瓣：BYSocket Reprint it anywhere...
10分钟掌握XML、JSON及其解析
http://blog.jobbole.com/79252/ 引言 NOKIA 有句著名的广告语：“科技以人为本”。任何技...
自定义圆形控件RoundImageView并认识一下attr.xml
(点击上方公众号，可快速关注) 公众号：smart_android 作者：耿广龙｜loonggg 点击“阅读原...
10分钟掌握XML、JSON及其解析
引言 NOKIA 有句著名的广告语：“科技以人为本”。任何技术都是为了满足人的生产生活需要而...
10分钟掌握XML、JSON及其解析(上)
 (点击上方公众号，可快速关注) 来源： Long Luo 的博客 链接：http://longluo.github.i...
10分钟掌握XML、JSON及其解析(中)
接上文 二、JSON XML很好很强大，但是最近有另外一个时代弄潮儿，这就是JSON。现在JSON的光...
10分钟掌握XML、JSON及其解析(下)
接上文 2.4 如何解析JSON？ Android JSON所有相关类，都在org.json包下。 包括JSONObject、...
10分钟掌握XML、JSON及其解析
原文出处：  Long Luo 的博客（@Long_Luo）   引言 NOKIA 有句著名的广告语：“科技以人...
HTMLHTML5JavaScriptCSSjQueryBootstrapAngularjsTypeScriptVueDojoJsonElectronNode.jsextjsExpress XMLES6AjaxFlashUnityReactFlexAnt DesignWeb前端微信小程序微信公众号
关闭广告单独headers封装代码提示错误整数正则非0开头跳页出页码antd table提示URL未注册公众号支付vue hash模式iSlider车牌键盘循环图片echarts 双折左右布局DllPlugin对象创建打字游戏圈选两栏云函数蒙版ES2020橱窗无缝滚动轮播色块碰撞组件销毁文档操作