jackson解析xml

最近在与某系统对接的时候，对方的服务基于webservice实现的，令人非常不爽的是，对方的字段命名是非常不规范的，有对接的同学就知道了，但是这些系统可能在最近十年都不会更换，所以我们只能选择忍受了。这里就不点名是那些厂商了。 废话不多说，下面开始正题。

xml解析

在工作我解析常用的方式有：

1. 将xml递归解析为JSONObject对象或者是Map
2. 将xml解析指定的JavaBean

以上两种方式各有利弊，第一种如果不需要取具体层级里面的值是很方便的，只需要将值解析出来进行简单的传递给前端就行。但是如果要遍历或者去具体节点下的值就麻烦了，尤其是在层级很深的情况，用Java在后台操作是很痛苦的。第二种的优势就是取值很方便，因为是JavaBean对象可以调用其属性对应的get方法即可获取指定节点的值，但是弊端就是需要使用注解配置属性在XML中对应的名称，如果接口中的xml改变了则需要改变Java代码。但是综合考虑下本次对接项目还是使用第二种方式比较适合，所以总结了一些使用情况，需要给后面开发类似业务的同学一些帮组。

核心依赖

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-core</artifactId>
    <version>2.8.11</version>
</dependency>

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.8.11</version>
</dependency>

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

xml转Object

XML

<?xml version="1.0" encoding="utf-8"?>

<student>
  <studentName>张三</studentName>
  <nainling>25</nainling>
  <dh>18858863333</dh>
  <rs>
    <array>
      <acc01>89.50</acc01>
      <acc02>100.00</acc02>
      <acc03>91.00</acc03>
    </array>
    <array>
      <acc01>78.50</acc01>
      <acc02>69.00</acc02>
      <acc03>88.90</acc03>
    </array>
  </rs>
</student>

JavaBean

Base

这里为了测试集成的属性是否可以被解析，最后的结果是可以的。

@JacksonXmlProperty注解是标注该属性在xml中对应的节点名称，这就是为了解决某某系统接口字段命名不规范的利器。

package cn.gogpay.dcb.socialsecurity.xml;

import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;

/**
 * {描述}
 *
 * @author yangxianxi@gogpay.cn
 * @date 2018/7/24 11:45
 */
public class Base {

    @JacksonXmlProperty(localName = "dizhi")
    private String address;

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }
}

Student

@JacksonXmlRootElement 这个注解是指名根节点，见名知意不用多说。

重点是@JacksonXmlElementWrapper将某节点下单元素解析为Array或者Collection类型，因为除了公共字段外，其他字段都可能是变化的所以在集合哪儿使用了泛型。

package cn.gogpay.dcb.socialsecurity.xml;

import com.alibaba.fastjson.JSONObject;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;

import java.util.List;

/**
 * {描述}
 *
 * @author yangxianxi@gogpay.cn
 * @date 2018/7/24 10:59
 */
@JacksonXmlRootElement(localName = "student")
public class Student<T> extends Base{

    @JacksonXmlProperty(localName = "studentName")
    private String name;

    @JacksonXmlProperty(localName = "nainling")
    private Integer age;

    @JacksonXmlProperty(localName = "dh")
    private String phone;

    @JacksonXmlProperty(localName = "array")
    @JacksonXmlElementWrapper(localName = "rs")
    private List<T> grades;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public String getPhone() {
        return phone;
    }

    public void setPhone(String phone) {
        this.phone = phone;
    }

    public List<T> getGrades() {
        return grades;
    }

    public void setGrades(List<T> grades) {
        this.grades = grades;
    }

    @Override
    public String toString() {
        return JSONObject.toJSONString(this);
    }
}

Score

package cn.gogpay.dcb.socialsecurity.xml;

import com.alibaba.fastjson.JSONObject;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;

/**
 * 测试数据
 *
 * @author yangxianxi@gogpay.cn
 * @date 2018/7/24 11:28
 */
public class Score {

    @JacksonXmlProperty(localName = "acc01")
    private Double langue;

    @JacksonXmlProperty(localName = "acc02")
    private Double math;

    @JacksonXmlProperty(localName = "acc03")
    private Double english;

    public Double getLangue() {
        return langue;
    }

    public void setLangue(Double langue) {
        this.langue = langue;
    }

    public Double getMath() {
        return math;
    }

    public void setMath(Double math) {
        this.math = math;
    }

    public Double getEnglish() {
        return english;
    }

    public void setEnglish(Double english) {
        this.english = english;
    }

    @Override
    public String toString() {
        return JSONObject.toJSONString(this);
    }
}

Test

    String xml = "<?xml version=\"1.0\" encoding=\"gb2312\" standalone=\"yes\"?><student><dizhi>北京三里屯</dizhi><studentName>张三</studentName><nainling>25</nainling><dh>18858863333</dh><rs><array><acc01>89.50</acc01><acc02>100.00</acc02><acc03>91.00</acc03></array><array><acc01>78.50</acc01><acc02>69.00</acc02><acc03>88.90</acc03></array></rs></student>";
    ObjectMapper objectMapper = new XmlMapper();

    Student<Score> student = objectMapper.readValue(xml, Student.class);
    System.out.println(student);
    String result = objectMapper.writeValueAsString(student);
    System.out.println(result);

输出结果

{"address":"北京三里屯","age":25,"grades":[{"acc01":"89.50","acc02":"100.00","acc03":"91.00"},{"acc01":"78.50","acc02":"69.00","acc03":"88.90"}],"name":"张三","phone":"18858863333"}
<student><dizhi>北京三里屯</dizhi><studentName>张三</studentName><nainling>25</nainling><dh>18858863333</dh><rs><array><acc01>89.50</acc01><acc02>100.00</acc02><acc03>91.00</acc03></array><array><acc01>78.50</acc01><acc02>69.00</acc02><acc03>88.90</acc03></array></rs></student>

最后将常用的解析封装了工具类，项目地址查看下面git

gitee: https://gitee.com/xiyu2016/xmlparse.git