JAXB基本使用

JAXB主要用来实现对象和XML之间的序列化和反序列化，关于JAXB的介绍就不多说了，网上一搜一大把，这里主要总结下基本使用方法和一些注意事项

首先定义两个示例类ClassA,ClassB，用于后续的示例演示

package cn.lzrabbit;

public class ClassA {
    private int classAId;
    private String classAName;

    private ClassB classB;

    int getClassAId() {
        return classAId;
    }

    void setClassAId(int classAId) {
        this.classAId = classAId;
    }

    public String getClassAName() {
        return classAName;
    }

    void setClassAName(String classAName) {
        this.classAName = classAName;
    }

    public ClassB getClassB() {
        return classB;
    }

    void setClassB(ClassB classB) {
        this.classB = classB;
    }
}

用于序列化的XmlUtil

调用如下：

输出结果如下：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<classA>
    classAId>11</classAName>A1classB>
        classBId>22classBName>B2>
>

这里要注意以下几点

1. 要序列化的类加上@XmlRootElement注解，否则会报错(错误提示很清晰，这里就不贴出来了)
2. JAXB序列化XML时 默认序列化getter和setter，且getter和setter必须成对出现才会被序列化
3. 属性名称，默认序列化出来的类和属性名称默认是首字母转换为小写，若需要控制属性名称需要在getter或setter上使用@XmlElement(name="ClassAId") 指定名称，这里要注意的是@XmlElement放置在getter或setter上都行，但只能放一个，也就是说不能同时在getter和setter上使用@XmlElement注解
4. 如何控制根节点名称？
   使用@XmlRootElement指定name属性即可，如@XmlRootElement(name="ClassA")
5. 怎么添加命名空间
   使用@XmlRootElement(namespace="cn.lzrabbit") 指定namespace属性
6. 怎么精确控制每个属性名称
   JAXB自动转化为首字母小写会导致不可预料的属性名称出现， 不嫌麻烦的话为每个属性设置@XmlElement(name="")，想省事的话使用Field
7. 怎么样实现序列化时使用Field字段而不是使用setter和getter
   在要使用的类上面加上@XmlAccessorType(XmlAccessType.FIELD)注解，并指定为XmlAccessType.FIELD，这里强烈推荐使用@XmlAccessorType(XmlAccessType.FIELD)注解，因为这样你可以精确的控制每个元素的名称，而不需要为每个属性去设置@XmlElement(name="")注解，当然也可以在Field上使用@XmlElement注解

下面给出使用了使用如上注解后的代码示例

@XmlRootElement(namespace="cn.lzrabbit")
@XmlAccessorType(XmlAccessType.FIELD)
int classAId;
    
    @XmlElement(name="ClassAName")
    return classAId;
    }
    this.classB = classB;
    }
}

@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
int ClassBId;
    private String ClassBName;

    return ClassBId;
    }

    this.ClassBId = classBId;
    }

    return ClassBName;
    }

    this.ClassBName = classBName;
    }
}

输出xml为

ns2:classA xmlns:ns2="cn.lzrabbit"ClassANameClassBIdClassBNamens2:classA

本篇先写到这里，下一篇写下默认命名空间及自定义命名空间前缀的处理

注：此文章属懒惰的肥兔原创，版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接

若您觉得这篇文章还不错请点击下右下角的推荐，有了您的支持才能激发作者更大的写作热情，非常感谢。

如有问题，可以通过lzrabbit@126.com联系我。