Spring Boot中擴展XML請求和回應的支援的方法介紹

這篇文章帶給大家的內容是關於Spring Boot中擴展XML請求和回應的支持的方法介紹，有一定的參考價值，有需要的朋友可以參考一下，希望對你有所幫助。

在之前的所有Spring Boot教學中，我們都只提到和用到了針對HTML和JSON格式的請求與回應處理。那麼對於XML格式的請求要如何快速的在Controller中包裝成對象，以及如何以XML的格式傳回一個對象呢？

實作原理：訊息轉換器（Message Converter）

在擴充上述問題之前，我們先要知道Spring Boot中處理HTTP請求的實作是採用的Spring MVC。而在Spring MVC中有一個訊息轉換器這個概念，它主要負責處理各種不同格式的請求資料進行處理，並包轉換成對象，以提供更好的程式設計體驗。

在Spring MVC中定義了HttpMessageConverter接口，抽象了訊息轉換器對類型的判斷、對讀寫的判斷與操作，具體可見如下定義：

public interface HttpMessageConverter<t> {

    boolean canRead(Class> clazz, [@Nullable](https://my.oschina.net/u/2896689) MediaType mediaType);

    boolean canWrite(Class> clazz, [@Nullable](https://my.oschina.net/u/2896689) MediaType mediaType);

    List<mediatype> getSupportedMediaTypes();

    T read(Class extends T> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException;

    void write(T t, [@Nullable](https://my.oschina.net/u/2896689) MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException;

}</mediatype></t>

眾所周知，HTTP請求的Content-Type有各種不同格式定義，如果要支援Xml格式的訊息轉換，就必須使用對應的轉換器。 Spring MVC中預設已經有一套採用Jackson實作的轉換器MappingJackson2XmlHttpMessageConverter。

擴充實作

第一步：引入Xml訊息轉換器

在傳統Spring應用程式中，我們可以透過以下配置加入對Xml格式資料的訊息轉換實作：

@Configuration
public class MessageConverterConfig1 extends WebMvcConfigurerAdapter {
    [@Override](https://my.oschina.net/u/1162528)
    public void configureMessageConverters(List<httpmessageconverter>> converters) {
        Jackson2ObjectMapperBuilder builder = Jackson2ObjectMapperBuilder.xml();
        builder.indentOutput(true);
        converters.add(new MappingJackson2XmlHttpMessageConverter(builder.build()));
    }
}</httpmessageconverter>

在Spring Boot應用程式不用像上面這麼麻煩，只需要加入jackson-dataformat-xml依賴，Spring Boot就會自動引入MappingJackson2XmlHttpMessageConverter的實作：

<dependency>
    <groupid>com.fasterxml.jackson.dataformat</groupid>
    <artifactid>jackson-dataformat-xml</artifactid>
</dependency>

同時，為了設定Xml資料與維護物件屬性的關係所要使用的註解也在上述依賴中，所以這個依賴也是必須的。

第二步：定義物件與Xml的關係

做好了基礎擴充之後，下面就可以定義Xml內容對應的Java物件了，例如：

@Data
@NoArgsConstructor
@AllArgsConstructor
@JacksonXmlRootElement(localName = "User")
public class User {

    @JacksonXmlProperty(localName = "name")
    private String name;
    @JacksonXmlProperty(localName = "age")
    private Integer age;

}

其中：@Data、@NoArgsConstructor、@AllArgsConstructor是lombok簡化程式碼的註解，主要用於產生get、set以及構造函數。 @JacksonXmlRootElement、@JacksonXmlProperty註解是用來維護物件屬性在xml中的對應關係。

上述配置的User對象，其可以映射的Xml樣例如下（後續可以使用上述xml來請求接口）：

<user>
    <name>aaaa</name>
    <age>10</age>
</user>

第三個步驟：建立接收xml請求的接口

完成了要轉換的物件之後，可以編寫一個接口來接收xml並返回xml，例如：

@Controller
public class UserController {

    @PostMapping(value = "/user", 
        consumes = MediaType.APPLICATION_XML_VALUE, 
        produces = MediaType.APPLICATION_XML_VALUE)
    @ResponseBody
    public User create(@RequestBody User user) {
        user.setName("didispace.com : " + user.getName());
        user.setAge(user.getAge() + 100);
        return user;
    }

}

最後，啟動Spring Boot應用，透過POSTMAN等請求工具，嘗試這個接口，可以看到請求Xml，並且傳回了經過處理後的Xml內容。 （案例代碼）

以上是Spring Boot中擴展XML請求和回應的支援的方法介紹的詳細內容。更多資訊請關注PHP中文網其他相關文章！