Elim的博客

用来记录一些原创性的总结

Elim

JAXB系列之xjc生成Java文件

在上一篇博文中介绍了通过schemagen指令来基于Java生成schema文件，本文将介绍使用JDK自带的xjc工具基于schema文件生成对应的Java文件。xjc的语法是：

xjc [options] schemaFile [-b bindinfo]

以下参数信息的说明摘自官方网站。

options : 用来指定一些选项，可选的，具体的参数项请见后文。
schemaFile : 用来指定需要用来生成Java代码的schema文件的位置，可以是一个具体的本地文件，一个URL，一个本地目录或是一个jar文件。如果指定的是一个目录，那么该目录下的所有schema文件都将用来生成Java文件；如果指定的是jar文件，则/META-INF/sun-jaxb.episode文件会被使用。多个schema文件之间可以通过空格分隔。
-b bindinfo : 用来指定绑定文件的位置。

可选的options如下：

-nv : 默认情况下xjc会对指定的schema文件进行严格的校验，使用该选项后可以禁用xjc对schema文件的严格校验。但是这不意味着不会进行任何校验，只是不会那么严格的校验而已。
-extension : 默认情况下转换过程将严格按照JAXB标准规范进行。有些厂商在进行实现的时候可能对它有一些自己的扩展，需要使用这些扩展时需要加上该选项。
-b file : 用于指定外部绑定文件。可以指定一个绑定文件供所有的schema文件使用，也可以为每个schema文件单独指定一个绑定文件。例如xjc schema1.xsd schema2.xsd schema3.xsd -b bindings123.xjb或xjc schema1.xsd schema2.xsd schema3.xsd -b bindings1.xjb -b bindings2.xjb -b bindings3.xjb。
-d dir : 用于指定生成的文件存放的位置
-p pkg : 用于指定生成的Java类需要使用的包名称
-npa : 用于指定不生成package-info.java文件，这样原本可以在包上指定的注解都会在类上进行指定。
-quiet : 不输出进度信息和警告信息等。
-version : 显示版本信息
-help : 展示帮助信息

更详细的信息请参考官方文档。

以下是一份schema文档，我们可以通过xjc -p com.elim.jaxb schema.xsd来指定生成的类都放在com.elim.jaxb包中。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="root" type="rootObject"/>

  <xs:element name="sub1" type="subClass1"/>

  <xs:element name="sub2" type="subClass2"/>

  <xs:complexType name="rootObject">
    <xs:sequence>
      <xs:element name="prop1" type="xs:string" minOccurs="0"/>
      <xs:element name="prop2" type="xs:string" minOccurs="0"/>
      <xs:choice>
        <xs:element ref="sub1"/>
        <xs:element ref="sub2"/>
      </xs:choice>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="superClass">
    <xs:sequence>
      <xs:element name="superProp1" type="xs:string" minOccurs="0"/>
      <xs:element name="superProp2" type="xs:string" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="subClass1">
    <xs:complexContent>
      <xs:extension base="superClass">
        <xs:sequence>
          <xs:element name="subProp1" type="xs:string" minOccurs="0"/>
          <xs:element name="subProp2" type="xs:string" minOccurs="0"/>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>

  <xs:complexType name="subClass2">
    <xs:complexContent>
      <xs:extension base="superClass">
        <xs:sequence>
          <xs:element name="subProp1" type="xs:string" minOccurs="0"/>
          <xs:element name="subProp2" type="xs:string" minOccurs="0"/>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
</xs:schema>

生成的java类如下：

@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "rootObject", propOrder = {
    "prop1",
    "prop2",
    "sub1",
    "sub2"
})
public class RootObject {

    protected String prop1;
    protected String prop2;
    protected SubClass1 sub1;
    protected SubClass2 sub2;

    //忽略get/set

}

@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "superClass", propOrder = {
    "superProp1",
    "superProp2"
})
@XmlSeeAlso({
    SubClass2 .class,
    SubClass1 .class
})
public class SuperClass {

    protected String superProp1;
    protected String superProp2;

    //省略get/set
}

@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "subClass1", propOrder = {
    "subProp1",
    "subProp2"
})
public class SubClass1
    extends SuperClass
{

    protected String subProp1;
    protected String subProp2;

    //省略get/set
}

@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "subClass2", propOrder = {
    "subProp1",
    "subProp2"
})
public class SubClass2
    extends SuperClass
{

    protected String subProp1;
    protected String subProp2;

    //省略get/set
}

以上就是本文的全部内容。