前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Spring Boot中如何优雅地表述XML资源

Spring Boot中如何优雅地表述XML资源

作者头像
烟雨平生
发布2023-03-07 14:52:16
6170
发布2023-03-07 14:52:16
举报
文章被收录于专栏:数字化之路数字化之路
在之前的所有Spring Boot教程中,我们都只提到和用到了针对HTML和JSON格式的请求与响应处理。那么对于XML格式的请求要如何快速地在Controller层包装成对象,以及如何以XML格式返回一个对象呢?

实现原理:消息转换器(Message Converter)

在扩展上述问题之前,我们先要知道Spring Boot中处理HTTP请求的实现是Spring MVC。而在Spring MVC中有一个消息转换器(HttpMessageConverter)的概念,它主要负责处理Request/Java对象、Response/Java对象 之间的状态转换,以提供更好的编程体验。

在Spring MVC中定义了HttpMessageConverter接口,抽象了消息转换器对类型的判断、对读写的判断与操作。接口源码如下:

代码语言:javascript
复制
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格式数据的消息转换实现:

代码语言:javascript
复制
@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的实现:

代码语言:javascript
复制
<dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-xml</artifactId>
</dependency>

同时,为了配置xml数据与维护对象属性的关系所要使用的注解也在上述依赖中,所以这个依赖也是必须的。

  • 第二步:定义对象与xml的关系

做好了基础扩展之后,下面就可以定义xml内容对应的Java对象了,比如:

代码语言:javascript
复制
@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来请求接口):

代码语言:javascript
复制
<User>
    <name>aaaa</name>
    <age>10</age>
</User>
  • 第三步:创建接收xml请求的接口

完成了要转换的对象之后,可以编写一个接口来接收xml并返回xml,比如:

代码语言:javascript
复制
@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内容。

小贴士:

Http请求响应报文其实都是字符串,当请求报文到java程序会被封装为一个 ServletInputStream流,开发人员再读取报文,响应报文则通过 ServletOutputStream流,来输出响应报文。

从流中只能读取到原始的字符串报文,同样输出流也是。那么在报文到达SpringMVC和从SpringMVC出去,都存在一个字符串到java对象互相转换。在Spring MVC中这个功能是HttpMessageConverter提供的。

案例代码

可以通过下面两个仓库中查阅chapter3-1-8目录:

  • Github https://github.com/dyc87112/SpringBoot-Learning/
  • Gitee https://gitee.com/didispace/SpringBoot-Learning

或 这个添加了Swagger支持的例子 https://github.com/helloworldtang/spring-boot-cookbook/blob/v1.0.2-thymeleaf/learning-demo/src/main/java/com/tangcheng/learning/web/api/HttpMessageConverterTestController.java

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2018-10-02,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 的数字化之路 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档