Джексон: как добавить настраиваемое свойство в JSON без изменения POJO
Я разрабатываю интерфейс REST для своего приложения, используя Jackson для сериализации объектов домена POJO для представления JSON. Я хочу настроить сериализацию для некоторых типов для добавления дополнительных свойств в представление JSON, которые не существуют в POJO (например, добавить некоторые метаданные, справочные данные и т.д.). Я знаю, как написать свой собственный JsonSerializer, но в этом случае мне нужно было бы явно вызвать методы JsonGenerator.writeXXX(..) для свойства each для моего объекта, тогда как все, что мне нужно, это просто добавить дополнительное свойство. Другими словами, я хотел бы написать что-то вроде:
@Override
public void serialize(TaxonomyNode value, JsonGenerator jgen, SerializerProvider provider) {
jgen.writeStartObject();
jgen.writeAllFields(value); // <-- The method I'd like to have
jgen.writeObjectField("my_extra_field", "some data");
jgen.writeEndObject();
}
или (еще лучше), чтобы как-то перехватить сериализацию перед вызовом jgen.writeEndObject(), например:
@Override void beforeEndObject(....) {
jgen.writeObjectField("my_extra_field", "some data");
}
Я думал, что могу расширить BeanSerializer и переопределить его метод serialize(..), но объявил final, а также не смог найти простой способ создать новый экземпляр BeanSerializer, не предоставив его всем типом детали метаданных практически дублируют хорошую часть Джексона. Поэтому я отказался от этого.
Мой вопрос - как настроить сериализацию Джексона, чтобы добавить дополнительный материал к выходу JSON для конкретных POJO, не внося слишком много кода шаблона и повторно используя максимально возможное поведение Джексона по умолчанию.
Ответы
Ответ 1
После более подробного изучения исходного кода Джексона я пришел к выводу, что его просто невозможно достичь, не нажимая собственные BeanSerializer, BeanSerializerBuilder и BeanSerializerFactory и предоставляя некоторые точки расширения, такие как:
/*
/**********************************************************
/* Extension points
/**********************************************************
*/
protected void beforeEndObject(T bean, JsonGenerator jgen, SerializerProvider provider) throws IOException, JSONException {
// May be overridden
}
protected void afterStartObject(T bean, JsonGenerator jgen, SerializerProvider provider) throws IOException, JSONException {
// May be overridden
}
К сожалению, мне пришлось копировать и вставлять весь исходный код Jackson BeanSerializer в MyCustomBeanSerializer, потому что первый не разработан для расширений, объявляющих все поля и некоторые важные методы (например, serialize(...)) как final
Ответ 2
Так как (я думаю) Jackson 1.7 вы можете сделать это с помощью BeanSerializerModifier и расширения BeanSerializerBase. Я тестировал пример ниже с помощью Jackson 2.0.4.
import java.io.IOException;
import org.junit.Test;
import com.fasterxml.jackson.core.JsonGenerationException;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.BeanDescription;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationConfig;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.module.SimpleModule;
import com.fasterxml.jackson.databind.ser.BeanSerializerModifier;
import com.fasterxml.jackson.databind.ser.impl.ObjectIdWriter;
import com.fasterxml.jackson.databind.ser.std.BeanSerializerBase;
public class JacksonSerializeWithExtraField {
@Test
public void testAddExtraField() throws Exception
{
ObjectMapper mapper = new ObjectMapper();
mapper.registerModule(new SimpleModule() {
public void setupModule(SetupContext context) {
super.setupModule(context);
context.addBeanSerializerModifier(new BeanSerializerModifier() {
public JsonSerializer<?> modifySerializer(
SerializationConfig config,
BeanDescription beanDesc,
JsonSerializer<?> serializer) {
if (serializer instanceof BeanSerializerBase) {
return new ExtraFieldSerializer(
(BeanSerializerBase) serializer);
}
return serializer;
}
});
}
});
mapper.writeValue(System.out, new MyClass());
//prints {"classField":"classFieldValue","extraField":"extraFieldValue"}
}
class MyClass {
private String classField = "classFieldValue";
public String getClassField() {
return classField;
}
public void setClassField(String classField) {
this.classField = classField;
}
}
class ExtraFieldSerializer extends BeanSerializerBase {
ExtraFieldSerializer(BeanSerializerBase source) {
super(source);
}
ExtraFieldSerializer(ExtraFieldSerializer source,
ObjectIdWriter objectIdWriter) {
super(source, objectIdWriter);
}
ExtraFieldSerializer(ExtraFieldSerializer source,
String[] toIgnore) {
super(source, toIgnore);
}
protected BeanSerializerBase withObjectIdWriter(
ObjectIdWriter objectIdWriter) {
return new ExtraFieldSerializer(this, objectIdWriter);
}
protected BeanSerializerBase withIgnorals(String[] toIgnore) {
return new ExtraFieldSerializer(this, toIgnore);
}
public void serialize(Object bean, JsonGenerator jgen,
SerializerProvider provider) throws IOException,
JsonGenerationException {
jgen.writeStartObject();
serializeFields(bean, jgen, provider);
jgen.writeStringField("extraField", "extraFieldValue");
jgen.writeEndObject();
}
}
}
Ответ 3
Вы можете сделать это (предыдущая версия не работала с Jackson после 2.6, но это работает с Jackson 2.7.3):
public static class CustomModule extends SimpleModule {
public CustomModule() {
addSerializer(CustomClass.class, new CustomClassSerializer());
}
private static class CustomClassSerializer extends JsonSerializer {
@Override
public void serialize(Object value, JsonGenerator jgen, SerializerProvider provider) throws IOException {
//Validate.isInstanceOf(CustomClass.class, value);
jgen.writeStartObject();
JavaType javaType = provider.constructType(CustomClass.class);
BeanDescription beanDesc = provider.getConfig().introspect(javaType);
JsonSerializer<Object> serializer = BeanSerializerFactory.instance.findBeanSerializer(provider,
javaType,
beanDesc);
// this is basically your 'writeAllFields()'-method:
serializer.unwrappingSerializer(null).serialize(value, jgen, provider);
jgen.writeObjectField("my_extra_field", "some data");
jgen.writeEndObject();
}
}
}
Ответ 4
Jackson 2.5 представил аннотацию @JsonAppend, которая может использоваться для добавления "виртуальных" свойств во время сериализации. Его можно использовать с функциональностью mixin, чтобы избежать изменения исходного POJO.
В следующем примере добавляется свойство ApprovalState во время сериализации:
@JsonAppend(
attrs = {
@JsonAppend.Attr(value = "ApprovalState")
}
)
public static class ApprovalMixin {}
Зарегистрируйте mixin с помощью ObjectMapper:
mapper.addMixIn(POJO.class, ApprovalMixin.class);
Используйте ObjectWriter для установки атрибута во время сериализации:
ObjectWriter writer = mapper.writerFor(POJO.class)
.withAttribute("ApprovalState", "Pending");
Использование сценария для сериализации добавит поле ApprovalState к выходу.
Ответ 5
Хотя этот вопрос уже ответил, я нашел другой способ, который не требует особых крючков Джексона.
static class JsonWrapper<T> {
@JsonUnwrapped
private T inner;
private String extraField;
public JsonWrapper(T inner, String field) {
this.inner = inner;
this.extraField = field;
}
public T getInner() {
return inner;
}
public String getExtraField() {
return extraField;
}
}
static class BaseClass {
private String baseField;
public BaseClass(String baseField) {
this.baseField = baseField;
}
public String getBaseField() {
return baseField;
}
}
public static void main(String[] args) throws JsonProcessingException {
Object input = new JsonWrapper<>(new BaseClass("inner"), "outer");
System.out.println(new ObjectMapper().writerWithDefaultPrettyPrinter().writeValueAsString(input));
}
Выходы:
{
"baseField" : "inner",
"extraField" : "outer"
}
Для записи коллекций вы можете просто использовать представление:
public static void main(String[] args) throws JsonProcessingException {
List<BaseClass> inputs = Arrays.asList(new BaseClass("1"), new BaseClass("2"));
//Google Guava Library <3
List<JsonWrapper<BaseClass>> modInputs = Lists.transform(inputs, base -> new JsonWrapper<>(base, "hello"));
System.out.println(new ObjectMapper().writerWithDefaultPrettyPrinter().writeValueAsString(modInputs));
}
Вывод:
[ {
"baseField" : "1",
"extraField" : "hello"
}, {
"baseField" : "2",
"extraField" : "hello"
} ]
Ответ 6
Мы можем использовать отражение, чтобы получить все поля объекта, который вы хотите проанализировать.
@JsonSerialize(using=CustomSerializer.class)
class Test{
int id;
String name;
String hash;
}
В пользовательском сериализаторе наш метод сериализации выглядит следующим образом:
@Override
public void serialize(Test value, JsonGenerator jgen,
SerializerProvider provider) throws IOException,
JsonProcessingException {
jgen.writeStartObject();
Field[] fields = value.getClass().getDeclaredFields();
for (Field field : fields) {
try {
jgen.writeObjectField(field.getName(), field.get(value));
} catch (IllegalArgumentException | IllegalAccessException e) {
e.printStackTrace();
}
}
jgen.writeObjectField("extra_field", "whatever_value");
jgen.writeEndObject();
}
Ответ 7
Вдохновленный тем, что wajda сказал и написал в этом gist:
Вот как добавить прослушиватель для сериализации bean в jackson 1.9.12. В этом примере listerner рассматривается как цепочка команд, интерфейс которой:
public interface BeanSerializerListener {
void postSerialization(Object value, JsonGenerator jgen) throws IOException;
}
MyBeanSerializer.java:
public class MyBeanSerializer extends BeanSerializerBase {
private final BeanSerializerListener serializerListener;
protected MyBeanSerializer(final BeanSerializerBase src, final BeanSerializerListener serializerListener) {
super(src);
this.serializerListener = serializerListener;
}
@Override
public void serialize(final Object bean, final JsonGenerator jgen, final SerializerProvider provider) throws IOException, JsonGenerationException {
jgen.writeStartObject();
if (_propertyFilterId != null) {
serializeFieldsFiltered(bean, jgen, provider);
} else {
serializeFields(bean, jgen, provider);
}
serializerListener.postSerialization(bean, jgen);
jgen.writeEndObject();
}
}
MyBeanSerializerBuilder.java:
public class MyBeanSerializerBuilder extends BeanSerializerBuilder {
private final BeanSerializerListener serializerListener;
public MyBeanSerializerBuilder(final BasicBeanDescription beanDesc, final BeanSerializerListener serializerListener) {
super(beanDesc);
this.serializerListener = serializerListener;
}
@Override
public JsonSerializer<?> build() {
BeanSerializerBase src = (BeanSerializerBase) super.build();
return new MyBeanSerializer(src, serializerListener);
}
}
MyBeanSerializerFactory.java:
public class MyBeanSerializerFactory extends BeanSerializerFactory {
private final BeanSerializerListener serializerListener;
public MyBeanSerializerFactory(final BeanSerializerListener serializerListener) {
super(null);
this.serializerListener = serializerListener;
}
@Override
protected BeanSerializerBuilder constructBeanSerializerBuilder(final BasicBeanDescription beanDesc) {
return new MyBeanSerializerBuilder(beanDesc, serializerListener);
}
}
В последнем классе ниже показано, как его можно использовать с помощью Restaasy 3.0.7:
@Provider
public class ObjectMapperProvider implements ContextResolver<ObjectMapper> {
private final MapperConfigurator mapperCfg;
public ObjectMapperProvider() {
mapperCfg = new MapperConfigurator(null, null);
mapperCfg.setAnnotationsToUse(new Annotations[]{Annotations.JACKSON, Annotations.JAXB});
mapperCfg.getConfiguredMapper().setSerializerFactory(serializerFactory);
}
@Override
public ObjectMapper getContext(final Class<?> type) {
return mapperCfg.getConfiguredMapper();
}
}
Ответ 8
Мы можем расширить BeanSerializer, но с небольшим трюком.
Сначала определите класс java для оболочки вашего POJO.
@JsonSerialize(using = MixinResultSerializer.class)
public class MixinResult {
private final Object origin;
private final Map<String, String> mixed = Maps.newHashMap();
@JsonCreator
public MixinResult(@JsonProperty("origin") Object origin) {
this.origin = origin;
}
public void add(String key, String value) {
this.mixed.put(key, value);
}
public Map<String, String> getMixed() {
return mixed;
}
public Object getOrigin() {
return origin;
}
}
Затем выполните свой собственный serializer.
public final class MixinResultSerializer extends BeanSerializer {
public MixinResultSerializer() {
super(SimpleType.construct(MixinResult.class), null, new BeanPropertyWriter[0], new BeanPropertyWriter[0]);
}
public MixinResultSerializer(BeanSerializerBase base) {
super(base);
}
@Override
protected void serializeFields(Object bean, JsonGenerator gen, SerializerProvider provider) throws IOException {
if (bean instanceof MixinResult) {
MixinResult mixin = (MixinResult) bean;
Object origin = mixin.getOrigin();
BeanSerializer serializer = (BeanSerializer) provider.findValueSerializer(SimpleType.construct(origin.getClass()));
new MixinResultSerializer(serializer).serializeFields(origin, gen, provider);
mixin.getMixed().entrySet()
.stream()
.filter(entry -> entry.getValue() != null)
.forEach((entry -> {
try {
gen.writeFieldName(entry.getKey());
gen.writeRawValue(entry.getValue());
} catch (IOException e) {
throw new RuntimeException(e);
}
}));
} else {
super.serializeFields(bean, gen, provider);
}
}
}
Таким образом, мы можем обрабатывать случай, когда объект происхождения с использованием аннотаций jackson настраивается на пользовательское поведение сериализации.
Ответ 9
Мне тоже нужна эта способность; в моем случае, для поддержки расширения поля на сервисах REST. Я закончил разработку крошечной структуры для решения этой проблемы, и она открылась из github. Он также доступен в центральном репозитории maven.
Он заботится обо всех работах. Просто оберните POJO в MorphedResult, а затем добавьте или удалите свойства по своему усмотрению. При сериализации оболочка MorphedResult исчезает, и любые "изменения" появляются в сериализованном объекте JSON.
MorphedResult<?> result = new MorphedResult<>(pojo);
result.addExpansionData("my_extra_field", "some data");
Более подробную информацию и примеры см. на странице github. Обязательно зарегистрируйте фильтр библиотек с помощью утилиты отображения Jackson следующим образом:
ObjectMapper mapper = new ObjectMapper();
mapper.setFilters(new FilteredResultProvider());
