关于java:Spring-Boot-2x基础教程如何扩展XML格式的请求和响应

1次阅读

共计 2747 个字符，预计需要花费 7 分钟才能阅读完成。

在之前的所有 Spring Boot 教程中，咱们都只提到和用到了针对 HTML 和 JSON 格局的申请与响应解决。那么对于 XML 格局的申请要如何疾速的在 Controller 中包装成对象，以及如何以 XML 的格局返回一个对象呢？

在扩大上述问题之前，咱们先要晓得 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 2.x 基础教程》点击中转！。学习过程中如遇艰难，倡议退出 Spring 技术交换群，参加交换与探讨，更好的学习与提高！

本文的相干例子能够查看上面仓库中的 chapter2-8 目录：