JAXBContext 实现 XML与bean互相转换

JAXBContext实现 XML与bean互相转换

效果如下：

bean转xml

xml转bean

示例如下：

XML:

String xml=" " +
                " " +
                    "" +
                        "" +
                    "serverAddress> " +
                    "<userlist>" +
                        "<user>"+
                            "<id>1111id>"+
                            "<name>张三name>"+
                        "user>"+
                        "<user>"+
                            "<id>222id>"+
                            "<name>李四name>"+
                        "user>"+
                    "userlist>"+
                "config>";

XML转对象（bean）

 demo demo = XmlUtil.toBean(demo.class, xml);

结果：

对象(bean)转XML
demo为上面的xml转对象 bean

demo.setType("string");//config 节点属性type 赋值
String toXml = XmlUtil.toXml(demo);

结果：

<config type="string">
    <serverAddress>serverAddress>
    <userlist>
        <user>
            <id>1111id>
            <name>张三name>
        user>
        <user>
            <id>222id>
            <name>李四name>
        user>
    userlist>
config>

bean结构如下：

demo

package cn.test;
import cn.core.xml.CdataXmlAdapter;
import lombok.Data;
import javax.xml.bind.annotation.*;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import java.io.Serializable;
import java.util.List;

@Data
@XmlRootElement(name = "config") //根节点
@XmlAccessorType(XmlAccessType.FIELD)
public class demo implements Serializable {
	
	//用来处理大字符串，转成xml时带 自定义注解，后面有代码
    @XmlJavaTypeAdapter(CdataXmlAdapter.class) 
    //XmlElement 表示当前节点 name对应节点名称
    @XmlElement(name = "serverAddress")
    private String address;
	//XmlAttribute 根节点的属性（在哪个对象中定义就表示该节点的属性）转xml时用
    @XmlAttribute(name = "type")
    private String type;

	//XmlElementWrapper 表示集合节点 userlist
    @XmlElementWrapper(name = "userlist")
     //XmlElement 表示当前节点 name对应节点名称
    @XmlElement(name = "user")
    private List<user> users;
}

user

package cn.test;
import lombok.Data;
import javax.xml.bind.annotation.*;
import java.io.Serializable;
@Data
@XmlRootElement(name = "user")
@XmlAccessorType(XmlAccessType.FIELD)
public class user implements Serializable {

    @XmlElement(name = "id")
    private String id;

    @XmlElement(name = "name")
    private String name;

}

XmlUtil

package cn.core.xml;

import cn.hutool.json.JSONUtil;
import java.io.Reader;
import java.io.StringReader;
import java.io.StringWriter;
import java.lang.reflect.Proxy;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.Marshaller;
import javax.xml.bind.Unmarshaller;
import javax.xml.parsers.SAXParserFactory;
import javax.xml.stream.XMLOutputFactory;
import javax.xml.stream.XMLStreamWriter;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.sax.SAXSource;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.stream.StreamSource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.xml.sax.InputSource;
import org.xml.sax.XMLReader;

public class XmlUtil {
    private static final Logger log = LoggerFactory.getLogger(XmlUtil.class);

    public XmlUtil() {
    }
    /**
    *XML 转对象bean
    */
    public static <T> T toBean(Class<T> c, String xmlStr) {
        try {
            Reader reader = new StringReader(xmlStr);
            Throwable var3 = null;

            Object var9;
            try {
                JAXBContext jaxbContext = JAXBContext.newInstance(new Class[]{c});
                Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
                //根节点config带有属性，直接读取时报错，以下三行代码，就会忽略属性
                SAXParserFactory sax = SAXParserFactory.newInstance();
                sax.setNamespaceAware(false);
                XMLReader xmlReader = sax.newSAXParser().getXMLReader();
                Source source = new SAXSource(xmlReader, new InputSource(reader));
                var9 = unmarshaller.unmarshal(source);
            } catch (Throwable var19) {
                var3 = var19;
                throw var19;
            } finally {
                if (reader != null) {
                    if (var3 != null) {
                        try {
                            reader.close();
                        } catch (Throwable var18) {
                            var3.addSuppressed(var18);
                        }
                    } else {
                        reader.close();
                    }
                }
            }
            return var9;
        } catch (Exception var21) {
            log.error("toBean Exception: {}", xmlStr, var21);
            return null;
        }
    }
 /**
    *对象bean转 XML
    */
    public static String toXml(Object obj) {
        try {
            StringWriter writer = new StringWriter();
            XMLStreamWriter streamWriter = XMLOutputFactory.newInstance().createXMLStreamWriter(writer);
            XMLStreamWriter cdataStreamWriter = (XMLStreamWriter)Proxy.newProxyInstance(streamWriter.getClass().getClassLoader(), streamWriter.getClass().getInterfaces(), new CdataHandler(streamWriter));
            JAXBContext jc = JAXBContext.newInstance(new Class[]{obj.getClass()});
            Marshaller marshaller = jc.createMarshaller();
            marshaller.setProperty("jaxb.encoding", "UTF-8");
            marshaller.marshal(obj, cdataStreamWriter);
            return indentFormat(writer.toString());
        } catch (Exception var6) {
            log.error("toXml Exception: {}", JSONUtil.toJsonStr(obj), var6);
            return null;
        }
    }

