Spring 返回Xml格式

一、spring返回xml格式响应

1.1 配置相关

如果需要方法返回xml格式则需要在requestMapping属性中添加application/xml，最好再设置编码，如下代码所示：

@ResponseBody 和 produces = {"application/xml;charset=utf-8"} 都是必须的

@RequestMapping(value = "/toXml",
            produces = {"application/xml;charset=utf-8"})
    @ResponseBody
    public ResponseXML toXml(){
        ResponseXML xml = new ResponseXML();
        xml.setAge("12");
        xml.setName("测试");
        return xml;
    }

如果spring返回xml格式响应则不能返回纯字符串，否则报错

这里着重介绍几个xml相关的注解

@XmlType，将Java类或枚举类型映射到XML模式类型
@XmlAccessorType(XmlAccessType.FIELD) ，控制字段或属性的序列化。FIELD表示JAXB将自动绑定Java类中的每个非静态的（static）、非瞬态的（由@XmlTransient标注）字段到XML。其他值还有XmlAccessType.PROPERTY和XmlAccessType.NONE。
@XmlAccessorOrder，控制JAXB 绑定类中属性和字段的排序。
@XmlJavaTypeAdapter，使用定制的适配器（即扩展抽象类XmlAdapter并覆盖marshal()和unmarshal()方法），以序列化Java类为XML。
@XmlElementWrapper ，对于数组或集合（即包含多个元素的成员变量），生成一个包装该数组或集合的XML元素（称为包装器）。
@XmlRootElement，将Java类或枚举类型映射到XML元素。
@XmlElement，将Java类的一个属性映射到与属性同名的一个XML元素。
@XmlAttribute，将Java类的一个属性映射到与属性同名的一个XML属性。
————————————————
版权声明：本文为CSDN博主「2014Team」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/u012965203/java/article/details/102528958

1.2 注解详解

1. @XmlType

   　　@XmlType用在class类的注解，常与@XmlRootElement，@XmlAccessorType一起使用。它有三个属性：name、propOrder、namespace，经常使用的只有前两个属性。如：

   @XmlType(name = "basicStruct", propOrder = {
       "intValue",
       "stringArray",
       "stringValue"
   )

   在使用@XmlType的propOrder 属性时，必须列出JavaBean对象中的所有属性，否则会报错。

2. @XmlElement
   

   @XmlElement将java对象的属性映射为xml的节点，在使用@XmlElement时，可通过name属性改变java对象属性在xml中显示的名称。如：

    

   @XmlElement(name="name")　　
   private String name;

3. @XmlRootElement
   @XmlRootElement用于类级别的注解，对应xml的跟元素，常与 @XmlType 和 @XmlAccessorType一起使用。如：


   @XmlRootElement(name = "root")
   public class ResponseXML {}

4. @XmlAttribute
   @XmlAttribute用于把java对象的属性映射为xml的属性,并可通过name属性为生成的xml属性指定别名。如：
   

   @XmlAttribute(name = "属性名称")
   private String name;

5. @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文件。

6. @XmlAccessorOrder
   

   @XmlAccessorOrder用于对java对象生成的xml元素进行排序。它有两个属性值：

   　　AccessorOrder.ALPHABETICAL：对生成的xml元素按字母书序排序

   　　XmlAccessOrder.UNDEFINED:不排序

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

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

   　　@XmlJavaTypeAdapter(value=xxx.class),value为自己定义的adapter类

   　　XmlAdapter如下：

   public abstract class XmlAdapter<ValueType,BoundType> {
       // Do-nothing constructor for the derived classes.
       protected XmlAdapter() {}
       // Convert a value type to a bound type.
       public abstract BoundType unmarshal(ValueType v);
       // Convert a bound type to a value type.
       public abstract ValueType marshal(BoundType v);
    }

9. @XmlElementWrapper
   

   对于数组或集合（即包含多个元素的成员变量），生成一个包装该数组或集合的XML元素（称为包装器）。

 详解摘抄自：https://www.cnblogs.com/fragranting/archive/2012/03/25/xml--jaxb.html

1.2 实操

1.2.1 首先新建一个xml映射类如下：

package cn.wanghao.entity;


import javax.xml.bind.annotation.*;

@XmlRootElement
public class ResponseXML {

    private String name;
    private String age;

    public String getName() {
        return name;
    }

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

    public String getAge() {
        return age;
    }

    public void setAge(String age) {
        this.age = age;
    }
}

1.2.2 在Controller中新建一个RequestMapping

@RequestMapping(value = "/toXml",
            produces = {"application/xml;charset=utf-8"})
    @ResponseBody
    public ResponseXML toXml(){
        ResponseXML xml = new ResponseXML();
        xml.setAge("12");
        xml.setName("测试");
        return xml;
    }

1.2.3 启动项目访问路径

 

 成功返回。

1.2.4 xml标签设置属性

例如给根节点添加id属性，更改xml的映射类如下:

package cn.wanghao.entity;


import javax.xml.bind.annotation.*;

@XmlRootElement(name = "root")
public class ResponseXML {


    private int id;

    private String name;
    private String age;

    @XmlAttribute
    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }

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

    public void setAge(String age) {
        this.age = age;
    }
}

