自定义Jackson Serializer for Wrapper Object

时间:2012-02-26 22:24:37

标签: java json jackson

我有提供者界面

interface IProvider<T> {
    T locate();
}

和包含IProvider类型字段的类(可以是其他字段的另一种类型)。

class MyObject {
    MyLocator<String> field;
}

我需要使用Jackson 1.7将MyObject的实例序列化为JSON。输出必须与MyObject.field是一个String(即没有ILocator的引用)相同。

我无法弄清楚如何构建实现此目的所需的自定义序列化程序。以下是我尝试用于此任务的结构:

class MyLocatorSerializer extends SerializerBase<MyLocator<?>> {
    public MyLocatorSerializer() {
        super(MyLocator.class, false);
    }

    @Override
    public void serialize(MyLocator<?> a_value, JsonGenerator a_jgen,
            SerializerProvider a_provider) throws IOException, JsonGenerationException {
        // Insert code here to serialize a_value.locate(), whatever its type
    }

    @Override
    public JsonNode getSchema(SerializerProvider a_provider, Type a_typeHint)
            throws JsonMappingException {
        // What should I return here? I can't find documentation regarding the different schema types...
    }
}

将使用

注册自定义序列化程序
SimpleModule module = new SimpleModule("MyModule", new Version(1, 0, 0, null));
module.addSerializer(new MyLocatorSerializer());
objectMapper.registerModule(module);

3 个答案:

答案 0 :(得分:3)

在Staxman的评论之后使用混合注释的另一个答案。

static class JacksonCustomModule extends SimpleModule {
    public JacksonCustomModule() {
        super("JacksonCustomModule", new Version(1, 0, 0, null));
    }

    @Override
    public void setupModule(SetupContext context) {
        context.setMixInAnnotations(IProvider.class, IProviderMixIn.class);
        super.setupModule(context);
    }

    interface IProviderMixIn<T> {
        @JsonValue
        T locate();
    }
}

使用以下命令激活模块:

objectMapper.registerModule(new JacksonCustomModule());

答案 1 :(得分:2)

如果我误解了这个问题,请道歉,但是这会像在{Locate'方法上使用@JsonValue一样简单,而不是编写自定义序列化程序吗? @JsonValue所做的是按原样获取属性的值,并使用它而不是创建JSON对象:通常这用于将POJO序列化为简单的字符串或数字,如下所示:

public class StringWrapper {
   @JsonValue public String value;
}

所以对于类来说:

public class POJO {
   public StringWrapper wrapped;
}

我们会得到类似的序列化:

{
  "wrapper" : "string value of 'value'"
}

而不是以其他方式看到的内容:

{
   "wrapper" : {
      "value" : "... string value ... "
   }
}

注释显然可以用于任何类型的值。

答案 2 :(得分:0)

按照StaxMan的回答,我检查了@JsonValue的工作情况并获得了以下序列化程序:

// Based on JsonValueSerializer
private static class ProviderSerializer extends SerializerBase<IProvider<?>> {

    public ProviderSerializer() {
        super(IProvider.class, false);
    }

    @Override
    public void serialize(IProvider<?> value, JsonGenerator jgen, SerializerProvider provider)
            throws IOException, JsonGenerationException {
        Object object = value.locate();

        // and if we got null, can also just write it directly
        if (object == null) {
            provider.defaultSerializeNull(jgen);
            return;
        }

        Class<?> c = object.getClass();
        JsonSerializer<Object> ser = provider.findTypedValueSerializer(c, true, null);
        // note: now we have bundled type serializer, so should NOT call with typed version
        ser.serialize(object, jgen, provider);
    }

    @Override
    public JsonNode getSchema(SerializerProvider provider, Type typeHint)
            throws JsonMappingException {
        // is this right??
        return JsonSchema.getDefaultSchemaNode();
    }
}

经过一些测试,这就是我需要的。但是,我并不完全理解getSchema方法的目的,所以也许我做错了......