为什么 JAXB 需要一个无参数构造函数来进行编组？

Question

如果您尝试封送一个引用没有无参数构造函数的复杂类型的类，例如：

import java.sql.Date;

@XmlRootElement(name = "Foo")
@XmlAccessorType(XmlAccessType.FIELD)
public class Foo {
    int i;
    Date d; //java.sql.Date does not have a no-arg constructor
}

使用属于 Java 一部分的 JAXB 实现，如下所示：

    Foo foo = new Foo();
    JAXBContext jc = JAXBContext.newInstance(Foo.class);
    ByteArrayOutputStream baos = new ByteArrayOutputStream();
    Marshaller marshaller = jc.createMarshaller();
    marshaller.marshal(foo, baos);

JAXB 将抛出 a

com.sun.xml.internal.bind.v2.runtime.IllegalAnnotationsException: 1 counts of IllegalAnnotationExceptions java.sql.Date does not have a no-arg default constructor

现在，我明白为什么 JAXB 需要一个解组时使用无参数构造函数 - 因为它需要实例化对象。但为什么 JAXB 在编组时需要无参数构造函数？

另外，还有一个问题，如果字段为空，为什么 Java 的 JAXB 实现会抛出异常，并且无论如何都不会被编组？

我是否遗漏了某些内容，或者这些只是 Java 的 JAXB 实现中的错误实现选择？

Answer 1

当 JAXB (JSR-222) 实现初始化其元数据时，它确保它可以支持编组和解组。

对于没有无参数构造函数的 POJO 类，您可以使用类型级别 XmlAdapter 来处理它：

• http://blog.bdoughan.com/2010/12/jaxb-and-immutable-objects.html

默认情况下不支持 java.sql.Date （尽管在 EclipseLink JAXB (MOXy) 是的）。这也可以使用通过 @XmlJavaTypeAdapter 在字段、属性或包级别指定的 XmlAdapter 来处理：

• http://blog.bdoughan.com/2011/05/jaxb- and-joda-time-dates-and-times.html
• http://blog.bdoughan.com/2011/01/jaxb-and-datetime-properties。 html

---

另外，还有一个问题，为什么 Java 的 JAXB 实现会抛出一个错误
如果该字段为空并且不会被编组，则会出现异常
无论如何？

您看到什么异常？通常，当字段为 null 时，它不会包含在 XML 结果中，除非使用 @XmlElement(nillable=true) 进行注释，在这种情况下，该元素将包含 xsi:nil="true “。

---

更新

您可以执行以下操作：

SqlDateAdapter

下面是一个将从java.sql.Date转换而来的XmlAdapter您的 JAXB 实现不知道如何处理 java.util.Date，它确实这样做：

package forum9268074;

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

public class SqlDateAdapter extends XmlAdapter<java.util.Date, java.sql.Date> {

    @Override
    public java.util.Date marshal(java.sql.Date sqlDate) throws Exception {
        if(null == sqlDate) {
            return null;
        }
        return new java.util.Date(sqlDate.getTime());
    }

    @Override
    public java.sql.Date unmarshal(java.util.Date utilDate) throws Exception {
        if(null == utilDate) {
            return null;
        }
        return new java.sql.Date(utilDate.getTime());
    }

}

Foo

XmlAdapter 是通过@XmlJavaTypeAdapter 注解：

package forum9268074;

import java.sql.Date;
import javax.xml.bind.annotation.*;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;

@XmlRootElement(name = "Foo")
@XmlAccessorType(XmlAccessType.FIELD)
public class Foo {
    int i;

    @XmlJavaTypeAdapter(SqlDateAdapter.class)
    Date d; //java.sql.Date does not have a no-arg constructor
}

Answer 2

回答你的问题：我认为这只是 JAXB 中的糟糕设计（或者可能是 JAXB 实现中的设计）。无参数构造函数的存在会在创建 JAXBContext 期间得到验证，因此无论您想使用 JAXB 进行编组还是解组，都适用。如果 JAXB 将这种类型的检查推迟到 JAXBContext.createUnmarshaller() 那就太好了。我认为深入研究这个设计是否确实是规范所强制的，或者它是否是 JAXB-RI 中的实现设计，将会很有趣。

但确实有一个解决方法。

JAXB 实际上不需要无参数构造函数来进行编组。下面我假设您仅使用 JAXB 进行编组，而不是解组。我还假设您可以控制要编组的不可变对象，以便可以更改它。如果情况并非如此，那么唯一的前进方法是 XmlAdapter 如其他答案中所述。

假设您有一个类 Customer，它是一个不可变对象。实例化是通过构建器模式或静态方法进行的。

public class Customer {
    
    private final String firstName;
    private final String lastName;

    private Customer(String firstName, String lastName) {
        this.firstName = firstName;
        this.lastName = lastName;
    }

    // Object created via builder pattern
    public static CustomerBuilder createBuilder() {
        ...
    }
    
    // getters here ...
}

确实，默认情况下您无法让 JAXB 来解组此类对象。您将收到错误“....客户没有无参数默认构造函数”。

至少有两种方法可以解决这个问题。它们都仅仅依靠放入方法或构造函数来使 JAXB 的自省满意。

解决方案 1

在此方法中，我们告诉 JAXB 有一个静态工厂方法，它可以用来实例化该类的实例。我们知道，但 JAXB 不知道，这确实永远不会被使用。诀窍是 带有factoryMethod参数的@XmlType注释。方法如下：

@XmlType(factoryMethod="createInstanceJAXB")
public class Customer {
    ...
    
    private static Customer createInstanceJAXB() {  // makes JAXB happy, will never be invoked
        throw new UnsupportedOperationException("Unexpected invocation: Customer object is not intended to be used for unmarshalling, only marshalling");
    }

    ...
}

该方法是否像示例中那样是私有的并不重要。 JAXB 仍将接受它。如果您将该方法设为私有，您的 IDE 会将其标记为未使用，但我仍然更喜欢私有。

解决方案 2

在此解决方案中，我们添加一个私有无参数构造函数，该构造函数仅将 null 传递到真正的构造函数中。

public class Customer {
    ...
    private Customer() {  // makes JAXB happy, will never be invoked
        throw new UnsupportedOperationException("Unexpected invocation: Customer object is not intended to be used for unmarshalling, only marshalling");
    }

    ...
}

构造函数是否像示例中那样是私有的并不重要。 JAXB 仍将接受它。

总结

两种解决方案都满足了 JAXB 对无参数实例化的需求。遗憾的是，当我们自己知道我们只需要编组而不是解组时，我们需要这样做。

我不得不承认，我不知道这种黑客攻击在多大程度上只能与 JAXB-RI 一起使用，而不能与 EclipseLink MOXy 一起使用。它绝对可以与 JAXB-RI 配合使用。

Answer 3

您似乎认为 JAXB 内省代码将具有用于初始化的操作特定路径。如果是这样，就会导致大量重复代码，并且实现效果会很差。我想象 JAXB 代码有一个通用例程，它在第一次需要模型类时检查它并验证它是否遵循所有必要的约定。在这种情况下，它会失败，因为其中一个成员没有所需的无参数构造函数。初始化逻辑很可能不是特定于编组/解组的，并且也极不可能考虑当前对象实例。

Answer 4

一些企业和依赖注入框架使用反射Class.newInstance() 创建类的新实例。此方法需要一个公共无参数构造函数才能实例化该对象。