如何将自定义序列化程序与 Jackson 配合使用？

serialization json java jackson

2022-08-31 08:40:58

我有两个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}

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

{"id":3, "name": "Jonas", "email": "jonas@example.com"}

所以我想我需要编写一个自定义序列化程序，并尝试使用这个：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不支持接口。

答案 1

您可以放置要序列化的对象的任何日期字段。@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);
    }

}

答案 2

如前所述，@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