Как мне использовать пользовательский сериализатор с Jackson?
У меня есть два класса Java, которые я хочу сериализовать в JSON с помощью Jackson:
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": "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();
}
}
Я сериализую JSON с помощью этого кода из Jackson How-to: Пользовательские сериализаторы:
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
поскольку он будет иметь стандартные реализации несущественных методов (т. Е. Все, кроме фактического вызова сериализации).
Ответ 3
Я тоже пытался это сделать, и в примере кода на веб-странице Jackson ошибка, из-за которой не удается включить тип (.class
) в вызов addSerializer()
метода, который должен читаться следующим образом:
simpleModule.addSerializer(Item.class, new ItemSerializer());
Другими словами, это строки, которые создают экземпляр simpleModule
и добавляют сериализатор (при этом предыдущая неправильная строка закомментирована):
ObjectMapper mapper = new ObjectMapper();
SimpleModule simpleModule = new SimpleModule("SimpleModule",
new Version(1,0,0,null));
// simpleModule.addSerializer(new ItemSerializer());
simpleModule.addSerializer(Item.class, new ItemSerializer());
mapper.registerModule(simpleModule);
К вашему сведению: Вот ссылка на правильный пример кода: http://wiki.fasterxml.com/JacksonFeatureModules
Ответ 4
Используйте @JsonValue:
public class User {
int id;
String name;
@JsonValue
public int getId() {
return id;
}
}
@JsonValue работает только с методами, поэтому вы должны добавить метод getId .
Вы должны иметь возможность вообще пропустить свой пользовательский сериализатор.