当前位置：首页 > news >正文

springboot集成jackson-dataformat-xml实现发送XML请求和XML响应参数处理

news 2025/2/25 9:56:47

背景

最近在做发票相关的业务，需要对接第三方进行开发票等一系列操作，对方的系统是较老系统，需要采用XML的请求方式。

思路

一般来说，基于springboot的项目采用的都是JSON格式的请求参数和响应参数，因此需要做一个转换。
从格式上，XML格式的数据，是一个XML头后面是各种标签存放数据。例如data标签代表数据，orderno标签代表订单编号字段。

<?xml version="1.0" encoding="utf-8"?>
<data><orderno>123456789</orderno><ordertype>2</ordertype><ticketno>666555</ticketno>
</data>

手动拼接

这是最容易想到的方式，因为格式相对固定，字段不多的请求下直接手动拼接就好了。

jackson框架

jackson-dataformat-xml框架提供了bean转xml和xml转bean的能力，并且使用简单，省去了繁琐的拼接操作。

springboot集成jackson-dataformat-xml

1.引入依赖

需要注意，如果项目已经引入过jackson依赖，在引入jackson-dataformat-xml依赖的时候需要保持依赖版本一致，可以通过在依赖管理搜jackson来查看版本。如果版本一致还是报错，考虑使用更高版本。

        <dependency><groupId>com.fasterxml.jackson.dataformat</groupId><artifactId>jackson-dataformat-xml</artifactId><version>2.11.3</version></dependency>

2.添加注解

如下：
@JacksonXmlRootElement注解用来生成参数外一层的标签，也就是data标签。
@JacksonXmlProperty注解用来生成具体参数的标签，如payorderno字段，会根据注解配置生成ticketno标签，如果标签名和字段名一致可省略。如下，orderno和ordertype因为字段名和标签名一致就可省略该注解。
注意：如果标签名首字母是大写的，在定义字段的时候就必须用@JacksonXmlProperty注解指定。

import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;
import lombok.Data;
@Data
@JacksonXmlRootElement(localName = "data")
public class TestBO {private String orderno;private Integer ordertype;@JacksonXmlProperty(localName = "ticketno")private String payorderno;
}

假如现在有一个对象:

{
"orderno":"123456789",
"ordertype":2,
"payorderno":"666555"
}

转换之后得到的xml字符串：

<data>
<orderno>123456789</orderno>
<ordertype>2</ordertype>
<ticketno>666555</ticketno>
</data>

3.转换

bean转xml

import com.alibaba.fastjson.JSONObject;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.dataformat.xml.XmlMapper;
import org.jeecg.modules.admin.invoice.bo.TestBO;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
public class Test {@org.junit.Testpublic void test(){TestBO testBO=new TestBO();testBO.setOrderno("123456789");testBO.setOrdertype(2);testBO.setPayorderno("666555");String s = JSONObject.toJSONString(testBO);System.out.println(s);XmlMapper xmlMapper=new XmlMapper();String s1 = null;try {s1 = xmlMapper.writeValueAsString(testBO);} catch (JsonProcessingException e) {e.printStackTrace();}System.out.println(s1);s1="<?xml version=\"1.0\" encoding=\"gb2312\"?>"+s1;System.out.println(s1);}
}

打印结果如下：

{"orderno":"123456789","ordertype":2,"payorderno":"666555"}
<data><orderno>123456789</orderno><ordertype>2</ordertype><ticketno>666555</ticketno></data>
<?xml version="1.0" encoding="gb2312"?><data><orderno>123456789</orderno><ordertype>2</ordertype><ticketno>666555</ticketno></data>

只需要再拼接一个xml的头就可以用来发请求了。
打印的第三行参数和实际请求收到的响应结果也差不多。

xml转bean

以上面转换得到的xml结果作为本次转换的入参。

import com.alibaba.fastjson.JSONObject;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.dataformat.xml.XmlMapper;
import org.jeecg.modules.admin.invoice.bo.TestBO;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
public class Test {@org.junit.Testpublic void test(){TestBO testBO=new TestBO();testBO.setOrderno("123456789");testBO.setOrdertype(2);testBO.setPayorderno("666555");String s = JSONObject.toJSONString(testBO);System.out.println(s);XmlMapper xmlMapper=new XmlMapper();String s1 = null;try {s1 = xmlMapper.writeValueAsString(testBO);} catch (JsonProcessingException e) {e.printStackTrace();}System.out.println(s1);s1="<?xml version=\"1.0\" encoding=\"gb2312\"?>"+s1;System.out.println(s1);TestBO testBO1=null;try {testBO1= xmlMapper.readValue(s1, TestBO.class);} catch (JsonProcessingException e) {e.printStackTrace();}System.out.println(testBO1);}
}

打印结果如下：
成功将xml参数转换成bean.

{"orderno":"123456789","ordertype":2,"payorderno":"666555"}
<data><orderno>123456789</orderno><ordertype>2</ordertype><ticketno>666555</ticketno></data>
<?xml version="1.0" encoding="gb2312"?><data><orderno>123456789</orderno><ordertype>2</ordertype><ticketno>666555</ticketno></data>
LoginBO(orderno=123456789, ordertype=2, payorderno=666555)