bean和xml相互转换工具类

因为最近对接接口，需要xml和bean的相互转换，所以就写下这个工具类，记录一下，方便日后使用。

JAXB API介绍

① 常用API

• JAXBContext类，是应用的入口，通过该类创建序列化和反序列化对象，也即编组对象和解组对象；
• Marshaller 编组接口，将Java对象序列化为XML数据；
• Unmarshaller 解组接口，将XML数据反序列化为Java对象。

② 常用注解

• @XmlRootElement，将Java类或枚举映射成XML元素根节点，是唯一一个必须注解，name属性指定根节点名称，不指定默认为类名的小写；
• @XmlElement，将Java类的一个属性映射为XML节点元素，name属性可自定义元素名；
• @XmlAttribute，将Java类的一个属性映射为XML节点元素的属性，name属性可自定义属性名；
• @XmlType，将Java类或枚举类型映射到XML模式类型，常与@XmlRootElement、@XmlAccessorType共用，propOrder属性定义字段生成的XML节点顺序；
• @XmlAccessorType，控制字段或属性的序列化。属性XmlAccessType有4个常量值:FIELD表示JAXB将自动绑定Java类中的每个非静态的（static）、非瞬态的（由@XmlTransient标注）字段到XML；PROPERTY表示java对象中所有通过getter/setter方式绑定成属性到XML；PUBLIC_MEMBER表示Java对象中所有的public访问权限的成员变量和通过getter/setter方式访问的成员变量，该值为默认值；NONE表示Java对象的所有属性都不映射为XML的元素；
• @XmlAccessorOrder，控制JAXB 绑定类中属性和字段的排序，有两个属性，AccessorOrder.ALPHABETICAL——对生成的XML元素按字母书序排序，XmlAccessOrder.UNDEFINED——不排序，默认为该值；
• @XmlJavaTypeAdapter，自定义适配器（即扩展抽象类XmlAdapter并覆盖marshal()和unmarshal()方法），解决日期（Date）,数字（Number）格式化问题；
• @XmlElementWrapper ，对于数组或集合（即包含多个元素的成员变量），生成一个包装该数组或集合的XML元素（称为包装器），该注解只能用在集合上；
• @XmlTransient ，用于标示在由Java对象映射XML时，忽略此属性，在生成的XML文件中将不出现此元素。

③ 实际应用中注意的问题

• 如果JavaBean中定义了有参的构造器，那么必须同时定义无参构造器，否则转XML会抛无默认构造函数的异常;
• 成员变量值为NULL时，将不会映射成对应的XML元素——由于基本数据类型默认值不为空，所以基本数据类型不设值也会映射成XML元素，值为默认值,所以如果模型需要基本数据，在属性定义的时候尽量使用包装类型；
• @XmlAccessorType 注解中如果属性值为XmlAccessType.FIELD，则表示通过成员变量来映射，set/get方法上的映射注解就是多余的，所以如果此时set/get方法上再标注元素或者属性映射注解，将抛属性重复性异常；属性值为XmlAccessType.NONE不映射为XML元素的前提是Java字段或set/get方法上都没有映射注解；
• @XmlType propOrder属性能够自定义字段的排序，该属性如果设置，要么写成{}的形式，否则在就必须将所有@XmlElement标注或者没有@XmlElement标注的但实际上会被映射为XML节点的字段添加到排序列表，不然会抛异常；如果propOrder属性设置有值，@XmlAccessorOrder注解的元素排序规则将失效；

工具类编写

BeanXmlUtils：

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import javax.xml.bind.Unmarshaller;
import java.io.StringReader;
import java.io.StringWriter;

/**
 * @author compass
 * @date 2023-07-25
 * @since 1.0
 **/
public class BeanXmlUtils {


