JAXB实现XML与Java对象的转化

妖狐艹你老母 2023-05-31 15:19 9阅读 0赞

# 1. JAXB介绍 #

JAXB是一项可以根据XML Schema产生Java类的技术。该过程中，JAXB也提供了将XML实例文档反向生成java对象树的方法，并能将Java对象树的内容重新写到XML实例文档。从另外一个方面讲，JAXB提供了快速而简便的方法将XML模式绑定到java表示。

# 2. JDK中JAXB相关的重要Class和Interface #

1.  JAXBContext类，是应用的入口，用于管理XML/Java绑定信息；
2.  Marshaller接口，将Java对象序列化成XML对象；
3.  Unmarshaller接口，将XML数据反序列化为Java对象。

# 3. JDK中JAXB相关的重要Annotation #

1.  @XmlType，将Java类或枚举类型映射到XML模式类型；
2.  @XmlAccessorType(XmlAccessType.FIELD) ，控制字段或属性的序列化。FIELD表示JAXB将自动绑定Java类中的每个非静态的（static）、非瞬态的（由@XmlTransient标注）字段到XML。其他值还有XmlAccessType.PROPERTY和XmlAccessType.NONE。
3.  @XmlRootElement，将Java类或枚举类型映射到XML元素。
4.  @XmlElement，将Java类的一个属性映射到与属性同名的一个XML元素。
5.  @XmlAttribute，将Java类的一个属性映射到与属性同名的一个XML属性。

# 4. Java对象和XML文件相互操作的核心代码XMLUtil.java #

package com.xml;  
      
    import java.io.FileNotFoundException;  
    import java.io.FileReader;  
    import java.io.FileWriter;  
    import java.io.IOException;  
    import java.io.StringReader;  
    import java.io.StringWriter;  
      
    import javax.xml.bind.JAXBContext;  
    import javax.xml.bind.JAXBException;  
    import javax.xml.bind.Marshaller;  
    import javax.xml.bind.Unmarshaller;  
      
    /** * 封装了XML转换成object，object转换成XML的代码 * * @author Steven * */  
    public class XMLUtil {   
        /** * 将对象直接转换成String类型的 XML输出 * * @param obj * @return */  
        public static String convertToXml(Object obj) {   
            // 创建输出流 
            StringWriter sw = new StringWriter();  
            try {   
                // 利用jdk中自带的转换类实现 
                JAXBContext context = JAXBContext.newInstance(obj.getClass());  
      
                Marshaller marshaller = context.createMarshaller();  
                // 格式化xml输出的格式 
                marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT,  
                        Boolean.TRUE);  
                // 将对象转换成输出流形式的xml 
                marshaller.marshal(obj, sw);  
            } catch (JAXBException e) {   
                e.printStackTrace();  
            }  
            return sw.toString();  
        }  
      
        /** * 将对象根据路径转换成xml文件 * * @param obj * @param path * @return */  
        public static void convertToXml(Object obj, String path) {   
            try {   
                // 利用jdk中自带的转换类实现 
                JAXBContext context = JAXBContext.newInstance(obj.getClass());  
      
                Marshaller marshaller = context.createMarshaller();  
                // 格式化xml输出的格式 
                marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT,  
                        Boolean.TRUE);  
                // 将对象转换成输出流形式的xml 
                // 创建输出流 
                FileWriter fw = null;  
                try {   
                    fw = new FileWriter(path);  
                } catch (IOException e) {   
                    e.printStackTrace();  
                }  
                marshaller.marshal(obj, fw);  
            } catch (JAXBException e) {   
                e.printStackTrace();  
            }  
        }  
      
        @SuppressWarnings("unchecked")  
        /** * 将String类型的xml转换成对象 */  
        public static Object convertXmlStrToObject(Class clazz, String xmlStr) {   
            Object xmlObject = null;  
            try {   
                JAXBContext context = JAXBContext.newInstance(clazz);  
                // 进行将Xml转成对象的核心接口 
                Unmarshaller unmarshaller = context.createUnmarshaller();  
                StringReader sr = new StringReader(xmlStr);  
                xmlObject = unmarshaller.unmarshal(sr);  
            } catch (JAXBException e) {   
                e.printStackTrace();  
            }  
            return xmlObject;  
        }  
      
        @SuppressWarnings("unchecked")  
        /** * 将file类型的xml转换成对象 */  
        public static Object convertXmlFileToObject(Class clazz, String xmlPath) {   
            Object xmlObject = null;  
            try {   
                JAXBContext context = JAXBContext.newInstance(clazz);  
                Unmarshaller unmarshaller = context.createUnmarshaller();  
                FileReader fr = null;  
                try {   
                    fr = new FileReader(xmlPath);  
                } catch (FileNotFoundException e) {   
                    e.printStackTrace();  
                }  
                xmlObject = unmarshaller.unmarshal(fr);  
            } catch (JAXBException e) {   
                e.printStackTrace();  
            }  
            return xmlObject;  
        }  
    }