java解析XML映射成对象实体

 

1.创建一个XML文件：config.xml

<?xml version="1.0" encoding="utf-8"?>
<root >

    <school name="第一初级中学" description="学校信息">
        <grade name="九年级" description="年级信息" >
            <classes name="一班" description="班级信息" master="张非" studentCount="40" />
            <classes name="二班" description="班级信息" master="李亏" studentCount="38" />
            <classes name="三班" description="班级信息" master="关雨" studentCount="39" />
            <classes name="四班" description="班级信息" master="赵芸" studentCount="41" />
        </grade>
    </school>

    <school name="第二初级中学" description="学校信息">
        <grade name="九年级" description="年级信息" >
            <classes name="一班" description="班级信息" master="张非" studentCount="40" />
            <classes name="二班" description="班级信息" master="李亏" studentCount="38" />
            <classes name="三班" description="班级信息" master="关雨" studentCount="39" />
            <classes name="四班" description="班级信息" master="赵芸" studentCount="41" />
        </grade>
    </school>

</root>

 

2.写一个解析工具类:XMLUtil.java

package org.example.util;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.Unmarshaller;
import java.io.*;

/**
 * 将XML转换成Object
 */
public class XMLUtil {

    /**
     * 将String类型的xml转换成对象
     */
    public static Object convertXmlStrToObject(Class<?> clazz, String xmlStr) {
        Object xmlObject = null;
        try {
            JAXBContext context = JAXBContext.newInstance(clazz);
            // 进行将Xml转成对象的核心接口
            Unmarshaller unmarshal = context.createUnmarshaller();
            StringReader sr = new StringReader(xmlStr);
            xmlObject = unmarshal.unmarshal(sr);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return xmlObject;
    }

    /**
     * 将file类型的xml转换成对象
     */
    public static Object convertXmlFileToObject(Class<?> clazz, String xmlPath) {
        Object xmlObject = null;
        try {
            JAXBContext context = JAXBContext.newInstance(clazz);
            Unmarshaller unmarshaller = context.createUnmarshaller();
            InputStreamReader isr=new InputStreamReader(new FileInputStream(xmlPath),"UTF-8");
            xmlObject = unmarshaller.unmarshal(isr);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return xmlObject;
    }

}

 

3.按照XML结构，写出将要映射的实体类：

　　1）Root.java

package org.example.entity;

import lombok.Data;

import javax.xml.bind.annotation.XmlRootElement;
import java.util.List;

@Data
//注解用于标记当前类是XML的根节点，name值为根节点名
@XmlRootElement(name = "root")
public class Root {

    /**
     * 注意：属性名称要跟xml节点名统一
     */
    private List<School> school;

}

　　2）School.java

package org.example.entity;

import lombok.Setter;

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlTransient;
import java.util.List;

@Setter
public class School {

    /**
     *  注解 @XmlAttribute 表示该属性是XML节点的属性
     */
    @XmlAttribute
    private String name;
    @XmlAttribute
    private String description;


    private List<Grade> grade;

    /**
     * @XmlTransient 注解解决 JavaBean 属性名称与字段名称之间的名称冲突
     * @return
     */
    @XmlTransient
    public String getName() {
        return name;
    }

    @XmlTransient
    public String getDescription() {
        return description;
    }

    public List<Grade> getGrade() {
        return grade;
    }

    @Override
    public String toString() {
        return "School{" +
                "name='" + name + '\'' +
                ", description='" + description + '\'' +
                ", grade=" + grade +
                '}';
    }
}

 

　　3）Grade.java

package org.example.entity;

import lombok.Setter;

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlTransient;
import java.util.List;

@Setter
public class Grade {

    @XmlAttribute
    private String name;
    @XmlAttribute
    private String description;

    private List<Classes> classes;

    @XmlTransient
    public String getName() {
        return name;
    }

    @XmlTransient
    public String getDescription() {
        return description;
    }

    public List<Classes> getClasses() {
        return classes;
    }

    @Override
    public String toString() {
        return "Grade{" +
                "name='" + name + '\'' +
                ", description='" + description + '\'' +
                ", classes=" + classes +
                '}';
    }
}

 

　　4）Classes.java

package org.example.entity;

import lombok.Setter;

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlTransient;

@Setter
public class Classes {

    @XmlAttribute
    private String name;
    @XmlAttribute
    private String master;
    @XmlAttribute
    private String description;
    @XmlAttribute
    private Integer studentCount;

    @XmlTransient
    public String getName() {
        return name;
    }

    @XmlTransient
    public String getMaster() {
        return master;
    }

    @XmlTransient
    public Integer getStudentCount() {
        return studentCount;
    }

    @XmlTransient
    public String getDescription() {
        return description;
    }

    @Override
    public String toString() {
        return "Classes{" +
                "name='" + name + '\'' +
                ", master='" + master + '\'' +
                ", description='" + description + '\'' +
                ", studentCount=" + studentCount +
                '}';
    }
}

 

4.编写一个测试类

package org.example;

import org.example.entity.Root;
import org.example.util.XMLUtil;

public class Test {

    public static void main(String[] args) {

        String path = "config.xml";
        Root root = (Root) XMLUtil.convertXmlFileToObject(Root.class, path);
        System.out.println(root);

    }
}

 

5.文件结构

　　

 

 

 

 

附：lambok 引用

    <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.18.20</version>
      <scope>provided</scope>
    </dependency>