    /**
     * bean转xml
     * @param obj 需要转换的对象
     * @param load 对应的class
     * @param config isFormat:是否需要格式[默认:false],charSet:字符集[默认:utf-8],xmlHeader:是否需要xml头部[默认:false]
     * @return java.lang.String
     * @author compass
     * @date 2023/7/25 21:04
     * @since 1.0.0
     **/
    public static String beanToXml(Object obj, Class<?> load,Object... config) {
        String xmlStr = null;
        try {
            boolean isFormat = false;
            String charSet = "utf-8";
            boolean xmlHeader = false;
            if (config.length>=1){
                isFormat = (Boolean) config[0];
                if (config.length>=2){
                    charSet =  (String)config[1];
                }
                if (config.length>=3){
                    xmlHeader = (Boolean)config[2];
                }
            }
            JAXBContext context = JAXBContext.newInstance(load);
            Marshaller marshaller = context.createMarshaller();
            marshaller.setProperty(Marshaller.JAXB_FRAGMENT, xmlHeader);
            marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, isFormat);
            marshaller.setProperty(Marshaller.JAXB_ENCODING,charSet);
            StringWriter writer = new StringWriter();
            marshaller.marshal(obj, writer);
            xmlStr = writer.toString();
        } catch (JAXBException e) {
           e.printStackTrace();
        }
        return xmlStr;
    }

    /**
     * xml转bean
     * @param str
     * @param load
     * @return T
     * @author compass
     * @date 2023/7/25 21:04
     * @since 1.0.0
     **/
    public  static <T>  T  xmlToBean(String str, Class<T> load) {
        Object object = null;
        try {
            JAXBContext context = JAXBContext.newInstance(load);
            Unmarshaller unmarshaller = context.createUnmarshaller();
            object = unmarshaller.unmarshal(new StringReader(str));
        } catch (JAXBException e) {
           e.printStackTrace();
        }
        return  (T)object;
    }

    public static void main(String[] args) {
        String str =
                "<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n" +
                "<root>\n" +
                "    <code>0</code>\n" +
                "    <data>\n" +
                "        <patientId>101</patientId>\n" +
                "        <cardNo>501</cardNo>\n" +
                "        <qrCode>165165</qrCode>\n" +
                "    </data>\n" +
                "</root>";
        CommonResponse wuResponse = xmlToBean(str, CommonResponse.class);


        CommonResponse response = new CommonResponse();
        response.setCode("0");
        RequestResult wuResult = new RequestResult();
        wuResult.setCardNo("1");
        wuResult.setPatientId("102");
        wuResult.setQrCode("501");
        response.setData(wuResult);

        String responseXml = beanToXml(response, CommonResponse.class,true);
        System.out.println("xmlToBean:"+wuResponse);
        System.out.println("beanToXml:"+responseXml);
    }
}

具体的两个实体类：

CommonResponse:

@XmlRootElement(name = "root")
public class CommonResponse {
    private String code;
    private RequestResult data;

    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }

    public RequestResult getData() {
        return data;
    }

    public void setData(RequestResult data) {
        this.data = data;
    }

    @Override
    public String toString() {
        return "WuResponse{" +
                "code='" + code + '\'' +
                ", data=" + data +
                '}';
    }
}

RequestResult:

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;

/**
 * @author compass
 * @date 2023-07-25
 * @since 1.0
 **/
@XmlRootElement(name = "data")
@XmlAccessorType(XmlAccessType.FIELD)
public class RequestResult {
    private String patientId;
    private String cardNo;
    private String qrCode;
    public String getPatientId() {
        return patientId;
    }

    public void setPatientId(String patientId) {
        this.patientId = patientId;
    }

    public String getCardNo() {
        return cardNo;
    }

    public void setCardNo(String cardNo) {
        this.cardNo = cardNo;
    }

    public String getQrCode() {
        return qrCode;
    }

    public void setQrCode(String qrCode) {
        this.qrCode = qrCode;
    }

    @Override
    public String toString() {
        return "WuResult{" +
                "patientId='" + patientId + '\'' +
                ", cardNo='" + cardNo + '\'' +
                ", qrCode='" + qrCode + '\'' +
                '}';
    }
}

输出结果：文章来源地址https://www.toymoban.com/news/detail-609903.html

xmlToBean: WuResponse{code='0', data=WuResult{patientId='101', cardNo='501', qrCode='165165'}}
beanToXml:
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<root>
    <code>0</code>
    <data>
        <patientId>102</patientId>
        <cardNo>1</cardNo>
        <qrCode>501</qrCode>
    </data>
</root>

到了这里，关于bean和xml相互转换工具类的文章就介绍完了。如果您还想了解更多内容，请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章，希望大家以后多多支持TOY模板网！