Java接收xml格式参数转为json的方法

更新时间：2024年11月12日 09:50:00 作者：yogima

文章主要介绍了如何使用JAXB将XML格式的参数接收并转换为Java实体类,然后将实体类转换为JSON格式,文中提到在实体类中使用`@XmlElement`和`@JsonProperty`注解的重要性,以及如何处理复杂的XML结构

1、定义实体类

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
@XmlRootElement(name = "User")
@Setter
@ToString
public class User {
    private String name;
    @XmlElement(name = "username")
    public String getName() {
        return name;
    }
}

注意这里需要把@XmlElement注解用在get方法上，实际使用时发现如果直接作用在字段上会报错。

2、使用jaxb对接转为实体类

import javax.xml.bind.JAXBContext;
import javax.xml.bind.Unmarshaller;
import java.io.StringReader;
public User fromXml(String xmlData) throws Exception {
    JAXBContext jaxbContext = JAXBContext.newInstance(User.class);
    Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
    return (User) unmarshaller.unmarshal(new StringReader(xmlData));
}

这里的xmlData示例：<User><username>yogima<username></User>
就可以转换到实体类对应的字段中了

3、转为json

import com.fasterxml.jackson.databind.ObjectMapper;
public String toJson(User user) throws Exception {
    ObjectMapper objectMapper = new ObjectMapper();
    return objectMapper.writeValueAsString(user);
}

实际上返回给前端的时候也不需要自己手动去writeValueAsString，这里只是做个示例。
上述转为json后字段名使用的还是name，如果需要保持字段名为"username"，只需要加上@JsonProperty。

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import com.fasterxml.jackson.annotation.JsonProperty;
@XmlRootElement(name = "User")
@Setter
@ToString
public class User {
	@JsonProperty("username")
    private String name;
    @XmlElement(name = "username")
    public String getName() {
        return name;
    }
}

这样看注解有时候还挺多此一举的，直接User类中的字段用username就可以不需要注解；但是比如说返回的字段是<ABC_AA>12345</ABC_AA><AAA>111</AAA>，如果我不去规定@JsonProperty和@XmlElement，直接把字段定义成大写的ABC_AA和AAA，也可以接收到xml参数，但是不符合Java命名规范，而且会发现AAA默认转出来的json字段叫做aaa，而ABC_AA转出来则是abc_AA.所以我们还是加上注释会更优雅一些。

@JsonProperty("ABC_AA")
private String abcAa;
@XmlElement(name = "ABC_AA")
public String getAbcAa() {
    return abcAa;
}

4、返回的xml较为复杂，需要提取

import javax.xml.bind.JAXBContext;
import javax.xml.bind.Unmarshaller;
public class XmlConvertTest {
    public static void main(String[] args) throws Exception{
    //模拟较为复杂的xml数据
    String xmlData = "<response><head><response_id>AA</response_id><status_code>200</status_code></head><result><![CDATA[<row><AAA>111</AAA><BBB>222</BBB></row><row><AAA>333</AAA><BBB>444</BBB></row>]]></result></response>";
    //使用正则取出需要的数据内容 即<row><AAA>111</AAA><BBB>222</BBB></row><row><AAA>333</AAA><BBB>444</BBB></row>
    String cdataContent = xmlData.replaceAll("(?s).*?<result><!\\[CDATA\\[(.*?)]]></result>.*", "$1");
    // 如果需要提取head部分 即<response_id>AA</response_id><status_code>200</status_code>
    // String headContent = xmlData.replaceAll("(?s).*?<head>(.*?)</head>.*", "$1");
    //裹上rows
    String wrappedContent = "<rows>" + cdataContent + "</rows>";
    JAXBContext jaxbContext = JAXBContext.newInstance(XmlTestDTO.class);
    Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
    XmlTestDTO dto = (XmlTestDTO) unmarshaller.unmarshal(new StringReader(wrappedContent));
    System.out.println(dto);
}

对应的XmlTestDTO：

@XmlRootElement(name = "rows")
@Setter
@ToString
public class XmlTestDTO {
	private List<XmlRowTest> rows = new ArrayList<>();
    @XmlElement(name = "row") // 对应每个 <row> 元素
    public List<XmlRowTest> getRows() {
        return rows;
    }
    //XmlRowTest不需要作为根元素的话，这里可以不用@XmlRootElement注解
    //@XmlRootElement(name = "row")
	@Setter
	@ToString
    public static class XmlRowTest{
        @JsonProperty("AAA")
        private String aaa;
        @XmlElement(name = "AAA")
        public String getAaa() {
            return aaa;
        }
    }
}

拿到XmlTestDTO dto后只要使用dto.getRows()就能对List<XmlRowTest>进行遍历了

到此这篇关于Java接收xml格式参数转为json的文章就介绍到这了,更多相关java xml转为json内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java中bcrypt算法实现密码加密的方法步骤
我们可以在Spring Boot和SSM中实现密码加密,使用bcrypt算法可以保障密码的安全性,并且减少了手动编写哈希函数的工作量,本文就来详细的介绍一下,感兴趣的可以了解一下
2023-08-08
Intellij idea远程debug连接tomcat实现单步调试
这篇文章主要介绍了Intellij idea远程debug连接tomcat实现单步调试，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-05-05
SpringBoot多数据库连接(mysql+oracle)的实现
这篇文章主要介绍了SpringBoot多数据库连接(mysql+oracle)的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2021-03-03
在netty中使用native传输协议的方法
这篇文章主要介绍了在netty中使用native传输协议,这里我们只以Kqueue为例介绍了netty中native传输协议的使用，需要的朋友可以参考下
2022-05-05
Java如何找出数组中重复的数字
这篇文章主要为大家详细介绍了Java如何找出数组中重复的数字，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2018-08-08
Java使用POI解析带图片的excel文件(简洁好用!)
这篇文章主要给大家介绍了关于Java如何使用POI解析带图片的excel文件的相关资料,最近项目需要读取excel中的信息,带图片,所以这里给大家总结下,需要的朋友可以参考下
2023-08-08
WebSocket+Vue+SpringBoot实现语音通话的使用示例
本文主要介绍了WebSocket+Vue+SpringBoot实现语音通话的使用示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
2023-11-11
idea创建maven父子工程导致子工程无法导入父工程依赖
创建maven父子工程时遇到一个问题，本文主要介绍了idea创建maven父子工程导致子工程无法导入父工程依赖，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2022-04-04
50 道Java 线程面试题(经典）
java 线程面试题是比较热门的面试题，下面小编给大家分享了50道java线程面试题必掌握，大家来一起学习吧为面试好好准备吧
2016-11-11
关于IDEA创建spark maven项目并连接远程spark集群问题
这篇文章主要介绍了IDEA创建spark maven项目并连接远程spark集群,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-08-08