使用JAXB读写xml

1.注解

在Java模型中的创建与 xml 文件对应的节点和属性需要用注解来表示

@XmlRootElement

作用:将一个Java类映射为一段XML的根节点参数:
    name  定义这个根节点的名称
    namespace   定义这个根节点命名空间
@XmlAccessorType  
作用:定义映射这个类中的何种类型需要映射到XML。
可接收四个参数,分别是:
    XmlAccessType.FIELD:表示将这个类中的 非静态(static)、非序列化(transient)属性映射到xml,有无get/set方法均可
    XmlAccessType.PROPERTY:使用 set/get 方法来序列化属性或者元素(get方法可不需注解自动映射)——说明:通过get方法映射到xml,get方法上是否添加注解都可,但是不能在属性上添加注解
    XmlAccessType.PUBLIC_MEMBER:将这个类中的所有public的field(字段)或property(get/set对)同时映射到XML(默认注解),该注解包含了XmlAccessType.FIELD和XmlAccessType.PROPERTY两个注解,所以注意不要对同一个字段添加两次注解
    XmlAccessType.NONE:不映射
补充说明:
    @XmlAccessorType的默认访问级别是 XmlAccessType.PUBLIC_MEMBER,因此,如果java对象中的private成员变量设置了public权限的 getter/setter方法,就不要在private变量上使用@XmlElement和@XmlAttribute注解,否则在由java对象生成 xml时会报同一个属性在java类里存在两次的错误。
    同理,如果@XmlAccessorType的访问权限为XmlAccessType.NONE, 如果在java的成员变量上使用了@XmlElement或@XmlAttribute注解,这些成员变量依然可以映射到xml文件。
@XmlElements
// 表示或的关系,list集合中内容可以为以下两种类型
    @XmlElements({
        @XmlElement(name = "Person", type = Person.class),
        @XmlElement(name = "String", type = String.class)
    })
    private List list;
补充说明:如果List使用泛型,则List集合中只能含有一种数据类型,此时使用该注解无用。
@XmlElement  
作用:指定一个字段或get/set方法映射到XML的节点。如,当一个类的XmlAccessorType 被标注为PROPERTY时,在某一个没有get/set方法的字段上标注此注解,即可将该字段映射到XML。
参数:
    defaultValue        指定节点默认值
    name            指定节点名称
    namespace        指定节点命名空间
    type                定义该字段或属性的关联类型
    required            是否必须(默认为false)
    nillable            该字段是否包含 nillable="true" 属性(默认为false)
@XmlAttribute
作用:指定一个字段或get/set方法映射到XML的属性(区别@XmlElement——节点)。
参数:
    Name            指定属性名称
    namespace        指定属性命名空间
    required         是否必须(默认为false)
@XmlTransient  
作用:定义某一字段或属性不需要被映射为XML。
如,当一个类的XmlAccessorType 被标注为PROPERTY时,在某一get/set方法的字段上标注此注解,那么该属性则不会被映射。
@XmlType  
作用:定义映射的一些相关规则
参数:
    propOrder        指定映射XML时的节点顺序
    factoryClass        指定UnMarshal时生成映射类实例所需的工厂类,默认为这个类本身
    factoryMethod    指定工厂类的工厂方法
    name            定义XML Schema中type的名称
    namespace        指定Schema中的命名空间
@XmlElementWrapper  
作用:为数组元素或集合元素定义一个父节点。
如,类中有一元素为List items,若不加此注解,该元素将被映射为
    <items>...</items>
    <items>...</items>
这种形式,此注解可将这个元素进行包装,如:
    @XmlElementWrapper(name="items")
    @XmlElement(name="item")
    public List items;
将会生成这样的XML样式:
    <items>
        <item>...</item>
        <item>...</item>
    </items>
@XmlJavaTypeAdapter  
作用:自定义某一字段或属性映射到XML的适配器。
如,类中包含一个接口,我们可以定义一个适配器(继承自 javax.xml.bind.annotation.adapters.XmlAdapter类),指定这个接口如何映射到XML。
@XmlSchema
作用:配置整个包的namespace,这个注解需放在package-info.java文件中

2.代码实例
2.1 Object转为xml
public static void marshallerByJaxb(String path, Object object) {
    try {
        JAXBContext jc = JAXBContext.newInstance(object.getClass());
            
        Marshaller marshaller = jc.createMarshaller();            
        marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8");// 编码格式
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);// 是否格式化生成的xml串
        marshaller.setProperty(Marshaller.JAXB_FRAGMENT, false);// 是否省略xml头声明信息

File file = new File(path);
        if (!file.exists()) {
            file.createNewFile();
        }
        marshaller.marshal(object, file);
    } catch (JAXBException e) {
        e.printStackTrace();
    } catch (IOException e) {
        e.printStackTrace();
    }
}
2.2 xml转为Object
public static void unmarshallerByJaxb(String path, Object object) {
    try {
        JAXBContext jc = JAXBContext.newInstance(object.getClass());
            
        Unmarshaller unmarshaller = jc.createUnmarshaller();
            
        File file = new File(path);
        if (!file.exists()) {
            throw new FileNotFoundException("Can not load xml file!");
        }
            
        unmarshaller.unmarshal(file);
    } catch (JAXBException e) {
        e.printStackTrace();
    } catch (FileNotFoundException e) {
        e.printStackTrace();
    }
}
说明:传参时传入的obj必须为具体类型。
如:先实例化Person per = new Person();
再传unmarshallerByJaxb(path, person);
不可以直接unmarshallerByJaxb(path, Person.class);

