如何正确的使用JAXB

发布时间：2020-12-02 16:47:55 作者：Leah
来源：亿速云阅读：145

这期内容当中小编将会给大家带来有关如何正确的使用JAXB，文章内容丰富且以专业的角度为大家分析和叙述，阅读完这篇文章希望大家可以有所收获。

一、jaxb是什么

JAXB是Java Architecture for XML Binding的缩写。可以将一个Java对象转变成为XML格式，反之亦然。
我们把对象与关系数据库之间的映射称为ORM，其实也可以把对象与XML之间的映射称为OXM(Object XML Mapping)。原来JAXB是Java EE的一部分，在JDK1.6中，SUN将其放到了Java SE中，这也是SUN的一贯做法。JDK1.6中自带的这个JAXB版本是2.0，比起1.0(JSR 31)来，JAXB2(JSR 222)用JDK5的新特性Annotation来标识要作绑定的类和属性等，这就极大简化了开发的工作量。

二、jaxb应用模式

在JAVA EE 5\6中，jaxb可以很方便的与jax-rs、jax-ws集成，极大的简化了web service接口的开发工作量。

三、jaxb代码举例

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

package com.bjpowernode.test;

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

  private ClassB classB;

  public int getClassAId() {
    return classAId;
  }

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

  public String getClassAName() {
    return classAName;
  }

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

  public ClassB getClassB() {
    return classB;
  }

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

package com.bjpowernode.test;

public class ClassB {
  private int classBId;
  private String classBName;

  public int getClassBId() {
    return classBId;
  }

  public void setClassBId(int classBId) {
    this.classBId = classBId;
  }

  public String getClassBName() {
    return classBName;
  }

  public void setClassBName(String classBName) {
    this.classBName = classBName;
  }
}

用于序列化的XmlUtil

package com.bjpowernode.test;

import java.io.StringReader;
import java.io.StringWriter;

import javax.xml.bind.*;

public class XmlUtil {

  public static String toXML(Object obj) {
    try {
      JAXBContext context = JAXBContext.newInstance(obj.getClass());

      Marshaller marshaller = context.createMarshaller();
      marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8");// //编码格式
      marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);// 是否格式化生成的xml串
      marshaller.setProperty(Marshaller.JAXB_FRAGMENT, false);// 是否省略xm头声明信息
      StringWriter writer = new StringWriter();
      marshaller.marshal(obj, writer);
      return writer.toString();
    } catch (Exception e) {
      throw new RuntimeException(e);
    }
  }

  @SuppressWarnings("unchecked")
  public static <T> T fromXML(String xml, Class<T> valueType) {
    try {
      JAXBContext context = JAXBContext.newInstance(valueType);
      Unmarshaller unmarshaller = context.createUnmarshaller();
      return (T) unmarshaller.unmarshal(new StringReader(xml));
    } catch (Exception e) {
      throw new RuntimeException(e.getMessage());
    }
  }
}

调用如下：

package com.bjpowernode.test;

public class MainRun {

  /**
   * @param args
   */
  public static void main(String[] args) {

    ClassB classB = new ClassB();
    classB.setClassBId(22);
    classB.setClassBName("B2");

    ClassA classA = new ClassA();
    classA.setClassAId(11);
    classA.setClassAName("A1");
    classA.setClassB(classB);

    System.out.println(XmlUtil.toXML(classA));
  }

}

输出结果如下：

<&#63;xml version="1.0" encoding="UTF-8" standalone="yes"&#63;>
<classA>
  <classAId>11</classAId>
  <classAName>A1</classAName>
  <classB>
    <classBId>22</classBId>
    <classBName>B2</classBName>
  </classB>
</classA>

这里要注意以下几点

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="com.bjpowernode.test") 指定namespace属性
6.怎么精确控制每个属性名称
JAXB自动转化为首字母小写会导致不可预料的属性名称出现，不嫌麻烦的话为每个属性设置@XmlElement(name="")，想省事的话使用Field
7.怎么样实现序列化时使用Field字段而不是使用setter和getter
在要使用的类上面加上@XmlAccessorType(XmlAccessType.FIELD)注解，并指定为XmlAccessType.FIELD，这里强烈推荐使用@XmlAccessorType(XmlAccessType.FIELD)注解，因为这样你可以精确的控制每个元素的名称，而不需要为每个属性去设置@XmlElement(name="")注解，当然也可以在Field上使用@XmlElement注解
下面给出使用了使用如上注解后的代码示例

@XmlRootElement(namespace="com.bjpowernode.test")
@XmlAccessorType(XmlAccessType.FIELD)
public class ClassA {
  private int classAId;
  
  @XmlElement(name="ClassAName")
  private String classAName;

  private ClassB classB;

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

  public String getClassAName() {
    return classAName;
  }

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

  public ClassB getClassB() {
    return classB;
  }

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

@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public class ClassB {
  private int ClassBId;
  private String ClassBName;

  public int getClassBId() {
    return ClassBId;
  }

  public void setClassBId(int classBId) {
    this.ClassBId = classBId;
  }

  public String getClassBName() {
    return ClassBName;
  }

  public void setClassBName(String classBName) {
    this.ClassBName = classBName;
  }
}

输出xml为

<&#63;xml version="1.0" encoding="UTF-8" standalone="yes"&#63;>
<ns2:classA xmlns:ns2="com.bjpowernode.test">
  <classAId>11</classAId>
  <ClassAName>A1</ClassAName>
  <classB>
    <ClassBId>22</ClassBId>
    <ClassBName>B2</ClassBName>
  </classB>
</ns2:classA>

上述就是小编为大家分享的如何正确的使用JAXB了，如果刚好有类似的疑惑，不妨参照上述分析进行理解。如果想知道更多相关知识，欢迎关注亿速云行业资讯频道。

如何正确的使用JAXB

相关阅读