使用JDK的JAXB将XML转化为JAVA对象，原生支持

忘是亡心i 2023-10-05 17:23 70阅读 0赞

工作中有时候会对接XML的数据，其实JDK中的JAXB已经集成了相应的API，可以将XML转化为JAVA对象

使用起来只需关注几个注解，由于是原生支持，也不用引入第三方JAR包，总体来说还算方便。

ps:JDK1.6开始支持JAXB

本人为了写实体方便，引入lombok，这个自行取舍，不是必要的

使用的是Maven管理jar包，引入lombok依赖坐标

<dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </dependency>

1、先封装一个转换的工具类

import javax.xml.bind.JAXBContext;
    import javax.xml.bind.JAXBException;
    import javax.xml.bind.Unmarshaller;
    import java.io.FileNotFoundException;
    import java.io.FileReader;
    import java.io.StringReader;
    
    /**
     * 转换Xml工具类
     * @Author: WgRui
     * @Date: 2020/12/23
     */
    public class ConvertXmlUtil {
    
    
        /**
         * 字符串xml转换成Java对象
         * @param mapObject xml映射实体
         * @param xmlStr xml字符串
         * @return: java对象
         */
        @SuppressWarnings("unchecked")
        public static Object convertXmlStrToObject(Class mapObject, String xmlStr) {
    
            Object javaObject = null;
    
            try {
                JAXBContext context = JAXBContext.newInstance(mapObject);
                Unmarshaller unmarshaller = context.createUnmarshaller();
                StringReader sr = new StringReader(xmlStr);
                javaObject = unmarshaller.unmarshal(sr);
            } catch (JAXBException e) {
                e.printStackTrace();
            }
    
            return javaObject;
    
        }
    
    
        /**
         * 将file类型的xml转换成Java对象
         * @param mapObject xml映射实体
         * @param xmlPath xml文件路径
         * @return java对象
         */
        @SuppressWarnings("unchecked")
        public static Object convertXmlFileToObject(Class mapObject, String xmlPath) {
    
            Object javaObject = null;
    
            try {
                JAXBContext context = JAXBContext.newInstance(mapObject);
                Unmarshaller unmarshaller = context.createUnmarshaller();
                FileReader fr = null;
                try {
                    fr = new FileReader(xmlPath);
                } catch (FileNotFoundException e) {
                    e.printStackTrace();
                }
                javaObject = unmarshaller.unmarshal(fr);
            } catch (JAXBException e) {
                e.printStackTrace();
            }
    
            return javaObject;
    
        }
    
    }

2、随便找了一个完整的XML报文，观察结构，编写对应JAVA实体类

//原始的xml报文字符串
            String srcRspXml = "<soap:Envelope xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">"+
                    "<soap:Body>"+
                    "<getCharFontsResponse xmlns=\"http://WebXml.com.cn/\">"+
                    "<getCharFontsResult>"+
                    "<string>1</string>"+
                    "<string>9</string>"+
                    "<string>N</string>"+
                    "</getCharFontsResult>"+
                    "</getCharFontsResponse>"+
                    "</soap:Body>"+
                    "</soap:Envelope>";

其实不难看出，<getCharFontsResult>这个标签里才是我们要的数据，因此它就作为根元素了

理所当然，<string>便是子元素，只有一种子元素，且不止一个，那便是一个数组了，根据实际情况来

实体类如下

import lombok.AllArgsConstructor;
    import lombok.Data;
    import lombok.NoArgsConstructor;
    import javax.xml.bind.annotation.*;
    import java.util.List;
    
    @XmlAccessorType(XmlAccessType.FIELD)
    @XmlRootElement(name = "getCharFontsResult")//根元素名
    @XmlType(propOrder = {"strings"})//子元素的排序，多个用逗号隔开
    @Data
    @AllArgsConstructor
    @NoArgsConstructor
    public class GetCharFontsResult {
    
        @XmlElement(name = "string")//子元素名
        List<String> strings;
    
    }

ps：@XmlAccessType注解有四种值类型，一般是使用第一种
    XmlAccessType.FIELD：映射这个类中的所有字段到XML
    XmlAccessType.PROPERTY：映射这个类中的属性（get/set方法）到XML
    XmlAccessType.PUBLIC_MEMBER：将这个类中的所有public的field或property同时映射到XML（默认）
    XmlAccessType.NONE：不映射

写一个测试类，测试一下

public class Test {
        public static void main(String[] args) {
    
            //1、XML字符串转JAVA对象
    
            //原始的xml报文字符串
            String srcRspXml = "<soap:Envelope xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">"+
                    "<soap:Body>"+
                    "<getCharFontsResponse xmlns=\"http://WebXml.com.cn/\">"+
                    "<getCharFontsResult>"+
                    "<string>1</string>"+
                    "<string>9</string>"+
                    "<string>N</string>"+
                    "</getCharFontsResult>"+
                    "</getCharFontsResponse>"+
                    "</soap:Body>"+
                    "</soap:Envelope>";
    
            //截取有用的xml
            int start = srcRspXml.indexOf("<getCharFontsResult>");
            int end = srcRspXml.indexOf("</getCharFontsResult>");
            String usefulRspXml = srcRspXml.substring(start, end + 21);
            //打印一下
            System.out.println("有用的xml：" + usefulRspXml);
    
            //调用工具类xml字符串转Java对象方法
            GetCharFontsResult javaObject1 = (GetCharFontsResult) ConvertXmlUtil.convertXmlStrToObject(GetCharFontsResult.class, usefulRspXml);
    
            //打印一下转化结果
            System.out.println("xml字符串转化结果:" + javaObject1);
    
            //=================================================================================================================================
    
            //2、XML文件转JAVA对象
    
            //xml文件路径
            //注意:这文件里的xml内容已经是取了有用的部分
            String xmlFilePath = "F:\\srcRsp.xml";
    
            //调用工具类xml字符串转Java对象方法
            GetCharFontsResult javaObject2 = (GetCharFontsResult) ConvertXmlUtil.convertXmlFileToObject(GetCharFontsResult.class, xmlFilePath);
    
            //打印一下转化结果
            System.out.println("xml文件转化结果:" + javaObject1);
    
        }
    }

执行一下main方法，可以看到两种方式都是正常输出的

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjU1OTU3NA_size_16_color_FFFFFF_t_70][]

到这里转换就完成了

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjU1OTU3NA_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/2021010817275723.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjU1OTU3NA==,size_16,color_FFFFFF,t_70