3. List、Map集合类型说明
集合必须封装在对象内部才能使用jaxb转为xml,不能直接将集合直接转为xml
3.1 List
List集合或数组只要封装到对象内部,使用@XMLElementWrapper注解
说明:当对象内部只有一个List集合的属性时,可以不加@XMLElementWrapper注解增加一层节点,直接将List结合内的对象作为根节点下的二级节点即可。
3.2 Map
如:Map<String, Person>集合,Person为自定义的一个对象
1.创建一个新对象(如:AllPerson)作为中转对象,该对象内含有两个属性,分别是String和Person类型的(前者为Map的key,后者为Map的value);
2.使用@XMLJavaTypeAdapter注解将Map<String, Person>转为AllPerson[],数组的大小与Map的大小相同;
总结:XmlAdapter中的两个方法各有用处,注意不要漏掉
Object->xml时
Map<String, Person>—转为—> AllPerson[](AllPerson对象中包含String, Person)
Xml->Object时
AllPerson[](AllPerson对象中包含String, Person)—转为—> Map<String, Person>

时间: 2024-10-10 19:12:44

使用JAXB读写xml的相关文章

JAXB方式读写XML文件

import java.io.File; import java.util.ArrayList; import java.util.List; import javax.xml.bind.JAXB; import org.apache.log4j.Logger; import org.dom4j.Document; import org.dom4j.Element; import org.dom4j.io.SAXReader; import cn.com.starit.ts.nms.collec

在.net中序列化读写xml方法的总结

在.net中序列化读写xml方法的总结 阅读目录 开始 最简单的使用XML的方法 类型定义与XML结构的映射 使用 XmlElement 使用 XmlAttribute 使用 InnerText 重命名节点名称 列表和数组的序列化 列表和数组的做为数据成员的序列化 类型继承与反序列化 反序列化的实战演练 反序列化的使用总结 排除不需要序列化的成员 强制指定成员的序列化顺序 自定义序列化行为 序列化去掉XML命名空间及声明头 XML的使用建议 XML是一种很常见的数据保存方式,我经常用它来保存一些

使用dom4j 读写xml文件

dom4j是一个Java的XML API,类似于jdom,用来读写XML文件的.dom4j是一个十分优秀的JavaXML API,具有性能优异.功能强大和极其易使用的特点,同时它也是一个开放源代码的软件. String fileName="D:\\version.xml"; File inputXML=new File(fileName); //使用 SAXReader 解析 XML 文档 version.xml SAXReader saxReader=new SAXReader();

C#读写xml文件

c#读写xml文件已知有一个XML文件(bookstore.xml)如下: Code<?xml version="1.0" encoding="gb2312"?><bookstore> <book genre="fantasy" ISBN="2-3631-4"> <title>Oberon's Legacy</title> <author>Corets,

iOS 读写xml文件

//*********写入文件,传入要保存的信息*********//保存xml -(void) saveXml:(NSString *)data { //创建文件管理器 NSFileManager *fileManager = [NSFileManager defaultManager ]; //获取路径 //参数NSDocumentDirectory要获取那种路径 NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentD

读写XML

XML是一种可扩展标记语言 下面是一个完整的XML文件(也是下文介绍读写XML的样本): [html] view plaincopy <?xml version="1.0" encoding="UTF-8"?> <poem author="William Carlos Williams" title="The Great Figure"> <line>Among the rain</l

C#_在.net中序列化读写xml方法的总结

阅读目录 开始 最简单的使用XML的方法 类型定义与XML结构的映射 使用 XmlElement 使用 XmlAttribute 使用 InnerText 重命名节点名称 列表和数组的序列化 列表和数组的做为数据成员的序列化 类型继承与反序列化 反序列化的实战演练 反序列化的使用总结 排除不需要序列化的成员 强制指定成员的序列化顺序 自定义序列化行为 序列化去掉XML命名空间及声明头 XML的使用建议 XML是一种很常见的数据保存方式,我经常用它来保存一些数据,或者是一些配置参数. 使用C#,我

JAVA学习笔记 -- 读写XML

XML是一种可扩展标记语言 以下是一个完整的XML文件(也是下文介绍读写XML的样本): <? xml version="1.0" encoding="UTF-8"? > <poem author="William Carlos Williams" title="The Great Figure"> <line>Among the rain</line> <line>

.Net那点事儿系列:C#操作Xml:通过XmlDocument读写Xml文档

什么是Xml? Xml是扩展标记语言的简写,是一种开发的文本格式.关于它的更多情况可以通过w3组织了解http://www.w3.org/TR/1998/REC-xml-19980210.如果你不知道它,那你就out太多了. .Net处理Xml相关随笔 1.通过XmlDocument读写Xml文档2.通过XmlWriter和XmlReader读写Xml文档3.通过LINK to Xml存取XML4.通过XmlScheme定义固定格式xml文档5.Xml序列化或者反序列化类6.通过XPath查找X