Java JAXB 生成xml

前言
一提到生成xml,很多人自然而然会想起dom4j。dom4j是可以生成xml,但dom4j需要自己去create。那有木有更简洁的方法,就像注解一样,加个注解,能自动生成xml节点属性and so on。下面,介绍Java一款注解式生成xml的神器：JAXB。

来，看好~~

注解列表

@XmlType
@XmlElement
@XmlRootElement
@XmlAttribute
@XmlAccessorType
@XmlAccessorOrder
@XmlTransient
@XmlJavaTypeAdapter

注解用法详解

• @XmlType

  @XmlType用在class类的注解，常与@XmlRootElement，@XmlAccessorType一起使用。它有三个属性：name、propOrder、namespace，经常使用的只有前两个属性。如：
  @XmlType(name = “basicStruct”, propOrder = {
  “intValue”,
  “stringArray”,
  “stringValue”
  )
  在使用@XmlType的propOrder 属性时，必须列出JavaBean对象中的所有属性，否则会报错。

• @XmlElement

  @XmlElement将java对象的属性映射为xml的节点，在使用@XmlElement时，可通过name属性改变java对象属性在xml中显示的名称。如：
  @XmlElement(name=”Address”)　　
  private String yourAddress;
  　　

• @XmlRootElement
  

  @XmlRootElement用于类级别的注解，对应xml的跟元素，常与 @XmlType 和 @XmlAccessorType一起使用。如：
  　　@XmlType
  　　@XmlAccessorType(XmlAccessType.FIELD)
  　　@XmlRootElement
  　　public class Address {}
  　　

• @XmlAttribute

  @XmlAttribute用于把java对象的属性映射为xml的属性,并可通过name属性为生成的xml属性指定别名。如：
  　　@XmlAttribute(name=”description”)
  　　private String desc;

• @XmlAccessorType

  @XmlAccessorType用于指定由java对象生成xml文件时对java对象属性的访问方式。常与@XmlRootElement、@XmlType一起使用。它的属性值是XmlAccessType的4个枚举值，分　　　别为：
  XmlAccessType.FIELD:java对象中的所有成员变量
  XmlAccessType.PROPERTY：java对象中所有通过getter/setter方式访问的成员变量
  XmlAccessType.PUBLIC_MEMBER：java对象中所有的public访问权限的成员变量和通过getter/setter方式访问的成员变量
  XmlAccessType.NONE:java对象的所有属性都不映射为xml的元素

  注意：@XmlAccessorType的默认访问级别是XmlAccessType.PUBLIC_MEMBER，因此，如果java对象中的private成员变量设置了public权限的getter/setter方法，就不要在　　　private变量上使用@XmlElement和@XmlAttribute注解，否则在由java对象生成xml时会报同一个属性在java类里存在两次的错误。同理，如果@XmlAccessorType的访问权限　　　为XmlAccessType.NONE，如果在java的成员变量上使用了@XmlElement或@XmlAttribute注解，这些成员变量依然可以映射到xml文件。

• @XmlAccessorOrder

  @XmlAccessorOrder用于对java对象生成的xml元素进行排序。它有两个属性值：
  AccessorOrder.ALPHABETICAL：对生成的xml元素按字母书序排序
  XmlAccessOrder.UNDEFINED:不排序

• @XmlTransient

  @XmlTransient用于标示在由java对象映射xml时，忽略此属性。即，在生成的xml文件中不出现此元素。

• @XmlJavaTypeAdapter

  @XmlJavaTypeAdapter常用在转换比较复杂的对象时，如map类型或者格式化日期等。使用此注解时，需要自己写一个adapter类继承XmlAdapter抽象类，并实现里面的方法。
  @XmlJavaTypeAdapter(value=xxx.class),value为自己定义的adapter类

XmlAdapter如下：

public abstract class XmlAdapter<ValueType,BoundType> {

    protected XmlAdapter() {}

    public abstract BoundType unmarshal(ValueType v);

    public abstract ValueType marshal(BoundType v);
 }

demo 示栗

• Phone ：xml 根节点实体类

import javax.xml.bind.annotation.*;
import java.util.ArrayList;
import java.util.List;

/**
 * Description:
 *
 * @Author: pengwei.xpw
 * @Date: 2017/11/15 下午11:27
 */
@XmlRootElement(name = "phone")
@XmlAccessorType(XmlAccessType.NONE)

public class Phone {


    @XmlElements
            ({
                    @XmlElement(name = "iphone", type = Iphone.class, required = false),
                    @XmlElement(name = "honor", type = Honor.class, required = false)
            })
    private List<AbstractPhone> list = new ArrayList<>();

    public List<AbstractPhone> getList() {
        return list;
    }

    public void setList(List<AbstractPhone> list) {
        this.list = list;
    }
}

• AbstractPhone ：手机父类实体

import javax.xml.bind.annotation.XmlSeeAlso;

@XmlSeeAlso({Iphone.class, Honor.class})
public abstract class AbstractPhone {

}

• Iphone ： 苹果手机实体类

import javax.xml.bind.annotation.*;
import java.util.ArrayList;
import java.util.List;

/**
 * Description:
 *
 * @Author: pengwei.xpw
 * @Date: 2017/11/15 下午11:30
 */
@XmlRootElement(name="iphone")
@XmlAccessorType(XmlAccessType.NONE)
public class Iphone extends AbstractPhone {

    @XmlAttribute(name = "description")
    private String desc;

    @XmlElement
    private List<Property> property = new ArrayList<>();

    public Iphone() {

    }

    public Iphone(String desc) {
        this.desc = desc;
    }

    public String getDesc() {
        return desc;
    }

    public void setDesc(String desc) {
        this.desc = desc;
    }

    public List<Property> getProperty() {
        return property;
    }

    public void setProperty(List<Property> property) {
        this.property = property;
    }
}

• Honor : 荣耀手机实体类

import javax.xml.bind.annotation.*;
import java.util.ArrayList;
import java.util.List;

/**
 * Description:
 *
 * @Author: pengwei.xpw
 * @Date: 2017/11/15 下午11:30
 */
@XmlRootElement(name = "honor")
@XmlAccessorType(XmlAccessType.NONE)
public class Honor extends AbstractPhone {

    @XmlAttribute(name = "type")
    private String type;

    @XmlElement
    private List<Property> property = new ArrayList<>();

    public Honor() {

    }

    public Honor(String type) {
        this.type = type;
    }

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }

    public List<Property> getProperty() {
        return property;
    }

    public void setProperty(List<Property> property) {
        this.property = property;
    }
}

