JAXB 深入显出 - JAXB 教程 简单转化案例

摘要： JAXB 作为JDK的一部分，能便捷地将Java对象与XML进行相互转换，本教程从实际案例出发来讲解JAXB 2 的那些事儿。完整版目录

Java 对象转 XML

首先定义需要转换的 Java bean：Student.java

@XmlRootElement
public class Student {
    private String id;
    private String name;
    private Integer age;
 // setters, getters
}

就是这么简单，只需要在普通的Java类上添加注解@XmlRootElement。
这里有几点需要注意：

• JAXB 转换对象必须属于JAXBElement类型，或者使用 @XmlRootElement注解
• JAXB 转换对象必须拥有无参数构造器（默认存在，如果被覆盖，需要显示指定）

    public static void javaToxml(Student stu) throws Exception {
        // 获取JAXB的上下文环境，需要传入具体的 Java bean -> 这里使用Student
        JAXBContext context = JAXBContext.newInstance(Student.class);
        // 创建 Marshaller 实例
        Marshaller marshaller = context.createMarshaller();
        // 设置转换参数 -> 这里举例是告诉序列化器是否格式化输出
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);
        // 构建输出环境 -> 这里使用标准输出，输出到控制台Console
        PrintStream out = System.out;
        // 将所需对象序列化 -> 该方法没有返回值
        marshaller.marshal(stu, out);
    }

这里演示了最基本的Java 对象转XML过程。为了方便阅读，每一步都有简明注释。

使用 JAXB 不需要引入第三方依赖jar包。

public static void main(String[] args) throws Exception {
        Student stu = new Student("001","Tom",22);
        javaToxml(stu);
}

使用main方法简单测试一下，在控制台可以看到如下输出。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<student>
    <age>22</age>
    <id>001</id>
    <name>Tom</name>
</student>

XML 转 Java 对象

Java bean 对象依然使用Student.java。

public static void xmlTojava() throws Exception {
        // 获取JAXB的上下文环境，需要传入具体的 Java bean -> 这里使用Student
        JAXBContext context = JAXBContext.newInstance(Student.class);
        // 创建 UnMarshaller 实例
        Unmarshaller unmarshaller = context.createUnmarshaller();
        // 加载需要转换的XML数据 -> 这里使用InputStream，还可以使用File，Reader等
        InputStream stream = SimpleTest.class.getClassLoader().getResourceAsStream("lesson1.xml");
        // 将XML数据序列化 -> 该方法的返回值为Object基类，需要强转类型
        Student stu = (Student) unmarshaller.unmarshal(stream);
        // 将结果打印到控制台
        System.out.println(stu);
    }

这里演示了最基本的XML数据转换为Java 对象的过程。为了方便阅读，每一步都有简明注释。

所需的lesson1.xml文件如下：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<student>
    <age>22</age>
    <id>001</id>
    <name>Tom</name>
</student>

其实就是上一步输出的数据。

    public static void main(String[] args) throws Exception {
        xmlTojava();
    }

使用main方法简单测试一下，在控制台可以看到如下输出。

Student [id=001, name=Tom, age=22]

完整代码

可以在GitHub找到完整代码。

下节预览

本节基于简单的JAXB 代码，直观体验的JAXB的转换过程。下一节将着重介绍注解在转换过程的使用情形。