解析XML之Digester

本文讲解,如何使用Digester将XML文档和Java对象映射，主要以撸代码为主。

引入 Maven pom依赖：

       <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-digester3</artifactId>
            <version>3.2</version>
            <classifier>with-deps</classifier>
        </dependency>

现有XML文件books.xml，其文件内容如下：<br >

<?xml version="1.0" encoding="utf-8" ?>
<books>
    <book name="水浒传">
        <author>
            <name>施耐庵</name>
            <name>罗贯中</name>
        </author>
        <creationDate>元末明初</creationDate>
        <byname>
            <name>水浒</name>
            <name>忠义水浒传</name>
        </byname>
        <literaryStyle>小说</literaryStyle>
    </book>
    <book name="西游记">
        <author>
            <name>吴承恩</name>
        </author>
        <creationDate>明朝</creationDate>
        <byname>
            <name>西游释厄传</name>
        </byname>
        <literaryStyle>
            浪漫主义章回体长篇神魔小说
        </literaryStyle>
    </book>
    <book name="红楼梦">
        <author>
            <name>曹雪芹</name>
            <name>程伟元</name>
            <name>高鹗</name>
        </author>
        <creationDate>18世纪中叶</creationDate>
        <byname>
            <name>石头记</name>
            <name>情僧录</name>
            <name>风月宝鉴</name>
            <name>金陵十二钗</name>
            <name>金玉缘</name>
        </byname>
        <literaryStyle>
            章回体长篇小说
        </literaryStyle>
    </book>
</books>

本文提供两种将XML映射成Java对象的方式，分别是使用注解和是不使用注解。

1.映射方式一不使用注解

创建对象用来装载XML文档中的内容：
1、Name.java，用来存放books/book/byname/name标签中的内容。

public class Name {
    private String name;

    public String getName() {
        return name;
    }

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

2、Byname.java，用来存放books/book/byname/name标签集合。

public class Byname {
    private List<Name> name;
    public List<Name> getName() {
        return name;
    }
    public void setName(List<Name> name) {
        this.name = name;
    }
    /**
    */
    public void addByname(Name name){
        if(name==null){
            return;
        }
        if(this.name==null){
            this.name = new ArrayList<>();
        }
        this.name.add(name);
    }
}

3、AuthorName.java，用来存放books/book/author/name标签中的内容。

public class AuthorName {
    private String name;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}

4、Author.java，用来存放books/book/author/name标签集合

public class Author {
    private List<AuthorName> names;
    public List<AuthorName> getNames() {
        return names;
    }
    public void setNames(List<AuthorName> names) {
        this.names = names;
    }
    public void addAuthorName(AuthorName name) {
        if (name == null) {
            return;
        }
        if (this.names == null) {
            this.names = new ArrayList<>();
        }
        this.names.add(name);
    }
}

5、Book.java，用来存放books/book标签中的内容

public class Book {
    private Author author;
    private Byname byname;
    private String creationDate;
    private String literaryStyle;
    private String name;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Byname getByname() {
        return byname;
    }
    public void setByname(Byname byname) {
        this.byname = byname;
    }
    public Author getAuthor() {
        return author;
    }
    public void setAuthor(Author author) {
        this.author = author;
    }
    public String getCreationDate() {
        return creationDate;
    }
    public void setCreationDate(String creationDate) {
        this.creationDate = creationDate;
    }
    public String getLiteraryStyle() {
        return literaryStyle;
    }
    public void setLiteraryStyle(String literaryStyle) {
        this.literaryStyle = literaryStyle;
    }
    public void addByname(Byname byname){
        this.byname = byname;
    }
    public void addAuthor(Author author){
        this.author = author;
    }
}

6、Books.java，用来存放books/book标签集。

public class Books {
    private List<Book> bookList;
    public List<Book> getBookList() {
        return bookList;
    }
    public void setBookList(List<Book> bookList) {
        this.bookList = bookList;
    }
    public void addBooks(Book book) {
        if (book == null) {
            return;
        }
        if (this.bookList == null) {
            this.bookList = new ArrayList<>();
        }
        this.bookList.add(book);
    }
}

7、Test1.java，生成映射XML文档到Java对象和测试

public class Test1 {

