SpringBoot接收与响应xml报文请求的实现

 更新时间:2023年06月25日 10:41:29   作者:谁是谁的小确幸  
我们在进行接口对接时,会出现报文形式的信息传递,这篇文章主要给大家介绍了关于SpringBoot接收与响应xml报文请求的相关资料,需要的朋友可以参考下

背景

平时开发的接口,基本是使用 json 格式的请求报文。然而,有时候也避免不了有 xml 报文请求的场景,最近就遇到了这种情况,在此记录下。另外,工程中使用的是 controller-service……这种结构。

xml请求报文:

<?xml version="1.0" encoding="UTF-8" ?>
<req>
  <tel>15556905765</tel>
  <activityid></activityid>
  <timestamp>1603383430</timestamp>
</req>

xml响应报文:

<?xml version="1.0" encoding="UTF-8" ?>
<resp>
    <code>200</code>
    <msg></msg>
    <activeflag></activeflag>
</resp>

实现步骤

第一步,引入必需依赖

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.16.10</version>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-xml</artifactId>
    <version>2.14.1</version>
</dependency>

在 jackson-dataformat-xml 包里提供了一系列的 json 与 xml 互转的 API。当定义请求或响应类时,使用 @JacksonXml 开头的注解,可以实现 xml 标签字段与 javabean 字段之间的映射。

第二步,自定义请求类和响应类

自定义请求类:

@Data
@JacksonXmlRootElement(localName = "req")
public class TestRequest {
    //手机号
    @JacksonXmlProperty(localName = "tel")
    private String tel;
 
    //活动商品ID
    @JacksonXmlProperty(localName = "activityId")
    private String productId;
 
    @JacksonXmlProperty(localName = "timestamp")
    private Long timestamp;
}

自定义响应类:

@Data
@JacksonXmlRootElement(localName = "resp")
public class TestResponse {
    //返回码
    @JacksonXmlProperty(localName = "code")
    private String code;
    //返回码信息描述
    @JacksonXmlProperty(localName = "msg")
    private String msg;
    //可参与活动标志 :1-可参与 2-不可参与
    @JacksonXmlProperty(localName = "activeflag")
    private String activeFlag;
}

注意,当xml与实体类的一些字段名称相同时,这些字段可以不使用@JacksonXmlProperty注解。

第三步,编写控制器类和业务逻辑

TestController:

@RestController
public class TestController {
    @Resource
    private TestService testService;
 
    @PostMapping(value = "/test"
            , produces = MediaType.APPLICATION_XML_VALUE)
    public String test(@RequestBody TestRequest request)
    {
        return testService.service(request);
    }
}

TestService:

@Slf4j
@Service
public class TestService {
    public String service(TestRequest request){
 
        //request入参校验 .... 省略
 
        //正常情况
        TestResponse response = new TestResponse();
        response.setCode("200");
        response.setMsg("allow sub");
        response.setActiveFlag("1");
        return javaBeanToXml(response);
    }
}

第四步,编写 javabean 转 xml 方法

//XML文件头
private static final String XML_HEAD = "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n";
public static String javaBeanToXml(Object obj)
{
    String xml = "";
    if (Objects.isNull(obj))
    {
        return xml;
    }
    try
    {
        XmlMapper xmlMapper = new XmlMapper();
        xml = xmlMapper.writeValueAsString(obj);
    } catch (Exception e)
    {
        log.error("javaBeanToXml error, obj={}, xml={}", obj, xml, e);
        return "";
    }
    // 添加xml文件头
    return XML_HEAD + xml;
}

自测

这里,使用 postman 工具测试(Body->raw->XML)

效果如下:

 特此记录下,就这样~

总结

到此这篇关于SpringBoot接收与响应xml报文请求的文章就介绍到这了,更多相关SpringBoot接收响应xml报文请求内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 浅谈Java日志框架slf4j作用及其实现原理

    浅谈Java日志框架slf4j作用及其实现原理

    日志记录是应用程序运行中必不可少的一部分。这篇文章主要介绍了浅谈Java日志框架slf4j作用及其实现原理,SLF4J是一个日志框架抽象层,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-03-03
  • 详解java集成支付宝支付接口(JSP+支付宝20160912)

    详解java集成支付宝支付接口(JSP+支付宝20160912)

    本篇文章主要介绍了java集成支付宝支付接口,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-12-12
  • java连接SQL Server数据库的方法

    java连接SQL Server数据库的方法

    这篇文章主要为大家详细介绍了java连接SQL Server数据库的方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-10-10
  • Gradle相对于Maven有哪些优点

    Gradle相对于Maven有哪些优点

    这篇文章主要介绍了Gradle相对于Maven有哪些优点,帮助大家选择合适的自动构建工具,更好的构建项目,感兴趣的朋友可以了解下
    2020-10-10
  • SpringBoot使用SOFA-Lookout监控的方法

    SpringBoot使用SOFA-Lookout监控的方法

    本文介绍SpringBoot使用蚂蚁金服SOFA-Lookout配合Prometheus进行监控,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-03-03
  • Java防止xss攻击附相关文件下载

    Java防止xss攻击附相关文件下载

    首先说一下思路,防止这种类似于注入攻击,就是使用拦截器(Filter)处理特殊字符或过滤特殊字符 今天介绍一个方法,利用覆盖Servlet的getParameter方法达到处理特殊字符的目的来解决(防止)Xss攻击 web.xml,需要的朋友可以参考下
    2020-02-02
  • SpringBoot实现excel生成并且通过邮件发送的步骤详解

    SpringBoot实现excel生成并且通过邮件发送的步骤详解

    实际开发中,特别是在B端产品的开发中,我们经常会遇到导出excel的功能,更进阶一点的需要我们定期生成统计报表,然后通过邮箱发送给指定的人员, 今天要带大家来实现的就是excel生成并通过邮件发送,需要的朋友可以参考下
    2023-10-10
  • Java编程redisson实现分布式锁代码示例

    Java编程redisson实现分布式锁代码示例

    这篇文章主要介绍了Java编程redisson实现分布式锁代码示例,小编觉得还是比较不错的,这里给大家分享下,供需要的朋友参考。
    2017-10-10
  • mybatis日志打印的两款IDEA插件推荐

    mybatis日志打印的两款IDEA插件推荐

    这篇文章主要给大家推荐介绍了关于mybatis日志打印的两款IDEA插件,文中通过图文以及实例代码介绍的非常详细,对大家学习或者使用mybatis具有一定的参考学习价值,需要的朋友可以参考下
    2023-04-04
  • 详细解读Java的Lambda表达式

    详细解读Java的Lambda表达式

    这篇文章主要介绍了详细解读Java的Lambda表达式,lambda 表达式 是Java 8新加入的新特性,它在Java中是引入了函数式编程这一概念,需要的朋友可以参考下
    2023-04-04

最新评论