	/**
	*格式化
	*/
    private static String indentFormat(String xml) {
        try {
            TransformerFactory factory = TransformerFactory.newInstance();
            Transformer transformer = factory.newTransformer();
            transformer.setOutputProperty("indent", "yes");
            transformer.setOutputProperty("omit-xml-declaration", "yes");
            transformer.setOutputProperty("encoding", "UTF-8");
            transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
            StringWriter formattedStringWriter = new StringWriter();
            transformer.transform(new StreamSource(new StringReader(xml)), new StreamResult(formattedStringWriter));
            return "\n" + formattedStringWriter;
        } catch (Exception var4) {
            log.error("indentFormat Exception", var4);
            return "";
        }
    }

    public static void main(String[] args) {
        TestNode node = new TestNode("key", "345435");
        String xml = toXml(node);
        TestNode testNode = (TestNode)toBean(TestNode.class, xml);
        System.out.println(xml);
    }
}

CdataXmlAdapter 处理大字符串 转xml时带

package cn.core.xml;
import javax.xml.bind.annotation.adapters.XmlAdapter;
public class CdataXmlAdapter extends XmlAdapter<String, String> {
    public CdataXmlAdapter() {
    }
    public String marshal(String arg0) throws Exception {
        return " + arg0 + "]]>";
    }
    public String unmarshal(String arg0) throws Exception {
        return arg0;
    }
}

JAXBContext解析XML的常用注解

1.将 xml 文件中的各个节点和属性信息创建对应的Java模型

2.在Java模型中的创建与 xml 文件对应的节点和属性需要用注解来表示
@XmlRootElement 将一个Java类映射为一段XML的根节点
参数：
name 定义这个根节点的名称
namespace 定义这个根节点命名空间

@XmlAccessorType 定义映射这个类中的何种类型需要映射到XML。可接收四个参数，分别是：
XmlAccessType.PROPERTY：映射这个类中的属性（get/set方法）到XML
XmlAccessType.PUBLIC_MEMBER：将这个类中的所有public的field或property同时映射到XML（默认）
XmlAccessType.NONE：不映射

@XmlElement 指定一个字段或get/set方法映射到XML的节点。如，当一个类的XmlAccessorType 被标注为PROPERTY时，在某一个没有get/set方法的字段上标注此注解，即可将该字段映射到XML。
参数：
defaultValue 指定节点默认值
name 指定节点名称
namespace 指定节点命名空间
required 是否必须（默认为false）
nillable 该字段是否包含 nillable=”true” 属性（默认为false）
type 定义该字段或属性的关联类型

@XmlAttribute 指定一个字段或get/set方法映射到XML的属性。
参数：
name 指定属性名称
namespace 指定属性命名空间
required 是否必须（默认为false）

@XmlTransient 定义某一字段或属性不需要被映射为XML。
如，当一个类的XmlAccessorType 被标注为PROPERTY时，在某一get/set方法的字段上标注此注解，那么该属性则不会被映射。

@XmlType 定义映射的一些相关规则
参数：
propOrder 指定映射XML时的节点顺序
factoryClass 指定UnMarshal时生成映射类实例所需的工厂类，默认为这个类本身
factoryMethod 指定工厂类的工厂方法
name 定义XML Schema中type的名称
namespace 指定Schema中的命名空间

@XmlElementWrapper 为数组元素或集合元素定义一个父节点。

@XmlJavaTypeAdapter 自定义某一字段或属性映射到XML的适配器。
如，类中包含一个接口，我们可以定义一个适配器（继承自 javax.xml.bind.annotation.adapters.XmlAdapter类），指定这个接口如何映射到XML。

@XmlSchema 配置整个包的namespace，这个注解需放在package-info.java文件中

JAXBContext 为多个子节点添加属性和同一节点添加多个属性