Java 中 javax.xml.bind.annotation
包的作用及其与 XML Schema 映射的相关注解
背景介绍
javax.xml.bind.annotation
是 Java Architecture for XML Binding (JAXB) 的一部分,用于将 Java 对象与 XML 数据之间相互转换。它提供了一组注解,允许开发者定义 Java 类与其对应的 XML Schema 之间的映射关系。
常见的 JAXB 注解及其用途
以下是 javax.xml.bind.annotation
包中常用的注解及其功能:
1. @XmlRootElement
指定一个类作为 XML 文档的根元素。
- 属性:
name
: 定义 XML 元素名称,默认为类名的小写形式。namespace
: 定义命名空间 URI。
- 示例代码:
@XmlRootElement(name = "person")
public class Person {
private String name;
private int age;
// Getters and Setters
}
2. @XmlElement
表示 Java 字段或属性对应于 XML 元素。
- 属性:
name
: 定义字段在 XML 中的名字。required
: 是否为必填项。
- 示例代码:
public class Address {
@XmlElement(required = true)
private String street;
@XmlElement(name = "city-name", required = false)
private String city;
// Getters and Setters
}
3. @XmlAttribute
表示 Java 字段或属性应映射到 XML 属性而非子元素。
- 属性:
name
: 定义属性名字。
- 示例代码:
@XmlRootElement
public class Book {
@XmlAttribute
private String id;
@XmlElement
private String title;
// Getters and Setters
}
4. @XmlAccessorType
控制类成员的访问方式(即哪些字段会被序列化)。常见的取值有:
FIELD
: 所有字段都会被序列化。PROPERTY
: 只有序列化的 getter 方法会参与绑定。NONE
: 默认情况下没有任何字段或方法会被序列化。- 示例代码:
@XmlAccessorType(XmlAccessType.FIELD)
public class Employee {
private String firstName;
private String lastName;
// Getters and Setters
}
5. @XmlType
描述类的结构信息,通常用来设置顺序或其他元数据。
- 属性:
propOrder
: 指定字段在 XML 输出中的顺序。
- 示例代码:
@XmlType(propOrder = {
"lastName", "firstName"})
public class Contact {
private String firstName;
private