使用MongoDB，Jackson和MongoJack的自定义序列化器

Question

我有一个类，当进行序列化时，应该在其位置序列化其成员之一。 我的课是：

@JsonSerialize(using = MyClassSerializer.class)
public class MyClass implements Serializable {

    /**
     * A default ID for this class for serialization.
     */
    private static final long serialVersionUID = 1L;

    /**
     * A member of this object.
     */
    private final OtherClass otherClass;

    ...

    /**
     * Returns the instance of the member object.
     * 
     * @return The instance of the member object.
     */
    public OtherClass getOtherClass() {
        return otherClass;
    }
}

为此，我创建了一个非常简单的自定义序列化程序：

public class MyClassSerializer extends JsonSerializer<MyClass> {
    /**
     * Serializes only the OtherClass field.
     */
    @Override
    public void serialize(
        final MyClass myClass,
        final JsonGenerator generator,
        final SerializerProvider provider)
        throws IOException, JsonProcessingException {

        // Write the schema.
        generator.writeObject(myClass.getOtherClass());
    }
}

这是做这样的事情的最简单（也是最正确的方法）。 即使我愿意，为OtherClass编写自定义序列化程序也将非常复杂，因为它是抽象的根类。 可以通过Jackson来完成，但是要有一些注释：

@JsonTypeInfo(
    use = Id.NAME,
    include = As.PROPERTY,
    property = OtherClass.JSON_KEY_TYPE,
    defaultImpl = OtherClassDefault.class)
@JsonSubTypes({
    @JsonSubTypes.Type(
        value = SubOtherClass1.class,
        name = SubOtherClass1.TYPE_ID),
    @JsonSubTypes.Type(
        value = SubOtherClass2.class,
        name = SubOtherClass2.TYPE_ID),
    @JsonSubTypes.Type(
        value = SubOtherClass3.class,
        name = SubOtherClass3.TYPE_ID),
    @JsonSubTypes.Type(
        value = SubOtherClass4.class,
        name = SubOtherClass4.TYPE_ID),
    @JsonSubTypes.Type(
        value = SubOtherClass5.class,
        name = SubOtherClass5.TYPE_ID) })
@JsonAutoDetect(
    fieldVisibility = Visibility.DEFAULT,
    getterVisibility = Visibility.NONE,
    setterVisibility = Visibility.NONE,
    creatorVisibility = Visibility.DEFAULT)
public abstract class OtherClass implements Serializable {
    ...
}

我已经使用Jackson进行了序列化和反序列化MyClass实例的测试，它完全可以按预期工作。

我的应用程序代码稍微复杂一些。 我有一个具有MyClass类型成员的ContainerClass 。 我尝试通过MongoJack序列化ContainerClass的实例：

// Get the authentication token collection.
JacksonDBCollection<ContainerClass, Object> collection =
    JacksonDBCollection
        .wrap(
            MongoBinController
                .getInstance()
                .getDb()
                .getCollection(COLLECTION_NAME),
            ContainerClass.class);

// Save it.
collection.insert(container);

但是，我收到以下错误：

...
Caused by: java.lang.IllegalArgumentException: can't serialize class my.package.MyClass
    at org.bson.BasicBSONEncoder._putObjectField(BasicBSONEncoder.java:270)
    ...

如果从MyClass删除@JsonSerialize ，我可以使它工作，但是这导致整个MyClass实例被序列化，这不是我想要的。 这几乎使我确定问题出在我的自定义序列化程序中，但是我不确定应该如何编写它。

先感谢您。

Answer 1

快速说明可能会有所帮助：使用多态类型时，调用的方法将是：

serializeWithType(...)

而不是serialize(...) 因此，您将需要实现该方法。 通常它会很简单：

typeSer.writeTypePrefixForObject(value, jgen);
// implement actual content serialization, or delegate here:
this.serialize(...);
typeSer.writeTypeSuffixForObject(value, jgen);

但您可能想看看标准的Jackson序列化器。 唯一真正的区别是，虽然serialize需要直接输出START_OBJECT，END_OBJECT，但在这里我们必须要求TypeSerializer添加它们。 这是必需的，因为type id包含实际上可能会更改这些内容（我可以对此进行详细说明，但现在就足够了）。

但是：这里可能有更简单的解决方案。 如果可以在要使用的成员上添加@JsonValue批注而不是整个对象（直接或通过混合），则可以实现此目的：

@JsonValue
public OtherClass getOtherClass()...

如果需要反序列化，则可以使用@JsonCreator例如：

@JsonCreator
public MyClass(OtherClass surrogate) { ... }