Spring Boot中如何擴展XML請求和響應的支持

作者：翟永超 2018-11-19 14:29:17

在之前的所有Spring Boot教程中，我們都只提到和用到了針對HTML和JSON格式的請求與響應處理。

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

實現原理：消息轉換器(Message Converter)

在擴展上述問題之前，我們先要知道Spring Boot中處理HTTP請求的實現是采用的Spring MVC。而在Spring MVC中有一個消息轉換器這個概念，它主要負責處理各種不同格式的請求數據進行處理，并包轉換成對象，以提供更好的編程體驗。

[[249818]]

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