JAXB注解及xml相关操作

亦凉 2023-05-22 06:38 13阅读 0赞

> 简单介绍  
> @XmlRootElement指定根节点,name指定根节点名称,nameSpace指定命名空间。  
> @XmlAccessorType用于指定由java对象生成xml文件时对java对象属性的访问方式。常与@XmlRootElement、@XmlType一起使用。它的属性值是XmlAccessType的4个枚举值，分别为：  
> 　　XmlAccessType.FIELD：java对象中的所有成员变量；  
> 　　XmlAccessType.PROPERTY：java对象中所有通过getter/setter方式访问的成员变量；  
> 　　XmlAccessType.PUBLIC\_MEMBER：java对象中所有的public访问权限的成员变量和通过getter/setter方式访问的成员变量；默认;  
> 　　XmlAccessType.NONE：java对象的所有属性都不映射为xml的元素。  
> 注意：@XmlAccessorType的默认访问级别是XmlAccessType.PUBLIC\_MEMBER，因此，如果java对象中的private成员变量设置了public权限的getter/setter方法，就不要在private变量上使用@XmlElement和@XmlAttribute注解，否则在由java对象生成xml时会报同一个属性在java类里存在两次的错误。同理，如果@XmlAccessorType的访问权限为XmlAccessType.NONE，如果在java的成员变量上使用了@XmlElement或@XmlAttribute注解，这些成员变量依然可以映射到xml文件。
> 
> @XmlType使用propOrder属性来控制XML元素的排序,使用该属性时，必须列出JavaBean对象中的所有字段;当XmlAccessType.FIELD时值为成员变量名称;当XmlAccessType.PUBLIC\_MEMBER时为get/set的名称;  
> @XmlElement映射Java属性与xml标签  
> @XmlAccessorOrder用于对java对象生成的xml元素进行排序。它有两个属性值：  
> 　　AccessorOrder.ALPHABETICAL：对生成的xml元素按字母书序排序  
> 　　XmlAccessOrder.UNDEFINED:不排序  
> [JAXB注解介绍][JAXB]  
> [JAXB注解使用][JAXB 1]

Java实体

import javax.xml.bind.annotation.XmlAccessType;
    import javax.xml.bind.annotation.XmlAccessorType;
    import javax.xml.bind.annotation.XmlElement;
    import javax.xml.bind.annotation.XmlRootElement;
    import javax.xml.bind.annotation.XmlType;
    //设置生成的xml的根节点的名称 
    @XmlRootElement(name = "DOCUMENT")
    //设置根据字段生成 
    @XmlAccessorType(XmlAccessType.FIELD)
    @XmlType(name = "DOCUMENT", propOrder = {  "signature", "packet" })
    public class Request { 
    	@XmlElement(name = "SIGNATURE")
    	private String signature;
    	@XmlElement(name = "PACKET")
    	private Packet packet;
    	........
    }
    
    @XmlRootElement(name = "PACKET")
    @XmlAccessorType(XmlAccessType.FIELD)
    //按xml标签字母排序
    @XmlAccessorOrder(XmlAccessOrder.ALPHABETICAL)
    @XmlType(name = "PACKET", propOrder = {  "head", "body" })
    public class Packet { 
    	@XmlElement(name = "HEAD")
    	private Head head;
    	@XmlElement(name = "BODY")
    	private Body body;
    	.......
    }

xml-model转换

