Java如何在Jackson上使用自定义序列化程序？

Question

我有两个要使用Jackson序列化为JSON的Java类：

public class User {
    public final int id;
    public final String name;

    public User(int id, String name) {
        this.id = id;
        this.name = name;
    }
}

public class Item {
    public final int id;
    public final String itemNr;
    public final User createdBy;

    public Item(int id, String itemNr, User createdBy) {
        this.id = id;
        this.itemNr = itemNr;
        this.createdBy = createdBy;
    }
}

我想将Item序列化为此JSON：

{"id":7, "itemNr":"TEST", "createdBy":3}

用户序列化为仅包含id。我还将能够将所有用户对象序列化为JSON，例如：

{"id":3, "name": "Jonas", "email": "[e-mail]"}

所以我想我需要为此编写一个自定义的序列化程序Item并尝试过：

public class ItemSerializer extends JsonSerializer<Item> {

@Override
public void serialize(Item value, JsonGenerator jgen,
        SerializerProvider provider) throws IOException,
        JsonProcessingException {
    jgen.writeStartObject();
    jgen.writeNumberField("id", value.id);
    jgen.writeNumberField("itemNr", value.itemNr);
    jgen.writeNumberField("createdBy", value.user.id);
    jgen.writeEndObject();
}

}

我使用来自Jackson How-to：Custom Serializers的以下代码对JSON进行了序列化：

ObjectMapper mapper = new ObjectMapper();
SimpleModule simpleModule = new SimpleModule("SimpleModule", 
                                              new Version(1,0,0,null));
simpleModule.addSerializer(new ItemSerializer());
mapper.registerModule(simpleModule);
StringWriter writer = new StringWriter();
try {
    mapper.writeValue(writer, myItem);
} catch (JsonGenerationException e) {
    e.printStackTrace();
} catch (JsonMappingException e) {
    e.printStackTrace();
} catch (IOException e) {
    e.printStackTrace();
}

但是我得到这个错误：

Exception in thread "main" java.lang.IllegalArgumentException: JsonSerializer of type com.example.ItemSerializer does not define valid handledType() (use alternative registration method?)
    at org.codehaus.jackson.map.module.SimpleSerializers.addSerializer(SimpleSerializers.java:62)
    at org.codehaus.jackson.map.module.SimpleModule.addSerializer(SimpleModule.java:54)
    at com.example.JsonTest.main(JsonTest.java:54)

如何在Jackson上使用自定义序列化程序？

这就是我对Gson的处理方式：

public class UserAdapter implements JsonSerializer<User> {

    @Override 
    public JsonElement serialize(User src, java.lang.reflect.Type typeOfSrc,
            JsonSerializationContext context) {
        return new JsonPrimitive(src.id);
    }
}

    GsonBuilder builder = new GsonBuilder();
    builder.registerTypeAdapter(User.class, new UserAdapter());
    Gson gson = builder.create();
    String json = gson.toJson(myItem);
    System.out.println("JSON: "+json);

但是我现在需要和Jackson一起做，因为Gson不支持接口。

Answer 1

如前所述，@ JsonValue是一个好方法。但是，如果你不介意使用自定义序列化程序，则无需为Item编写一个，而为User编写一个。如果是这样，它将很简单：

public void serialize(Item value, JsonGenerator jgen,
    SerializerProvider provider) throws IOException,
    JsonProcessingException {
  jgen.writeNumber(id);
}

还有另一种可能性是实施JsonSerializable，在这种情况下，不需要注册。

关于错误；这很奇怪-你可能想升级到更高版本。但是，org.codehaus.jackson.map.ser.SerializerBase由于它具有非必需方法的标准实现（即，除了实际的序列化调用之外的所有方法），因此扩展起来也更安全。