Spring Boot 2.x基礎(chǔ)教程：如何擴(kuò)展XML格式的請求和響應(yīng)
在之前的所有Spring Boot教程中，我們都只提到和用到了針對HTML和JSON格式的請求與響應(yīng)處理。那么對于XML格式的請求要如何快速的在Controller中包裝成對象，以及如何以XML的格式返回一個對象呢？
實現(xiàn)原理：消息轉(zhuǎn)換器（Message Converter）
在擴(kuò)展上述問題之前，我們先要知道Spring Boot中處理HTTP請求的實現(xiàn)是采用的Spring MVC。而在Spring MVC中有一個消息轉(zhuǎn)換器這個概念，它主要負(fù)責(zé)處理各種不同格式的請求數(shù)據(jù)進(jìn)行處理，并包轉(zhuǎn)換成對象，以提供更好的編程體驗。
在Spring MVC中定義了HttpMessageConverter接口，抽象了消息轉(zhuǎn)換器對類型的判斷、對讀寫的判斷與操作，具體可見如下定義：
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格式的消息轉(zhuǎn)換，就必須要使用對應(yīng)的轉(zhuǎn)換器。Spring MVC中默認(rèn)已經(jīng)有一套采用Jackson實現(xiàn)的轉(zhuǎn)換器MappingJackson2XmlHttpMessageConverter。
擴(kuò)展實現(xiàn)
第一步：引入Xml消息轉(zhuǎn)換器
在傳統(tǒng)Spring應(yīng)用中，我們可以通過如下配置加入對Xml格式數(shù)據(jù)的消息轉(zhuǎn)換實現(xiàn)：
@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應(yīng)用不用像上面這么麻煩，只需要加入jackson-dataformat-xml依賴，Spring Boot就會自動引入MappingJackson2XmlHttpMessageConverter的實現(xiàn)：
<dependency>
<groupId>com.fasterxml.jackson.dataformat</groupId>
<artifactId>jackson-dataformat-xml</artifactId>
</dependency>
同時，為了配置Xml數(shù)據(jù)與維護(hù)對象屬性的關(guān)系所要使用的注解也在上述依賴中，所以這個依賴也是必須的。
第二步：定義對象與Xml的關(guān)系
做好了基礎(chǔ)擴(kuò)展之后，下面就可以定義Xml內(nèi)容對應(yīng)的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以及構(gòu)造函數(shù)。@JacksonXmlRootElement、@JacksonXmlProperty注解是用來維護(hù)對象屬性在xml中的對應(yīng)關(guān)系。
上述配置的User對象，其可以映射的Xml樣例如下（后續(xù)可以使用上述xml來請求接口）：
<User>
<name>aaaa</name>
<age>10</age>
</User>
第三步：創(chuàng)建接收xml請求的接口
完成了要轉(zhuǎn)換的對象之后，可以編寫一個接口來接收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應(yīng)用，通過POSTMAN等請求工具，嘗試一下這個接口，可以看到請求Xml，并且返回了經(jīng)過處理后的Xml內(nèi)容。
本系列教程《Spring Boot 2.x基礎(chǔ)教程》：https://blog.didispace.com/spring-boot-learning-2x/
學(xué)習(xí)過程中如遇困難，建議加入Spring技術(shù)交流群，參與交流與討論，更好的學(xué)習(xí)與進(jìn)步！如何加入？點擊下方卡片，回復(fù)關(guān)鍵詞「加群」即可！
代碼示例
本文的相關(guān)例子可以查看下面?zhèn)}庫中的chapter2-8目錄：
Github：https://github.com/dyc87112/SpringBoot-Learning/ Gitee：https://gitee.com/didispace/SpringBoot-Learning/
往期推薦