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钩子方法概念原理详解

    Java钩子方法概念原理详解

    这篇文章主要介绍了Java钩子方法概念原理详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-02-02
  • Go Java算法之外观数列实现方法示例详解

    Go Java算法之外观数列实现方法示例详解

    这篇文章主要为大家介绍了Go Java算法外观数列实现的方法示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-08-08
  • 浅谈Mybatis分页插件,自定义分页的坑

    浅谈Mybatis分页插件,自定义分页的坑

    这篇文章主要介绍了浅谈Mybatis分页插件,自定义分页的坑,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-09-09
  • maven学习-初窥门径

    maven学习-初窥门径

    这篇文章主要介绍了maven的简单知识,介绍了maven的定义及核心功能,具有一定参考价值,大家可以了解下。
    2017-10-10
  • 浅谈Spring 的Controller 是单例or多例

    浅谈Spring 的Controller 是单例or多例

    这篇文章主要介绍了浅谈Spring 的Controller 是单例or多例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-08-08
  • IDEA2020.1创建springboot项目(国内脚手架)安装lombok

    IDEA2020.1创建springboot项目(国内脚手架)安装lombok

    这篇文章主要介绍了IDEA2020.1创建springboot项目(国内脚手架)安装lombok,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-06-06
  • Java乱码问题解决方法_动力节点Java学院整理

    Java乱码问题解决方法_动力节点Java学院整理

    开发java应用出现乱码是很常见的,毕竟现在unicode的使用还不是很广泛,下面给大家分享Java乱码问题解决方法,感兴趣的朋友一起看看吧
    2017-07-07
  • springCloud中的Sidecar多语言支持详解

    springCloud中的Sidecar多语言支持详解

    这篇文章主要介绍了springCloud中的Sidecar多语言支持详解,Sidecar是将一组紧密结合的任务与主应用程序共同放在一台主机Host中,但会将它们部署在各自的进程或容器中,需要的朋友可以参考下
    2024-01-01
  • SpringBoot中接收POST参数的几种方式详解

    SpringBoot中接收POST参数的几种方式详解

    这篇文章主要介绍了SpringBoot中接收POST参数的几种方式,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-06-06
  • Java如何将Excel数据导入到数据库

    Java如何将Excel数据导入到数据库

    这篇文章主要为大家详细介绍了Java将Excel数据导入到数据库的方法,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-10-10

最新评论