然后给id赋值，请求后如下：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<root id="1">
    <age>12</age>
    <name>测试</name>
</root>

如果多个id，可以写多个属性。

1.2.4 复杂xml结构

1.2.4.1 一对一展示

首先创建一个子类，并添加xml标签

@XmlRootElement
public class ResponseItem {

    private String name2;
    private int age2;


    ......get/set
}

然后给上级节点添加该属性并生成getset方法，赋值

private ResponseItem item;


    public ResponseItem getItem() {
        return item;
    }

    public void setItem(ResponseItem item) {
        this.item = item;
    }

执行结果如下：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<root id="1">
    <age>12</age>
    <item>
        <age2>123</age2>
        <name2>子属性</name2>
    </item>
    <name>测试</name>
</root>

可以看到，root节点下，包含item节点，item包含自己的属性

1.2.4.2 一对多

一对多使用到的标签为：

XmlElementWrapper

修改主节点对象的子节点属性如下：

private List<ResponseItem> items;

    @XmlElementWrapper
    public List<ResponseItem> getItems() {
        return items;
    }

    public void setItems(List<ResponseItem> items) {
        this.items = items;
    }

然后赋值执行如下：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<root id="1">
    <age>12</age>
    <items>
        <items>
            <age2>0</age2>
            <name2>子属性0</name2>
        </items>
        <items>
            <age2>1</age2>
            <name2>子属性1</name2>
        </items>
        <items>
            <age2>2</age2>
            <name2>子属性2</name2>
        </items>
        <items>
            <age2>3</age2>
            <name2>子属性3</name2>
        </items>
        <items>
            <age2>4</age2>
            <name2>子属性4</name2>
        </items>
    </items>
    <name>测试</name>
</root>

节点关系为： root-items-items

这样看起来使人误解，应该是root -items -item

所以我们更改元素的别名,把我们的属性名称改为item，并给标签添加name属性改为items

private List<ResponseItem> item;

    @XmlElementWrapper(name = "items")
    public List<ResponseItem> getItem() {
        return item;
    }

    public void setItem(List<ResponseItem> item) {
        this.item = item;
    }

执行结果如下：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<root id="1">
    <age>12</age>
    <items>
        <item>
            <age2>0</age2>
            <name2>子属性0</name2>
        </item>
        <item>
            <age2>1</age2>
            <name2>子属性1</name2>
        </item>
        <item>
            <age2>2</age2>
            <name2>子属性2</name2>
        </item>
        <item>
            <age2>3</age2>
            <name2>子属性3</name2>
        </item>
        <item>
            <age2>4</age2>
            <name2>子属性4</name2>
        </item>
    </items>
    <name>测试</name>
</root>

1.2.4.3 一对多另一种结构

如上所示一对多的展现方式，但是xml还有另一种一对多的方式，父节点下面包含多个子节点而没有一个总的items包裹。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<root id="1">
    <age>12</age>
    <item>
        <age2>0</age2>
        <name2>子属性0</name2>
    </item>
    <item>
        <age2>1</age2>
        <name2>子属性1</name2>
    </item>
    <item>
        <age2>2</age2>
        <name2>子属性2</name2>
    </item>
    <item>
        <age2>3</age2>
        <name2>子属性3</name2>
    </item>
    <item>
        <age2>4</age2>
        <name2>子属性4</name2>
    </item>
    <name>测试</name>
</root>

这时候我们就要更改注解XmlElementWrapper为XmlElement

 

 

 

 

参考文章：

https://www.cnblogs.com/lishuaiqi/p/9855282.html cdata

https://blog.csdn.net/chainhou/article/details/84442836

https://blog.csdn.net/u012965203/article/details/102528958

https://www.cnblogs.com/weilu2/p/springmvc_controller_handler_return_json_xml.html

 https://blog.csdn.net/u011649691/article/details/79441971