logo头像

From zero to HERO

Java中XML和JSON互转

1. 前言

最近在折腾移动支付,什么移动支付、支付宝支付、银联支付、还有什么国外的PayPal。有的支付系统还用着XML这种数据格式,和我们现在流行的JSON不太符合。最开始我使用了DOM4J这个老牌XML解析库。写完DEMO后有人告诉我Jackson更加简单些,我尝试了一下确实更加方便简单,所以就来分享给大家。

2. 依赖

Spring Boot或者Spring Cloud的Web项目中只需要引入:

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

这个是jackson的的XML格式化模块,已经自动加入了依赖池。

3. XML与Java对象互转

XML和JSON互相转换的流程都是先转换为Java对象,然后再转换为目标类型。

XmlMapper

XML转对象需要定义一个XmlMapper,这个对应了转换JSON的ObjectMapper,甚至XmlMapperObjectMapper的子类。我们来声明一个XmlMapper,你可以new一个,如果你采用了默认的配置的话。

XmlMapper xmlMapper = new XmlMapper();

如果你需要定制推荐使用建造者的方式,比如下面:

  XmlMapper build = XmlMapper.builder()
                 //  忽略实体类没有对应属性    如果为 true 会抛出异常
                .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES,false)
                // 忽略null
                .serializationInclusion(JsonInclude.Include.NON_NULL)
                // 属性使用 驼峰首字母小写
                .propertyNamingStrategy(PropertyNamingStrategy.LOWER_CAMEL_CASE)
                .build();

演示

接下来我们来用一个DEMO进行演示,先定义一个test.xml的XML文件,内容为

<?xml version="1.0" encoding="UTF-8" ?>
<User>
    <username>felord.cn</username>
    <age>18</age>
    <created><![CDATA[<2020-10-22>]]></created>
</User>

<![CDATA[]]>比转义字符要香的多,可读性更强。

对应的实体类为:

@Data
public class User {
 private String username;
 private Integer age;
 // private String created;
}

然后利用上面构造的builder来进行转换操作:

ClassPathResource classPathResource = new ClassPathResource("./test.xml");
User user = build.readValue(classPathResource.getFile(), User.class);
// Java  User(username=felord.cn, age=18, created=<2020-10-22>) 
System.out.println("xml file to Java Object " + user);
String s = build.writeValueAsString(user);
// <User><username>felord.cn</username><age>18</age><created>&lt;2020-10-22></created></User>
System.out.println("Java Object to xml string " + s);
User u = build.readValue(s, User.class);
// Java User(username=felord.cn, age=18, created=<2020-10-22>)
System.out.println("xml string to Java Object" + u);

既然能够转对象那么再转JSON也没啥难度了。

当然也支持注解的方式。

4. 总结

Jackson类库是Spring Boot 默认集成的JSON库,甚至不单单是JSON库,它还可以用来处理XML。集成XML操作能力也非常简单,使用起来也不是很复杂。在我看来最大的优势是不用引入其它的额外框架来处理,依赖种类最少的系统开发维护起来是最省心的。好了今天的分享就到这里,我是:码农小胖哥。多多关注哦!

评论系统未开启,无法评论!