import java.io.IOException;
    import java.io.StringReader;
    import java.io.StringWriter;
    import java.io.Writer;
    import javax.xml.bind.JAXBContext;
    import javax.xml.bind.Marshaller;
    import javax.xml.bind.Unmarshaller;
    import com.sun.xml.bind.marshaller.CharacterEscapeHandler;
    
     /** * Java对象转换成xml字符串 * @param 要转换的Java对象 * @param encoding 编码格式 * @param format 是否格式化生成的xml串 * @param fragment 是否省略xm头声明信息 * @param characterEscapeHandler 是否进行转义字符的处理 * @return */
    public static <T> String toXML(T t,String encoding,boolean format,boolean fragment,boolean characterEscapeHandler) { 
       try { 
           JAXBContext context = JAXBContext.newInstance(t.getClass());
    
           Marshaller marshaller = context.createMarshaller();
           marshaller.setProperty(Marshaller.JAXB_ENCODING, encoding == null || "".equals(encoding) ? "UTF-8" : encoding );// //编码格式
           marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, format);// 是否格式化生成的xml串
           marshaller.setProperty(Marshaller.JAXB_FRAGMENT, fragment);// 是否省略xm头声明信息
           // 不进行转义字符的处理
           if(characterEscapeHandler){ 
            marshaller.setProperty(CharacterEscapeHandler.class.getName(), 
            		new CharacterEscapeHandler() { 
    		@Override
    		public void escape(char[] ch, int start, int length,
    				boolean isAttVal, Writer writer) throws IOException { 
    			writer.write(ch, start, length);  							
    		}    
              	});
        }
           StringWriter writer = new StringWriter();
           marshaller.marshal(t, writer);
           return writer.toString();
       } catch (Exception e) { 
           throw new RuntimeException(e);
       }
    }
    
    /** * xml字符串转换成Java对象 * @param xml 要转换的xml字符串 * @param classz 目标对象类 * @return */
    public static <T> T fromXML(String xml, Class<T> classz) { 
       try { 
            JAXBContext context = JAXBContext.newInstance(classz);
            Unmarshaller unmarshaller = context.createUnmarshaller();
            return (T) unmarshaller.unmarshal(new StringReader(xml));
        } catch (Exception e) { 
            throw new RuntimeException(e.getMessage());
        }
    }

xml处理

import org.dom4j.Document;
    import org.dom4j.DocumentException;
    import org.dom4j.Element;
    import org.dom4j.io.OutputFormat;
    import org.dom4j.io.SAXReader;
    import org.dom4j.io.XMLWriter;
    
    /** * 转换为标准格式（避免自闭合的问题） * 自闭格式 <book><price/></book> Element.asXML(); * @param body * @return */
    public static String asXml(Element body) { 
    	OutputFormat format = new OutputFormat();
    	format.setEncoding("UTF-8");
    	format.setExpandEmptyElements(true);
    	StringWriter out = new StringWriter();
    	XMLWriter writer = new XMLWriter(out, format);
    	try { 
    		writer.write(body);
    		writer.flush();
    	} catch (IOException e) { 
    		e.printStackTrace();
    	}
    	return out.toString();
    }
    
    /** * 转换为标准格式（避免自闭合的问题）并去除当前根标签 * @param body * @return */
    public static String asXmlWithoutRootTag(Element body) { 
    	String xml = asXml(body);
    	return xml.substring(xml.indexOf(">") + 1, xml.lastIndexOf("</"));
    }
    
    /** * 解析xml * @param xml 目标xml字符串 * @return * @throws DocumentException */
    public static Element parseXml(String xml) throws DocumentException { 
    	Document document = null;
    	StringReader sr = new StringReader(xml);
    	SAXReader saxReader = new SAXReader();
    	document = saxReader.read(sr);
    	return null == document ? null : document.getRootElement();
    }

创建xml

import java.io.IOException;
    import java.io.StringReader;
    import java.io.StringWriter;
    import org.dom4j.Document;
    import org.dom4j.DocumentException;
    import org.dom4j.Element;
    import org.dom4j.io.OutputFormat;
    import org.dom4j.io.SAXReader;
    import org.dom4j.io.XMLWriter;
    import org.dom4j.DocumentHelper; 
    public static void main(String[] args) { 
    	Document document = DocumentHelper.createDocument();
    	//添加根节点
    	Element root = document.addElement("root");
    	document.setRootElement(root );
    	//添加子节点
    	Element books = root.addElement("books");
    	
    	Element book1 = books.addElement("book");
    	Element name1 = book1.addElement("name");
    	//添加节点文本
    	name1.setText("红楼梦");
    	Element price1 = book1.addElement("price");
    	price1.setText("99.9");
    	
    	Element book2 = books.addElement("book");
    	Element name2 = book2.addElement("name");
    	name2.setText("西游记");
    	Element price2 = book2.addElement("price");
    	price2.setText("88.88");
    	//输出
    	StringWriter strWtr = new StringWriter();  
        OutputFormat format = OutputFormat.createPrettyPrint();//Format格式！！ 
        format.setEncoding("UTF-8");      
        XMLWriter xmlWriter =new XMLWriter(strWtr, format);  
        try {   
            xmlWriter.write(document);  
        } catch (IOException e1) {   
            e1.printStackTrace();  
        }  
        System.out.println(strWtr.toString());
        //获取指定标签xml字符串(自闭格式)
        System.out.println(root.element("books").asXML());
    }

[JAXB]: https://www.w3cschool.cn/jaxb2/jaxb2-8pa22zoi.html
[JAXB 1]: https://www.cnblogs.com/qiyebao/p/4573665.html