如何用Java将POJO序列化为XML JAXB Marshalling

Java中JAXB序列化POJO为XML需三步:1. 为POJO添加@XmlRootElement等注解;2. 创建JAXBContext并配置Marshaller;3. 调用marshal方法输出XML,注意JDK11+需引入jakarta.xml.bind依赖。

Java中用JAXB将POJO序列化为XML(即Marshalling)需要三步:添加注解、创建JAXBContext、调用marshal方法。核心是让JAXB知道如何把对象映射成XML结构。

1. 为POJO添加JAXB注解

POJO类必须标注@XmlRootElement,否则JAXB无法启动序列化。常用注解包括:

  • @XmlRootElement:标记类为XML根元素(必加)
  • @XmlElement:控制字段名、是否必需、默认值等
  • @XmlAttribute:将字段映射为XML属性而非子元素
  • @XmlAccessorType(XmlAccessType.FIELD):直接访问字段(避免写getter/setter)

示例POJO:

@XmlRootElement(name = "person")
@XmlAccessorType(XmlAccessType.FIELD)
public class Person {
    @XmlElement(required = true)
    private String name;
    @XmlElement(name = "age")
    private int age;
    @XmlAttribute
    private String id;

    // 无参构造函数(JAXB要求)
    public Person() {}

    public Person(String name, int age, String id) {
        this.name = name;
        this.age = age;
        this.id = id;
    }
}

2. 创建JAXBContext并获取Marshaller

JAXBContext是JAXB操作的入口,需传入POJO类(支持多个类,用逗号分隔)。Marshaller负责执行序列化:

  • 设置Marshaller.JAXB_FORMATTED_OUTPUT为true可生成缩进格式化XML
  • 可设置编码(如UTF-8),避免中文乱码
  • 支持输出到File、OutputStream、Writer、DOM Node等多种目标

基础代码示例:

Person person = new Person("张三", 28, "P001");

try {
    JAXBContext context = JAXBContext.newInstance(Person.class);
    Marshaller marshaller = context.createMarshaller();
    
    marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
    marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8");
    
    // 输出到控制台
    marshaller.marshal(person, System.out);
    
    // 或输出到文件
    // marshaller.marshal(person, new File("person.xml"));
} catch (JAXBException e) {
    e.printStackTrace();
}

3. 处理常见问题

实际使用中容易遇到几个典型问题:

  • “class not known to this context”:检查是否漏了@XmlRootElement,或JAXBContext.newInstance()参数没包含该类
  • 中文乱码:确保设置了JAXB_ENCODING,且输出目标(如FileWriter)也指定UTF-8
  • 空字段不输出:默认null或0值字段仍会输出(值为空标签或0)。可用@XmlElement(nillable = true)配合xsi:nil,或自定义XmlAdapter过滤
  • 集合类型:List字段需用@XmlElement包裹,JAXB自动处理为多个同名子元素

4. 简化方式:使用JAXBUtil工具类(可选)

若项目中频繁使用,可封装一个静态工具方法,隐藏重复逻辑:

public class JAXBUtil {
    public static  String toXml(T obj) throws JAXBException {
        JAXBContext context = JAXBContext.newInstance(obj.getClass());
        Marshaller m = context.createMarshaller();
        m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        m.setProperty(Marshaller.JAXB_ENCODING, "UTF-8");
        
        StringWriter writer = new StringWriter();
        m.marshal(obj, writer);
        return writer.toString();
    }
}

调用:String xml = JAXBUtil.toXml(new Person("李四", 30, "P002"));

注意:JDK 11+已移除JAXB内置支持,需显式添加Maven依赖:


    jakarta.xml.bind
    jakarta.xml.bind-api
    4.0.0


    org.glassfish.jaxb
    jaxb-runtime
    4.0.3