java jaxb 注解_一、JAXB注解的使用详解
一、首先先上一段测试的代码下面的说明和测试都已这一段代码为主
package shiqingxue.cn.itcast.utils.xml;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
@XmlRootElement
public class Student {
private String name; // 姓名
private String sex; // 性别
private int number; // 学号
private String className; // 班级
public Student(){}
public Student(String string, String string2, int i, String string3) {
this.name = string;
this.sex = string2;
this.className = string3;
}
@XmlElement(name = "name")
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
@XmlElement(name = "sex")
public String getSex() {
return sex;
}
public void setSex(String sex) {
this.sex = sex;
}
@XmlElement(name = "number")
public int getNumber() {
return number;
}
public void setNumber(int number) {
this.number = number;
}
@XmlElement(name = "className")
public String getClassName() {
return className;
}
public void setClassName(String className) {
this.className = className;
}
}
/**
* 将XML内容转换成对象
*/
@SuppressWarnings("unchecked")
public static T unmarshal(String xml, Class clazz) throws JAXBException{
JAXBContext jaxbContext = JAXBContext.newInstance(clazz);
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
return (T)unmarshaller.unmarshal(new StringReader(xml));
}
/**
* 将对象转换成XML
*/
public static String marshal(Object object, Class> clazz) throws JAXBException{
JAXBContext jaxbContext = JAXBContext.newInstance(clazz);
Marshaller marshaller = jaxbContext.createMarshaller();
marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8");
StringWriter writer = new StringWriter();
marshaller.marshal(object, writer);
return writer.toString();
}public static void main(String[] args) throws JAXBExceptionStudent st = new Student("张三","男",10001,"尖//这里试讲上面的两个方法放到了工具类在这里调String xml = XStreamUtil.marshal(st, Student.class)System.out.println(xml)}
测试结果：
二、可以看到上面控制台打印的结果，说明测试已经通过，下面具体将一些注解的用法：
(2.1)@XmlRootElement
类级别的注解，将类映射为xml全局元素，也就是根元素。就像spring配置文件中的beans。下面的例子中我将该注解用在了student类上，生成了根元素。常与@XmlType，@XmlAccessorType，@XmlAccessorOrder连用,看下面运行结果
明显可以看出生成的跟节点的名称已经变成了
(2.2)@XmlAccessorType:
包和类级别的注解，javaEE的API对该注解的解释是：控制字段是否被默认序列化。通俗来讲，就是决定哪些字段或哪些get/set方法对应的字段会被映射为xml元素，需要注意的是字段或get/set方法的访问权限(public/private)会影响字段是否被映射为xml元素，下面会详细讲解。
注解只有一个value属性，可取的值是一个名为XmlAccessType的枚举类型里的值，下面详细看一下这几个值分别有什么用：
(2.2.1)XmlAccessType.PROPERTY:
理解：下面是源码里面的一段描述，这一段的大致翻译是，《JAXB绑定类中的每个getter/setter对都将自动绑定到XML，除非由@link xmltinate注释，只有当字段被一些JAXB注释显式注释时，字段才绑定到XML》(注：这一段话个人认为需要格外注意前面的一段话每个getter/setter都会自动绑定到xml)。
补充:
(1)当使用了该值，只要字段有对应的get/set方法对(注意是成对出现，只有其中一个不会发生映射)，不需要使用@XmlElement注解，不论该方法的访问权限是什么(即使是private)，jaxb就会将该字段映射成xml元素。不过最好加上@XmlElement注解，get/set方法任选一个即可，都加上会报错。
(2)若在一个字段有set/get方法对但又在字段上添加@XmlElement注解会报属性重复的错误
(3)若没有set/get方法对，则需要在字段上使用@XmlElement注解才可以映射为xml元素，否则不会发生映射
(4)若get/set方法上使用了@XmlTransient注解，但想要对应字段发生映射，需要在对应字段上添加@XmlElement注解，此时不会报错，并将该字段映射为xml元素。
(2.2.2)XmlAccessType.FIELD:
理解：下面是源码中的解释，这一段的大致翻译是，《jaxb绑定类中的每个非静态、非瞬态字段都将自动绑定到XML，除非使用@XmlTransient进行注释，只有当某些JAXB注释显式地对getter/setter对进行注释时，它们才会绑定到XML》(注：这段需要注意的是可以自动绑定类中的非静态、非瞬态字段，但不会自动绑定getter/setter方法，正好与XmlAccessType.PROPERTY相反)
补充:
(1)每个非静态的字段(无论访问权限如何)都会被jaxb映射为xml元素，即使没有get/set方法对，即使没有使用@XmlElement元素，但最好加上该注解以表明该字段要被映射为xml元素
(2)虽然没有get/set方法对，也会发生映射，但加上get/set方法对也不会报错，因为我们经常会使用这两个方法。但注意，不能再在这两个方法上使用@XmlElement方法，否则会报属性重复的错误。
(3)若在字段上使用了@XmlTransient注解，但还想让该字段发生映射，需要在该字段对应的get/set方法上添加@XmlElement
(2.2.3)XmlAccessType.PUBLIC_MEMBER(该值为默认值):
注：如果不指定@XmlAccessorType的value值或者没有使用此注解，在转xml时会默认为value为XmlAccessType.PROPERTY，由下面的截图可以清晰的看出默认值是XmlAccessType.PROPERTY，
理解：下面则是对此的描述，翻译大概是《每个公共getter/setter对和每个公共字段都将自动绑定到XML，除非使用@XmlTransient注释。只有在适当的JAXB注释显式地注释了字段或getter/setter对之后，才会将它们绑定到XML。》(注：在这里要格外注意XmlAccessType.PUBLIC_MEMBER (该值为默认值)这句话，同时他会把类的字段和getter/setter方法都会绑定到xml,初学者很容易忽略这点，采坑)
采坑实例：
如下图我们并没有使用@XmlAccessorType注解，当刚刚提到的，如果你在类的上面没有使用@XmlAccessorType注解，它的默认值会是XmlAccessType.PUBLIC_MEMBER，而XmlAccessType.PUBLIC_MEMBER的特性是会自动绑定类中的字段和getter/setter方法到XML，所以这样最终的结果会出现类的两个属性具有相同名称的错误，这一点需要注意
补充：
(1)每个访问权限为public的字段，或者每个访问权限为public的get/set方法对，都会将字段映射为xml元素，即使不使用@XmlElement，但最好加上。不可同时存在public字段和对应的get/set方法对，不然会报属性重复的错误
(2)若使用@XmlElement注解，则实体类中不能存在get/set方法或者只能在get/set上使用，否则会报属性重复的错误
(3)若字段不为public，get/set方法为public并使用了@XmlTransient，需要在字段上添加@XmlElement才会发生映射，若字段为public并使用了@XmlTransient，get/set方法对不为public，需要在get/set方法上使用@XmlElement才会映射。
(2.2.4)XmlAccessType.NONE:
注：这一段的翻译是《任何字段或属性都不会绑定到XML，除非使用某些JAXB注释对它们进行特别注释。》
补充：
任何字段，get/set方法对都不会发生映射，除非使用某些注解，如@XmlElement，@XmlElementWrapper等。
(2.3)@XmlElement：
字段，方法，参数级别的注解。该注解可以将被注解的字段(非静态)，或者被注解的get/set方法对应的字段映射为本地元素，也就是子元素。默认使用字段名或get/set方法去掉前缀剩下部分小写作为元素名(在字段名和get/set方法符合命名规范的情况下)。
属性：该注解的属性常用的属性有如下
(1)defaultValue：可以指定该元素默认的文本值
(2)namespace：可以指定该元素所属的命名空间
(3)name： 同@XmlRootElement注解的name属性一样
(4)required：可以指定该元素是否必须出现，默认为false
(5)nillable： 可以指定元素的文本值是否可以为空，默认为false
(2.4)@XmlAttribute：
字段和方法级别的注解。该注解会将字段或get/set方法对应的字段映射成本类对应元素的属性，属性名默认使用字段名或get/set方法去掉前缀剩下部分首字母小写(在字段名和get/set方法符合命名规范的情况下)。修改上面例子：
属性:该注解有name，required，namespace三个属性。用法和@XmlElement注解相同
(2.5)@XmlAccessorOrder：
包和类级别的注解。控制生成元素的顺序。
属性：该属性有XmlAccessOrder.ALPHABETICAL 和 XmlAccessOrder.UNDEFINED两种
(1)XmlAccessOrder.ALPHABETICAL，代表按照字母表的顺序对生成的元素排序，也就是我们常说的字典顺序
(2)XmlAccessOrder.UNDEFINED，代表按照类中字段的顺序生成元素的顺序，也是该注解的默认值
(2.6)@XmlElementWrapper
字段和方法级别的注解：围绕被映射的xml元素生成包装元素。主要用在集合对象映射后生成包装映射结果的xml元素，来看一下例子，创建两个类Children、Father。
执行测试代码：
先来看一下没有@XmlElementWrapper注解的结果：
修改一下代码再来看一下加了 @XmlElementWrapper注解的效果：
打印结果：
(2.7)@XmlJavaTypeAdapter
包、类、字段，方法、参数级别的注解：解决java日期(Date)，数字(Number)格式化问题。直接看例子，修改Person类，添加一个Date类型字段：
在这里要向使用@XmlJavaTypeAdapter我们就要指定一个指向将值类型转换为绑定类型的类，这个类需要继承XmlAdapter抽象类重写里面的unmarshal和marshal方法
测试结果：
(2.8)@XmlTransient：
类，字段，方法级别的注解：可使JAXB在映射xml元素时忽略被注解的类，字段，get/set对应字段。需要注意的是该注解与所有其他JAXB注释相互排斥，也就是说与其他注释连用就会报错
测试结果：
原文：https://www.cnblogs.com/zouxiangzhongyan/p/10478114.html