前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >【SpringBoot WEB 系列】xml 传参与返回使用姿势

【SpringBoot WEB 系列】xml 传参与返回使用姿势

原创
作者头像
一灰灰blog
修改2020-07-07 10:24:20
2.5K0
修改2020-07-07 10:24:20
举报
文章被收录于专栏:小灰灰

【WEB 系列】xml 传参与返回使用姿势

使用 XML 作为传参和返回结果,在实际的编码中可能不太常见,特别是当前 json 大行其道的时候;那么为什么突然来这么一出呢?源于对接微信公众号的消息接收,自动回复的开发时,惊奇的发现微信使用 xml 格式进行交互,所以也就不得不支持了

下面介绍一下 SpringBoot 中如何支持 xml 传参解析与返回 xml 文档

<!-- more -->

I. 项目环境

本文创建的实例工程采用SpringBoot 2.2.1.RELEASE + maven 3.5.3 + idea进行开发

1. pom 依赖

具体的 SpringBoot 项目工程创建就不赘述了,对于 pom 文件中,需要重点关注下面两个依赖类

代码语言:txt
复制
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>com.fasterxml.jackson.dataformat</groupId>
        <artifactId>jackson-dataformat-xml</artifactId>
        <version>2.10.0</version>
    </dependency>
</dependencies>

请注意 jackson-dataformat-xml 版本,不要选择太老的

II. 实例演示

1. 传参 Bean

定义一个接受参数的 bean 对象,如下

代码语言:txt
复制
@JacksonXmlRootElement(localName = "req")
@Data
public static class XmlBean {
    private String name;

    @JacksonXmlProperty(localName = "age")
    private Integer age;
}

请注意,我们使用@JacksonXmlRootElement注解来修饰这个 bean,localName 中的 value,相当于 xml 的根标签;如果类中的属性成员名,和 xml 标签名不一样,可以使用注解@JacksonXmlProperty(localName = "xxx")来修饰

其次,请保留 bean 的默认无参构造函数,get/set 方法 (我上面为了简洁,使用了 lombok(最近看到了不少抨击 lombok 的文章...),不希望使用 lombok 的小伙伴,可以利用 IDEA 的自动生成,来实现相关的代码)

2. Response Bean

定义返回的也是一个 xml bean

代码语言:txt
复制
@Data
@JacksonXmlRootElement(localName = "res")
public static class XmlRes {
    private String msg;

    private Integer code;

    private String data;
}

3. rest 服务

然后像平常一样,实现一个"普通"的 rest 服务即可

代码语言:txt
复制
@RestController
@RequestMapping(path = "xml")
public class XmlParamsRest {
    @PostMapping(path = "show", consumes = {MediaType.APPLICATION_XML_VALUE},
            produces = MediaType.APPLICATION_XML_VALUE)
    public XmlRes show(@RequestBody XmlBean bean) {
        System.out.println(bean);
        XmlRes res = new XmlRes();
        res.setCode(0);
        res.setMsg("success");
        res.setData(bean.toString());
        return res;
    }
}

注意三点

  • @RestController:返回的不是视图
  • @PostMapping注解中的 consumesproduces参数,指定了"application/xml",表示我们接收和返回的都是 xml 文档
  • @RequestBody:不加这个注解时,无法获取传参哦(可以想一想 why?)

接口测试

我个人倾向于万能的 curl 进行测试,打开终端即可使用,如下

代码语言:txt
复制
# 测试命令
curl -X POST 'http://127.0.0.1:8080/xml/show' -H 'content-type:application/xml' -d '<req><name>一灰灰</name><age>18</age></req>' -i

考虑到有些小伙伴更青睐于 Postman 进行 url 测试,下面是具体的请求姿势

4. 解析异常问题

如果需要重新这个问题,可以参考项目: https://github.com/liuyueyi/spring-boot-demo/tree/master/spring-boot/202-web-params

某些场景下,直接使用上面的姿势貌似不能正常工作,会抛出一个Resolved [org.springframework.web.HttpMediaTypeNotSupportedException: Content type 'application/xml;charset=UTF-8' not supported]的异常信息

针对出现HttpMediaTypeNotSupportedException的场景,解决办法也很明确,增加一个 xml 的HttpMesssageConverter即可,依然是借助MappingJackson2XmlHttpMessageConverter,如

代码语言:txt
复制
@Configuration
public class MvcConfig extends WebMvcConfigurationSupport {
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        super.configureMessageConverters(converters);
        converters.add(new MappingJackson2XmlHttpMessageConverter());
    }
}

II. 其他

0. 项目

1. 一灰灰 Blog

尽信书则不如,以上内容,纯属一家之言,因个人能力有限,难免有疏漏和错误之处,如发现 bug 或者有更好的建议,欢迎批评指正,不吝感激

下面一灰灰的个人博客,记录所有学习和工作中的博文,欢迎大家前去逛逛

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

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

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

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

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • I. 项目环境
    • 1. pom 依赖
    • II. 实例演示
      • 1. 传参 Bean
        • 2. Response Bean
          • 3. rest 服务
            • 4. 解析异常问题
            • II. 其他
              • 0. 项目
                • 1. 一灰灰 Blog
                领券
                问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档