在之前的所有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 = "https://www.cnblogs.com/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 2.x基礎教程》點擊直達!,學習程序中如遇困難,建議加入Spring技術交流群,參與交流與討論,更好的學習與進步!
代碼示例
本文的相關例子可以查看下面倉庫中的chapter2-8目錄:
- Github:https://github.com/dyc87112/SpringBoot-Learning/
- Gitee:https://gitee.com/didispace/SpringBoot-Learning/
如果您覺得本文不錯,歡迎Star支持,您的關注是我堅持的動力!
歡迎關注我的公眾號:程式猿DD,分享外面看不到的干貨與思考!
轉載請註明出處,本文鏈接:https://www.uj5u.com/houduan/288421.html
標籤:Java
