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 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;

}

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

擴充套件實現

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

在傳統Spring應用中，我們可以通過如下配置加入對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應用不用像上面這麼麻煩，只需要加入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請求和響應的支援

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

擴充套件實現

Spring Boot中擴充套件XML請求和響應的支援

Spring Boot中擴充套件XML請求和響應實戰

Spring Boot中如何擴充套件XML請求和響應的支援

Spring Boot 中修改端口和上下文路徑

Spring boot 中pom.xml 各個節點詳解

.net core 雜記：WebAPI的XML請求和響應

Spring Boot中如何擴充套件對XML格式請求和響應的支援

idea中的spring boot maven專案的依賴和pom.xml檔案不一致的解決辦法

spring boot中實現響應圖片的方法以及改進

Thymeleaf 模板在spring boot 中的引用和應用

spring boot 導入xml配置文件所需註解和禁用自動配置類的註解

Spring Boot中application.properties和application.yml文件

HTTP中請求和響應淺析

Spring boot 配置 mybatis xml和動態SQL

由nginx和spring boot中tomcat配置不當引起的問題

Spring Boot中的return new ModelAndView("xxx") 和 return "xxx"的區別

基於代理的spring aop中,使用xml實現通知和引入

在 Spring Boot 中使用 Spring AOP 和 AspectJ 來測量方法的執行時間

spring boot通過自定義註解和AOP攔截指定的請求

Spring Boot中使用log4j實現http請求日誌入mongodb

Spring Boot中如何擴充套件XML請求和響應的支援

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

擴充套件實現

相關推薦