Java如何将XML Schema(XSD)编译成Java类 xjc工具

xjc 是 JDK 自带的 JAXB 工具,用于将 XSD 编译为带注解的 Java 类;JDK 6–8 原生支持,JDK 9+ 需手动引入 jaxb-xjc 依赖;支持指定包名、输出目录、绑定文件等选项,并可集成 Maven 自动化生成。

xjc 是 JDK 自带的 JAXB(Java Architecture for XML Binding)工具,用于将 XML Schema(XSD)文件编译生成对应的 Java 类。它能自动生成带注解的 POJO,支持序列化(XML → Java)和反序列化(Java → XML)。

确认 JDK 版本并检查 xjc 是否可用

JDK 6 到 JDK 8 原生包含 xjc;JDK 9+ 移除了 JAXB(包括 xjc),需手动引入依赖:

  • JDK 6–8:xjc 默认在 $JAVA_HOME/bin/ 下,直接运行 xjc -version 可验证
  • JDK 9+:需添加 jaxb-xjc 工具包(如 Maven 引入 org.glassfish.jaxb:jaxb-xjc),或使用独立的 JAXB Tools 发行版

基本用法:命令行执行 xjc

假设你有一个 person.xsd,想生成 Java 类到 src/main/java 目录:

  • 最简命令:xjc person.xsd —— 默认生成到当前目录的 generated 子目录
  • 指定输出目录:xjc -d src/main/java person.xsd
  • 指定 Java 包名:xjc -p com.example.model -d src/main/java person.xsd
  • 启用调试与详细日志:xjc -verbose person.xsd

常用选项与实用技巧

实际开发中常需定制生成行为:

  • -extension:启用扩展模式(支持 xs:assert、xs:annotation 等高级特性)
  • -b binding.xjb:使用外部绑定文件(.xjb)覆盖默认映射,例如重命名类、调整集合类型、忽略某些元素
  • -no-header:生成时不加自动生成声明头(如 “Generated by XJC…” 注释)
  • -nv:跳过 XSD 验证(仅当 schema 有引用但本地不可达时临时使用,不推荐长期开启)

配合 Maven 自动化(推荐现代项目使用)

pom.xml 中配置 jaxb2-maven-pluginorg.codehaus.mojo:jaxb2-maven-plugin


  org.codehaus.mojo
  jaxb2-maven-plugin
  2.5.0
  
    
      xjc
    
  
  
    src/main/resources/schema/person.xsd
    com.example.model
    ${project.build.directory}/generated-sources/jaxb
  

执行 mvn generate-sources 即可自动编译 XSD 并加入编译路径。

不复杂但容易忽略:生成的类默认使用 @XmlRootElement@XmlElement 等注解,无需额外配置即可用 JAXBContext 进行 XML 绑定。注意确保 XSD 中的命名空间、targetNamespace 与 Java 包结构逻辑一致,否则可能影响序列化结果。