Java JAXB的@XmlAttribute注解怎么用

煙雲 2025-12-14 00:00:00 次阅读

@XmlAttribute用于将Java字段或getter方法映射为XML元素的属性，支持name、required、defaultValue参数，适用于简单类型，不可用于复杂对象，常与@XmlElement配合使用以区分属性与子元素。

@XmlAttribute 用来把 Java 字段或属性映射为 XML 元素的属性（attribute），而不是子元素（element）。它必须用在类的字段或 getter 方法上，且该字段类型需支持 XML Schema 简单类型（如 String、int、boolean、Date 等）。

基本用法：标记字段生成 XML 属性

直接在字段上加 @XmlAttribute，JAXB 序列化时会把这个字段作为所在 XML 元素的属性输出。

@XmlRootElement
public class User {
    @XmlAttribute
    private String id;

    @XmlAttribute(name = "user-name")
    private String name;

    private String email;

    // 构造函数、getter/setter 省略
}

序列化结果示例：


  alice@example.com

默认 name：不写 name 属性时，XML 属性名默认为字段名（如 id）
自定义 name：用 name = "xxx" 指定 XML 中显示的属性名（如 user-name）
不能用于复杂对象：字段类型不能是自定义类（比如不能是 Address address），否则 JAXB 报错

配合 @XmlElement 使用，区分属性和子元素

同一个类里可以同时用 @XmlAttribute 和 @XmlElement，让一部分数据当属性、一部分当子元素，符合常见 XML 设计习惯。

@XmlRootElement
public class Order {
    @XmlAttribute
    private String orderId;

    @XmlAttribute
    private String status;

    @XmlElement
    private String description;

    @XmlElement
    private List items;
}

生成的 XML 类似：


  Laptop order
  
    ...

业务主键、状态码、枚举标识等适合用 @XmlAttribute
长文本、嵌套结构、可重复内容适合用 @XmlElement
JAXB 默认把所有 public 字段/属性都当作，加注解才能改变行为

注意 required 和 defaultValue

@XmlAttribute 支持两个实用参数：

required = true/false：控制该属性是否必须存在（反序列化时校验，true 且 XML 缺失会报 UnmarshalException）
defaultValue = "xxx"：仅影响生成的 XSD（如果用 JAXBContext.generateSchema()），不影响 Java 对象默认值或序列化行为

@XmlAttribute(required = true)
private String version;

@XmlAttribute(defaultValue = "1.0")
private String schemaVersion; // 仅生成 XSD 时体现

用在 getter 方法上也有效（推荐封装场景）

如果你把字段设为 private，并只暴露 getter/setter，可以把 @XmlAttribute 加在 getter 上，效果一样：

private String code;

@XmlAttribute(name = "code")
public String getCode() {
    return code;
}

public void setCode(String code) {
    this.code = code;
}