您如何自定义 JAXB 生成复数方法名称的方式？答案

【问题标题】：How do you customize how JAXB generates plural method names?您如何自定义 JAXB 生成复数方法名称的方式？
【发布时间】：2011-05-28 23:36:16
【问题描述】：

我们正在使用 JAXB 生成 Java 类，并且遇到了一些生成的复数方法名称不正确的情况。例如，我们期望getPhysicians 得到getPhysicien。我们将如何自定义 JAXB 如何使特定方法复数？

架构：

<xs:complexType name="physician">
    <xs:sequence>
       ...
    </xs:sequence>
</xs:complexType>

<xs:complexType name="physicianList">
    <xs:sequence>
        <xs:element name="Physician"
                    type="physician"
                    minOccurs="0"
                    maxOccurs="unbounded"/>
    </xs:sequence>
</xs:complexType>

生成的Java代码：

...
public class PhysicianList {
...

    @XmlElement(name = "Physician")
    protected List<Physician> physicien;
    ...

    public List<Physician> getPhysicien() {
        if (physicien == null) {
            physicien = new ArrayList<Physician>();
        }
        return this.physicien;
    }

更新

布莱斯已经回答了这个问题。但是，我不喜欢在 XML 模式中混合诸如 JAXB 自定义之类的问题。因此，对于那些有相同偏好的人，这里有一个 JAXB 绑定文件，它实现了与 Blaise 建议的相同的事情，将 JAXB 自定义排除在模式之外：

<jaxb:bindings xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
               xmlns:xs="http://www.w3.org/2001/XMLSchema"
               version="2.0">

    <jaxb:bindings schemaLocation="myschema.xsd">
        <jaxb:bindings node="//xs:complexType[@name='physicianList']//xs:element[@name='Physician']">
            <jaxb:property name="physicians"/>
        </jaxb:bindings>
    </jaxb:bindings>

</jaxb:bindings>

【问题讨论】：

它甚至没有正确拼写医生，而是拼写为 physicien。奇怪。
XJC 实际上基于列表的元素名称，因此您可以直接调用元素名称医生。但是（这是一个很大的但是......）如果您这样做，仍然有一个怪癖，即当您使用 JAXB 重新编组对象时，每个元素都将具有复数名称“医生”。很奇怪。也就是说，我已经使用了你的方法，而且效果很好。

标签： java xml jaxb jaxb2

【解决方案1】：

默认情况下会为您的架构片段生成以下内容：

    import java.util.ArrayList;
    import java.util.List;
    import javax.xml.bind.annotation.XmlAccessType;
    import javax.xml.bind.annotation.XmlAccessorType;
    import javax.xml.bind.annotation.XmlElement;
    import javax.xml.bind.annotation.XmlType;

    @XmlAccessorType(XmlAccessType.FIELD)
    @XmlType(name = "physicianList", propOrder = {
        "physician"
    })
    public class PhysicianList {

        @XmlElement(name = "Physician")
        protected List<Physician> physician;

        public List<Physician> getPhysician() {
            if (physician == null) {
                physician = new ArrayList<Physician>();
            }
            return this.physician;
        }

    }

如果您注释您的 XML 架构：

    <xs:schema
        xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
        xmlns:xs="http://www.w3.org/2001/XMLSchema"
        jaxb:version="2.1">

        <xs:complexType name="physician">
            <xs:sequence>
            </xs:sequence>
        </xs:complexType>

        <xs:complexType name="physicianList">
            <xs:sequence>
                <xs:element name="Physician"
                            type="physician"
                            minOccurs="0"
                            maxOccurs="unbounded">
                      <xs:annotation>
                          <xs:appinfo>
                              <jaxb:property name="physicians"/>
                          </xs:appinfo>
                      </xs:annotation>
                 </xs:element>
            </xs:sequence>
        </xs:complexType>

    </xs:schema>

然后就可以生成想要的类了：

import java.util.ArrayList;
import java.util.List;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;

@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "physicianList", propOrder = {
    "physicians"
})
public class PhysicianList {

    @XmlElement(name = "Physician")
    protected List<Physician> physicians;

    public List<Physician> getPhysicians() {
        if (physicians == null) {
            physicians = new ArrayList<Physician>();
        }
        return this.physicians;
    }

}

【讨论】：

效果很好。谢谢！仅供参考，我不喜欢在 XML 模式中混合诸如 JAXB 自定义之类的问题，因此我在问题的末尾添加了一个使用绑定文件来执行您建议的操作的示例。再次感谢！
我尝试了您建议的解决方案，但生成的类仍然没有我想要的返回类型。我已经问了另一个问题here。如果您也花时间回答这个问题，我将非常感谢您的帮助。

【解决方案2】：

也许现在回答有点晚了，但还有另一种方法可以简单地生成复数名称，无需混合 XML Schema 和 JAXB 绑定。

通过使用带有“-extension”模式的 JAXB XJC 绑定编译器。需要添加一个自定义绑定文件，如下所示：

<?xml version="1.0"?>
<jxb:bindings version="1.0"
              xmlns:jxb="http://java.sun.com/xml/ns/jaxb"
              xmlns:xs="http://www.w3.org/2001/XMLSchema"
              xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc"
              jxb:extensionBindingPrefixes="xjc">

  <jxb:globalBindings>              
    <xjc:simple/>
  </jxb:globalBindings>

</jxb:bindings>

参考资料：

Experimental simpler&better binding mode（编辑：过时的链接）
Experimental simpler&better binding mode（新链接）
JAXB: How to change XJC-generated classes names when attr type is specified in XSD?

【讨论】：