    public static Books parseXml(File xmlFile) throws IOException, SAXException {
        Digester digester = new Digester();
        digester.setValidating(false);
        //跟标签/books和Books对象映射
        digester.addObjectCreate("books", Books.class);

        //标签/books/book和Book对象映射
        digester.addObjectCreate("books/book", Book.class);

        //将/books/book标签的所有属性映射到Book对象的属性上，在这里映射的是/books/book标签的name属性。
        digester.addSetProperties("books/book");
        //或者使用下面这种方式代替，digester.addSetProperties("books/book");这种方式要求标签属性名和对象中的字段要保持命名一致才可以映射上。
//        digester.addSetProperties("books/book","name","name");

        //标签books/book/creationDate，和Book对象的creationDate属性映射
        digester.addBeanPropertySetter("books/book/creationDate", "creationDate");
        //标签books/book/literaryStyle，和Book对象的literaryStyle属性映射
        digester.addBeanPropertySetter("books/book/literaryStyle", "literaryStyle");

        //标签books/book/author和Author对象映射
        digester.addObjectCreate("books/book/author", Author.class);

        //标签books/book/author/name和AuthorName对象映射
        digester.addObjectCreate("books/book/author/name", AuthorName.class);
        //标签books/book/author/name，和AuthorName对象的name属性映射
        digester.addBeanPropertySetter("books/book/author/name", "name");

        //标签books/book/byname和Byname对象映射
        digester.addObjectCreate("books/book/byname", Byname.class);
        //标签books/book/byname/name和Name对象映射
        digester.addObjectCreate("books/book/byname/name", Name.class);
        //标签books/book/byname/name，和Byname对象的name属性映射
        digester.addBeanPropertySetter("books/book/byname/name", "name");

        //把Book标签对象添加到Book对象中，需要保证Books对象中有addBooks该方法，用于添加装载XML标签内容后的对象信息
        digester.addSetNext("books/book", "addBooks");
        //把Author标签对象和Byname标签对象添加到Book对象中，需要保证Book对象中有addAuthor和addByname方法，用于添加装载XML标签内容后的对象信息
        digester.addSetNext("books/book/author", "addAuthor");
        digester.addSetNext("books/book/byname", "addByname");

        //把Name标签对象添加到Byname对象中，需要保证Byname对象中有addByname方法（命名任意，只需要对应上即可），用于添加装载XML标签内容后的对象信息
        digester.addSetNext("books/book/byname/name", "addByname");
        //把AuthorName标签对象添加到Author对象中，需要保证Author对象中有addAuthorName方法（命名任意，只需要对应上即可），用于添加装载XML标签内容后的对象信息
        digester.addSetNext("books/book/author/name", "addAuthorName");
        Object obj = digester.parse(xmlFile);
        if (obj instanceof Books) {
            return (Books) obj;
        }
        return null;
    }

    public static void main(String[] args) throws IOException, SAXException {
        String baseDir = System.getProperty("user.dir");
        File xmlFile = new File(baseDir + "/src/main/resources/books.xml");
        Books books = parseXml(xmlFile);
    }
}

2.映射方式二使用注解

Digester3根据注解来映射Java对象和XML文档，在方式一的基础上的对象添加注解即可，具体如下：
1、Name.java，用来存放books/book/byname/name标签中的内容。

//books/book/byname/name标签和Name对象映射
@ObjectCreate(pattern = "books/book/byname/name")
public class Name {
    //books/book/byname/name标签内容和AuthorName的name属性映射
    @BeanPropertySetter(pattern = "books/book/byname/name")
    private String name;

    public String getName() {
        return name;
    }

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

2、Byname.java，用来存放books/book/byname/name标签集合。

//books/book/byname标签和Byname对象映射
@ObjectCreate(pattern = "books/book/byname")
public class Byname {

    private List<Name> name;

    public List<Name> getName() {
        return name;
    }

    public void setName(List<Name> name) {
        this.name = name;
    }

    //将books/book/byname/name标签的内容对象添加到Byname对象中
    @SetNext
    public void addByname(Name name){
        if(name==null){
            return;
        }
        if(this.name==null){
            this.name = new ArrayList<>();
        }
        this.name.add(name);
    }
}

3、AuthorName.java，用来存放books/book/author/name标签中的内容。

//books/book/author/anme标签和AuthorName对象映射
@ObjectCreate(pattern = "books/book/author/name")
public class AuthorName {
    @BeanPropertySetter(pattern = "books/book/author/name")
    private String name;

