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的@Transactional、@Aysnc、事务同步问题详解

    Java的@Transactional、@Aysnc、事务同步问题详解

    这篇文章主要介绍了Java的@Transactional、@Aysnc、事务同步问题详解,现在我们需要在一个业务方法中插入一个用户,这个业务方法我们需要加上事务,然后插入用户后,我们要异步的方式打印出数据库中所有存在的用户,需要的朋友可以参考下
    2023-11-11
  • java怎么设置代理ip实现高效网络请求

    java怎么设置代理ip实现高效网络请求

    无论是在爬虫、API调用还是网络测试中,代理IP的使用都变得愈发重要,本文我们主要来介绍一下如何在Java中设置代理IP实现高效网络请求吧
    2024-11-11
  • go语言题解LeetCode88合并两个有序数组示例

    go语言题解LeetCode88合并两个有序数组示例

    这篇文章主要为大家介绍了go语言题解LeetCode88合并两个有序数组示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-12-12
  • MyBatis-Plus的基本CRUD操作大全

    MyBatis-Plus的基本CRUD操作大全

    本文介绍了MyBatis-Plus框架中BaseMapper和IService两大核心组件的使用,,通过示例代码演示了如何实现数据插入、删除、修改、查询等操作,并展示了条件构造器、分页查询、事务处理等实用功能,感兴趣的朋友跟随小编一起看看吧
    2026-02-02
  • Java随机值设置(java.util.Random类或Math.random方法)

    Java随机值设置(java.util.Random类或Math.random方法)

    在编程中有时我们需要生成一些随机的字符串作为授权码、验证码等,以确保数据的安全性和唯一性,这篇文章主要给大家介绍了关于Java随机值设置的相关资料,主要用的是java.util.Random类或Math.random()方法,需要的朋友可以参考下
    2024-08-08
  • 浅谈Spring Bean的基本配置

    浅谈Spring Bean的基本配置

    这篇文章主要介绍了浅谈Spring Bean的基本配置,文中有非常详细的代码示例,对正在学习java Spring的小伙伴们有非常好的帮助,需要的朋友可以参考下
    2021-05-05
  • 浅谈Timer和TimerTask与线程的关系

    浅谈Timer和TimerTask与线程的关系

    下面小编就为大家带来一篇浅谈Timer和TimerTask与线程的关系。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-03-03
  • log4j与slf4j的使用与区别详解

    log4j与slf4j的使用与区别详解

    这篇文章主要介绍了log4j与slf4j的使用与区别详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-10-10
  • mybatis空值插入处理的解决方法

    mybatis空值插入处理的解决方法

    本文主要介绍了mybatis空值插入处理的解决方法,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-09-09
  • SpringBoot中的条件注解使用示例详解

    SpringBoot中的条件注解使用示例详解

    SpringBoot条件注解用于动态控制Bean创建与配置加载,基于@Conditional机制,支持按类、Bean、属性等条件判断,广泛应用于多数据源等场景,提升应用灵活性与智能化,接下来通过本文给大家讲解SpringBoot中的条件注解使用,感兴趣的朋友一起看看吧
    2025-08-08

最新评论