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