    public String getName() {
        return name;
    }

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

4、Author.java，用来存放books/book/author/name标签中的内容。

//books/book/author标签和Author对象映射
@ObjectCreate(pattern = "books/book/author")
public class Author {
    private List<AuthorName> names;

    public List<AuthorName> getNames() {
        return names;
    }

    public void setNames(List<AuthorName> names) {
        this.names = names;
    }
    //将books/book/author/name标签的内容对象添加到Author对象中
    @SetNext
    public void addAuthorName(AuthorName name) {
        if (name == null) {
            return;
        }
        if (this.names == null) {
            this.names = new ArrayList<>();
        }
        this.names.add(name);
    }
}

5、Book.java，用来存放books/book标签中的内容

//books/book标签和Book对象映射
@ObjectCreate(pattern = "books/book")
public class Book {

    private Author author;

    private Byname byname;

    //books/book/creationDate标签内容和Book的creationDate属性映射
    @BeanPropertySetter(pattern = "books/book/creationDate")
    private String creationDate;
    //books/book/literaryStyle标签内容和Book的literaryStyle属性映射
    @BeanPropertySetter(pattern = "books/book/literaryStyle")
    private String literaryStyle;
    //将/books/book标签的所有属性映射到Book对象的属性上，在这里映射的是/books/book标签的name属性。
    @SetProperty(pattern = "books/book")
    private String name;

    public String getName() {
        return name;
    }

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

    public Byname getByname() {
        return byname;
    }

    public void setByname(Byname byname) {
        this.byname = byname;
    }

    public Author getAuthor() {
        return author;
    }

    public void setAuthor(Author author) {
        this.author = author;
    }

    public String getCreationDate() {
        return creationDate;
    }

    public void setCreationDate(String creationDate) {
        this.creationDate = creationDate;
    }

    public String getLiteraryStyle() {
        return literaryStyle;
    }

    public void setLiteraryStyle(String literaryStyle) {
        this.literaryStyle = literaryStyle;
    }

    //将books/book/byname标签的内容对象添加到Book对象中
    @SetNext
    public void addByname(Byname byname){
        this.byname = byname;
    }
    //将books/book/author标签的内容对象添加到Book对象中
    @SetNext
    public void addAuthor(Author author){
        this.author = author;
    }
}

6、Books.java，用来存放books/book标签集。

//books标签和Books对象映射
@ObjectCreate(pattern = "books")
public class Books {

    private List<Book> bookList;

    public List<Book> getBookList() {
        return bookList;
    }

    public void setBookList(List<Book> bookList) {
        this.bookList = bookList;
    }
    //将books/book标签的内容对象添加到Books对象中
    @SetNext
    public void addBooks(Book book) {
        if (book == null) {
            return;
        }
        if (this.bookList == null) {
            this.bookList = new ArrayList<>();
        }
        this.bookList.add(book);
    }
}

7、Test2.java测试Digester3注解映射XML和Java对象。

public class Test2 {

    public static Books readBooks(File xmlPath, Class<?> XmlClazz) throws IOException, SAXException {
        Digester digester = getLoader(XmlClazz).newDigester();
        return digester.parse(xmlPath);
    }

    public static DigesterLoader getLoader(final Class<?> XmlClazz) {
        return newLoader(new FromAnnotationsRuleModule() {
            @Override
            protected void configureRules() {
                bindRulesFrom(XmlClazz);
            }
        });
    }

    public static void main(String[] args) throws IOException, SAXException {
        String baseDir = System.getProperty("user.dir");
        File xmlFile = new File(baseDir + "/src/main/resources/books.xml");
        Books books = readBooks(xmlFile, Books.class);
    }

}

最后编辑于：2017.12.09 02:38:30

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 213,047评论 6赞 492
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 90,807评论 3赞 386
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 158,501评论 0赞 348
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 56,839评论 1赞 285
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 65,951评论 6赞 386
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 50,117评论 1赞 291
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 39,188评论 3赞 412
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 37,929评论 0赞 268
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 44,372评论 1赞 303
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 36,679评论 2赞 327
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 38,837评论 1赞 341
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 34,536评论 4赞 335
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 40,168评论 3赞 317
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 30,886评论 0赞 21
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 32,129评论 1赞 267
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 46,665评论 2赞 362
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 43,739评论 2赞 351

解析XML之Digester

1.映射方式一不使用注解

2.映射方式二使用注解

推荐阅读更多精彩内容