java - 您可以更改 JAXB 中 nillable 属性的默认值吗？

Question

我正在重构一些代码以使用 JAXB 和反射将代码输出到客户端，它目前正在使用 XMLWriter 并且每次都手动创建标签。

我遇到的问题是，由于客户端的限制，对于 java 类中的任何空字段，我需要在 XML 中包含空元素。

虽然我意识到这个问题可以通过向每个 JAXB XmlElement 注释添加 nillable=true 来解决，但这不是最实用的，因为我有很多这样的注释注释。

我希望找到一种方法将 nillable=true 设置为全局属性(或默认值)。这也将使 future 的同事更容易处理它，因为他们不需要记住每个注释都应该包含 nillable 属性。

除了对默认行为的描述外，我没有找到太多信息。令我惊讶的是，过去没有其他人发布过类似的问题。根据我的发现，在我看来似乎没有任何内置支持使默认值可配置。这是否可以通过自定义 JAXB 实现或第三方 JAXB 实现来解决？

Answer 1

注意:我是 EclipseLink JAXB (MOXy) 领导和 JAXB 2 (JSR-222) 的成员专家组。

我已输入增强请求以将此行为添加到 EclipseLink JAXB (MOXy):

• http://bugs.eclipse.org/368547

解决方法

如果所有映射的字符串字段/属性都映射到 XML 元素，那么以下 XmlAdapter 方法可能适合您:

空字符串适配器

此 XmlAdapter 会将 String 的实例编码为名为 AdaptedString 的对象。 AdaptedString 包含 String 值以及映射到 xsi:nil 属性的字段。在 XmlAdapter 中，我们将根据 String 值是否为空来设置该字段的值。

package forum8841221;

import javax.xml.bind.annotation.*;
import javax.xml.bind.annotation.adapters.*;

public class NullStringAdapter extends XmlAdapter<NullStringAdapter.AdaptedString, String> {

    @Override
    public AdaptedString marshal(String v) throws Exception {
        AdaptedString adaptedString = new AdaptedString();
        if(null == v) {
            adaptedString.nil = true;
        }
        adaptedString.value = v;
        return adaptedString;
    }

    @Override
    public String unmarshal(AdaptedString v) throws Exception {
        return v.value;
    }

    public static class AdaptedString {

        @XmlAttribute(namespace="http://www.w3.org/2001/XMLSchema-instance")
        public Boolean nil;

        @XmlValue
        @XmlJavaTypeAdapter(VoidStringAdapter.class)
        public String value;

    }

    public static class VoidStringAdapter extends XmlAdapter<String, String> {

        @Override
        public String marshal(String v) throws Exception {
            return v;
        }

        @Override
        public String unmarshal(String v) throws Exception {
            return v;
        }

    }

}

包信息

我们可以通过注册 XmlAdapter 来注册我们希望此 XmlAdapter 应用于此包上所有映射的 String 字段/属性包级别。

@XmlJavaTypeAdapter(value=NullStringAdapter.class, type=String.class)
@XmlSchema(xmlns={@XmlNs(namespaceURI = "http://www.w3.org/2001/XMLSchema-instance", prefix = "xsi")})
package forum8841221;

import javax.xml.bind.annotation.adapters.*;
import javax.xml.bind.annotation.*;

根

下面是我在这个例子中使用的域类。它有几个 String 属性，其中一个用 @XmlElement(nillable=true) 注释

package forum8841221;

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement
public class Root {

    private String a;
    private String b;
    private String c;
    private String d;

    public String getA() {
        return a;
    }

    public void setA(String a) {
        this.a = a;
    }

    public String getB() {
        return b;
    }

    public void setB(String b) {
        this.b = b;
    }

    public String getC() {
        return c;
    }

    public void setC(String c) {
        this.c = c;
    }

    @XmlElement(nillable=true)
    public String getD() {
        return d;
    }

    public void setD(String d) {
        this.d = d;
    }

}

演示

package forum8841221;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.Marshaller;

public class Demo {

    public static void main(String[] args) throws Exception {
        JAXBContext jc = JAXBContext.newInstance(Root.class);

        Root root = new Root();
        root.setB("B");

        Marshaller marshaller = jc.createMarshaller();
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        marshaller.marshal(root, System.out);
    }

}

输出

<?xml version="1.0" encoding="UTF-8"?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <a xsi:nil="true"/>
   <b>B</b>
   <c xsi:nil="true"/>
   <d xsi:nil="true"/>
</root>