如何将自定义序列化程序与 Jackson 一起使用？

Question

我有两个 Java 类，我想使用 Jackson 将其序列化为 JSON：

 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;
    }
}

我想将一个项目序列化为这个 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 不支持接口。

原文由 Jonas 发布，翻译遵循 CC BY-SA 4.0 许可协议

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 也更安全，因为它将具有非必要方法的标准实现（即除实际序列化调用之外的所有方法）。

原文由 StaxMan 发布，翻译遵循 CC BY-SA 3.0 许可协议

Answer 2

您可以将 @JsonSerialize(using = CustomDateSerializer.class) 放在要序列化的对象的任何日期字段上。

 public class CustomDateSerializer extends SerializerBase<Date> {

    public CustomDateSerializer() {
        super(Date.class, true);
    }

    @Override
    public void serialize(Date value, JsonGenerator jgen, SerializerProvider provider)
        throws IOException, JsonProcessingException {
        SimpleDateFormat formatter = new SimpleDateFormat("EEE MMM dd yyyy HH:mm:ss 'GMT'ZZZ (z)");
        String format = formatter.format(value);
        jgen.writeString(format);
    }

}

原文由 Moesio 发布，翻译遵循 CC BY-SA 3.0 许可协议