• Property : 手机属性实体类

import javax.xml.bind.annotation.*;

@XmlRootElement(name = "property")
@XmlAccessorType(XmlAccessType.NONE)

public class Property {
    @XmlAttribute(name = "name")
    private String name;

    @XmlValue
    private String value;

    public Property() {
    }

    public Property(String name, String value) {
        this.name = name;
        this.value = value;
    }

    public String getName() {
        return name;
    }

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

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        this.value = value;
    }
}

• test 入口

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import java.io.StringWriter;

/**
 * Description:
 *
 * @Author: pengwei.xpw
 * @Date: 2017/11/15 下午11:40
 */
public class Main {


    public static void main(String[] args) throws JAXBException {

        Phone phone = new Phone();
        phone.getList().add(initIphone());
        phone.getList().add(initHonor());

        Marshaller marshaller = init();

        StringWriter writer = new StringWriter();

        marshaller.marshal(phone, writer);
        String res = writer.toString();
        System.out.println(res);
    }

    static Marshaller init() {
        Marshaller marshaller = null;
        try {
            JAXBContext context = JAXBContext.newInstance(Phone.class);
            marshaller = context.createMarshaller();
            marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
            marshaller.setProperty(Marshaller.JAXB_ENCODING, "utf-8");//编码格式
            marshaller.setProperty(Marshaller.JAXB_FRAGMENT, false);
            return marshaller;
        } catch (Exception e) {
            return null;
        }
    }

    static Iphone initIphone() {

        Iphone iphone = new Iphone("水果机");

        iphone.getProperty().add(new Property("产商", "美国"));
        iphone.getProperty().add(new Property("系统", "IOS"));

        return iphone;
    }

    static Honor initHonor() {

        Honor honor = new Honor("荣耀青春版");

        honor.getProperty().add(new Property("产商", "中国"));
        honor.getProperty().add(new Property("系统", "Android"));

        return honor;
    }
}

鸡冻人心的时刻到了,看下结果：

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<phone>
    <iphone description="水果机">
        <property name="产商">美国</property>
        <property name="系统">IOS</property>
    </iphone>
    <honor type="荣耀青春版">
        <property name="产商">中国</property>
        <property name="系统">Android</property>
    </honor>
</phone>