好文分享：Spring Boot 2.x基础教程：如何扩展XML格式的请求和响应

行业资讯
2021年4月4日

在之前的所有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格式数据的消息转换实现：

@Configurationpublic 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，比如：

@Controllerpublic 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内容。

转载于公众号-程序猿DD

北京云中融信网络科技有限公司（简称融云），是安全、可靠的全球互联网通信云服务商，向开发者和企业提供即时通讯和实时音视频通信云服务。iResearch 艾瑞权威数据报告显示，融云即时通讯云市场份额连续多年稳居头位。

融云构建了一张覆盖全球所有国家及地区（共 233 个）的通信云网络，在全球各地设立多个数据中心及数千个加速节点。基于客户业务需求，融云可提供多种部署模式——公有云、私有云、混合云，为全球企业提供稳定的互联网通信云服务。针对企业级用户，融云将业务垂直到各个行业，为社交、直播、金融、交通运输、教育、电商、医疗等多个行业领域推出了针对性解决方案。

融云基于海量业务的技术锤炼，从基础架构到精细化运营，充分体现平台实力；凭借卓越的产品和优质的服务，在开发者规模、行业覆盖率、平台日活跃用户数、日均消息量等方面超越全行业。目前，已有数十万互联网用户及上千家企业级用户通过融云实现了场景化沟通，并从中获益，包括工商银行、中国移动、四川航空、CCTV 微视、中联重科、58 赶集、大河报业、新东方、陆金所、融创地产、IDG、华兴资本、易车网、猪八戒、得到 APP、荔枝、汽车之家、哈啰出行、百姓网、StarMaker、Opera、Elelive。

标签: 转载