Spring Boot拓展XML格式的請求和響應操作過程

更新時間：2023年10月27日 10:19:45 作者：Miaow.Y.Hu

在我們開發(fā)過程中,我們經常使用的參數(shù)絕大多少事HTML和JSON格式的請求和響應處理,但是我們在實際開發(fā)過程中,我們可能經歷一些,比如對于XML格式的請求,本文給大家介紹Spring Boot拓展XML格式的請求和響應,感興趣的朋友一起看看吧

在我們開發(fā)過程中，我們經常使用的參數(shù)絕大多少事HTML和JSON格式的請求和響應處理，但是我們在實際開發(fā)過程中，我們可能經歷一些，比如對于XML格式的請求，我們在后端應該如何接收，并且如何將XML格式的參數(shù)變成對象，然后返回一個XML對象呢？

實現(xiàn)原理

我們在處理XML格式的數(shù)據(jù)的時候，需要知道我們最初學習Spring系列中的Spring MVC。因為在Spring MVC中我們有一個消息轉換器的概念，其主要負責處理不同格式的請求數(shù)據(jù)進行處理，然后將這個數(shù)據(jù)包裝成為對象，以便提供更加友好的變成體驗。

我們研究Spring MVC的源碼可以得到在Spring MVC中定義了一個HttpMessageCoverter接口，抽象了消息轉換器對類型的判斷，對讀寫的判斷與操作，具體如下：

public interface HttpMessageConverter<T> {
    boolean canRead(Class<?> clazz, @Nullable MediaType mediaType);
    boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType);
    List<MediaType> getSupportedMediaTypes();
    T read(Class<? extends T> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException;
    void write(T t, @Nullable MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException;
}

boolean canRead(Class<?> clazz, @Nullable MediaType mediaType)：判斷給定的類和媒體類型是否可以被讀取。在處理請求時，用于判斷是否可以將請求的消息體轉換為指定的類對象。
boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType)：判斷給定的類和媒體類型是否可以被寫入。在處理響應時，用于判斷是否可以將指定的類對象轉換為響應的消息體。
List<MediaType> getSupportedMediaTypes()：獲取該消息轉換器支持的媒體類型列表。這些媒體類型表示該轉換器可以讀取或寫入的數(shù)據(jù)格式。
- Tread(Class<? extends T> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException：將請求的消息體轉換為指定的類對象。該方法從 HttpInputMessage 中讀取請求的數(shù)據(jù)，并將其轉換為指定的類對象。
void write(T t, @Nullable MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException：將指定的類對象轉換為響應的消息體。該方法將指定的類對象轉換為字節(jié)流，并寫入到 HttpOutputMessage 中作為響應的數(shù)據(jù)。

我們知道，在HTTP中，Content-Type中有各種不同的格式定義，如果需要支持XML格式的消息轉換，那就的使用對應的轉換器，并且我們知道在Spring MVC中默認已經有一套采用Jackson實現(xiàn)的轉換器MappingJackson2XmlHttpMessageConverter。

拓展實現(xiàn)

1. 引入XML消息轉換器

如果你是Spring 用戶，并非Spring Boot用戶，那么我們可以引入XML消息轉換器。

@Configuration
public class MessageConverterConfig1 extends WebMvcConfigurerAdapter {
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        Jackson2ObjectMapperBuilder builder = Jackson2ObjectMapperBuilder.xml();
        builder.indentOutput(true);
        converters.add(new MappingJackson2XmlHttpMessageConverter(builder.build()));
    }
}

如果你是Spring Boot用戶，那么就直接加入相關依賴就行了，那么相關依賴就交于Spring Boot自動實現(xiàn)了：

<dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-xml</artifactId>
</dependency>

2. 定義對象與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以及構造函數(shù)。@JacksonXmlRootElement、@JacksonXmlProperty注解是用來維護對象屬性在xml中的對應關系。

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

<User>
    <name>miaow</name>
    <age>4</age>
</User>

3.創(chuàng)建一個接收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("姓名 : " + user.getName());
        user.setAge(user.getAge() + 20);
        return user;
    }
}

啟動項目之后，我們可以通過相關接口工具進行請求發(fā)送，例如：