Как использовать пользовательский Serializer с Jackson?

Ответ 1

Как уже упоминалось, @JsonValue - хороший способ. Но если вы не возражаете против пользовательского сериализатора, нет необходимости писать его для элемента, а для пользователя - для него - это было бы так просто:

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

Еще одна возможность - реализовать JsonSerializable, и в этом случае регистрация не требуется.

Что касается ошибки; это странно - вы, вероятно, захотите перейти на более позднюю версию. Но также безопаснее расширять org.codehaus.jackson.map.ser.SerializerBase, поскольку он будет иметь стандартные реализации несущественных методов (т.е. Все, кроме фактического вызова сериализации).

Ответ 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);
    }

}

Ответ 3

Я тоже пробовал это сделать, и в примере кода на веб-странице Джексона есть ошибка, которая не включает тип (.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);

FYI: Вот ссылка на правильный пример кода: http://wiki.fasterxml.com/JacksonFeatureModules

Надеюсь, это поможет!

Ответ 4

Использовать @JsonValue:

public class User {
    int id;
    String name;

    @JsonValue
    public int getId() {
        return id;
    }
}

@JsonValue работает только с методами, поэтому вы должны добавить метод getId. Вы можете вообще пропустить свой собственный сериализатор.

Ответ 5

Это модели поведения, которые я заметил, пытаясь понять сериализацию Джексона.

1) Предположим, что есть объект Classroom и класс Student. Я сделал все публичным и окончательным для простоты.

public class Classroom {
    public final double double1 = 1234.5678;
    public final Double Double1 = 91011.1213;
    public final Student student1 = new Student();
}

public class Student {
    public final double double2 = 1920.2122;
    public final Double Double2 = 2324.2526;
}

2) Предположим, что это сериализаторы, которые мы используем для сериализации объектов в JSON. Свойство writeObjectField использует собственный сериализатор объекта, если он зарегистрирован в объекте mapper; если нет, то он сериализует его как POJO. WriteNumberField только принимает примитивы как аргументы.

public class ClassroomSerializer extends StdSerializer<Classroom> {
    public ClassroomSerializer(Class<Classroom> t) {
        super(t);
    }

    @Override
    public void serialize(Classroom value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonGenerationException {
        jgen.writeStartObject();
        jgen.writeObjectField("double1-Object", value.double1);
        jgen.writeNumberField("double1-Number", value.double1);
        jgen.writeObjectField("Double1-Object", value.Double1);
        jgen.writeNumberField("Double1-Number", value.Double1);
        jgen.writeObjectField("student1", value.student1);
        jgen.writeEndObject();
    }
}

public class StudentSerializer extends StdSerializer<Student> {
    public StudentSerializer(Class<Student> t) {
        super(t);
    }

    @Override
    public void serialize(Student value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonGenerationException {
        jgen.writeStartObject();
        jgen.writeObjectField("double2-Object", value.double2);
        jgen.writeNumberField("double2-Number", value.double2);
        jgen.writeObjectField("Double2-Object", value.Double2);
        jgen.writeNumberField("Double2-Number", value.Double2);
        jgen.writeEndObject();
    }
}

3) Зарегистрируйте только DoubleSerializer с шаблоном вывода DecimalFormat ###,##0.000, в SimpleModule, и вывод:

{
  "double1" : 1234.5678,
  "Double1" : {
    "value" : "91,011.121"
  },
  "student1" : {
    "double2" : 1920.2122,
    "Double2" : {
      "value" : "2,324.253"
    }
  }
}

Вы можете видеть, что сериализация POJO различает двойные и двойные значения, используя DoubleSerialzer for Doubles и используя обычный формат String для удвоений.

4) Зарегистрируйте DoubleSerializer и ClassroomSerializer, без StudentSerializer. Мы ожидаем, что вывод таков, что если мы будем писать double как объект, он будет вести себя как Double, и если мы напишем Double как число, он будет вести себя как double. Переменная экземпляра Student должна быть записана как POJO и следовать шаблону выше, так как он не регистрируется.

{
  "double1-Object" : {
    "value" : "1,234.568"
  },
  "double1-Number" : 1234.5678,
  "Double1-Object" : {
    "value" : "91,011.121"
  },
  "Double1-Number" : 91011.1213,
  "student1" : {
    "double2" : 1920.2122,
    "Double2" : {
      "value" : "2,324.253"
    }
  }
}

5) Зарегистрируйте все сериализаторы. Выход:

{
  "double1-Object" : {
    "value" : "1,234.568"
  },
  "double1-Number" : 1234.5678,
  "Double1-Object" : {
    "value" : "91,011.121"
  },
  "Double1-Number" : 91011.1213,
  "student1" : {
    "double2-Object" : {
      "value" : "1,920.212"
    },
    "double2-Number" : 1920.2122,
    "Double2-Object" : {
      "value" : "2,324.253"
    },
    "Double2-Number" : 2324.2526
  }
}

точно так, как ожидалось.

Еще одно важное замечание. Если у вас есть несколько сериализаторов для одного и того же класса, зарегистрированных в том же модуле, тогда модуль выберет сериализатор для этого класса, который недавно добавлен в список. Это не должно использоваться - это запутывает, и я не уверен, насколько это согласовано.

Мораль: если вы хотите настроить сериализацию примитивов в своем объекте, вы должны написать свой собственный сериализатор для объекта. Вы не можете полагаться на сериализацию POJO Jackson.

Ответ 6

Jackson JSON Views может быть более простым способом достижения ваших требований, особенно если у вас есть определенная гибкость в вашем формате JSON.

Если {"id":7, "itemNr":"TEST", "createdBy":{id:3}} является приемлемым представлением, это будет очень легко достичь с очень маленьким кодом.

Вы просто аннотировали бы поле имени пользователя как часть представления и указывали бы другое представление в своем запросе на сериализацию (по умолчанию аннотированные поля будут включены по умолчанию)

Например: Определите виды:

public class Views {
    public static class BasicView{}
    public static class CompleteUserView{}
}

Аннотировать пользователя:

public class User {
    public final int id;

    @JsonView(Views.CompleteUserView.class)
    public final String name;

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

И сериализация, запрашивающая представление, которое не содержит поля, которое вы хотите скрыть (не аннотированные поля по умолчанию сериализованы):

objectMapper.getSerializationConfig().withView(Views.BasicView.class);

Ответ 7

В моем случае (Spring 3.2.4 и Jackson 2.3.1), конфигурация XML для пользовательского сериализатора:

<mvc:annotation-driven>
    <mvc:message-converters register-defaults="false">
        <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
            <property name="objectMapper">
                <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
                    <property name="serializers">
                        <array>
                            <bean class="com.example.business.serializer.json.CustomObjectSerializer"/>
                        </array>
                    </property>
                </bean>
            </property>
        </bean>
    </mvc:message-converters>
</mvc:annotation-driven>

был необъяснимым образом переписанным по умолчанию чем-то.

Это сработало для меня:

CustomObject.java

@JsonSerialize(using = CustomObjectSerializer.class)
public class CustomObject {

    private Long value;

    public Long getValue() {
        return value;
    }

    public void setValue(Long value) {
        this.value = value;
    }
}

CustomObjectSerializer.java

public class CustomObjectSerializer extends JsonSerializer<CustomObject> {

    @Override
    public void serialize(CustomObject value, JsonGenerator jgen,
        SerializerProvider provider) throws IOException,JsonProcessingException {
        jgen.writeStartObject();
        jgen.writeNumberField("y", value.getValue());
        jgen.writeEndObject();
    }

    @Override
    public Class<CustomObject> handledType() {
        return CustomObject.class;
    }
}

В моем решении не требуется конфигурация XML (<mvc:message-converters>(...)</mvc:message-converters>).

Ответ 8

Я написал пример для пользовательской сериализации/десериализации сериализации Timestamp.class, но вы можете использовать ее для чего угодно.

При создании объекта mapper сделайте что-то вроде этого:

public class JsonUtils {

    public static ObjectMapper objectMapper = null;

    static {
        objectMapper = new ObjectMapper();
        SimpleModule s = new SimpleModule();
        s.addSerializer(Timestamp.class, new TimestampSerializerTypeHandler());
        s.addDeserializer(Timestamp.class, new TimestampDeserializerTypeHandler());
        objectMapper.registerModule(s);
    };
}

например, в java ee вы можете инициализировать его следующим образом:

import java.time.LocalDateTime;

import javax.ws.rs.ext.ContextResolver;
import javax.ws.rs.ext.Provider;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.module.SimpleModule;

@Provider
public class JacksonConfig implements ContextResolver<ObjectMapper> {

    private final ObjectMapper objectMapper;

    public JacksonConfig() {
        objectMapper = new ObjectMapper();
        SimpleModule s = new SimpleModule();
        s.addSerializer(Timestamp.class, new TimestampSerializerTypeHandler());
        s.addDeserializer(Timestamp.class, new TimestampDeserializerTypeHandler());
        objectMapper.registerModule(s);
    };

    @Override
    public ObjectMapper getContext(Class<?> type) {
        return objectMapper;
    }
}

где сериализатор должен выглядеть примерно так:

import java.io.IOException;
import java.sql.Timestamp;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;

public class TimestampSerializerTypeHandler extends JsonSerializer<Timestamp> {

    @Override
    public void serialize(Timestamp value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonProcessingException {
        String stringValue = value.toString();
        if(stringValue != null && !stringValue.isEmpty() && !stringValue.equals("null")) {
            jgen.writeString(stringValue);
        } else {
            jgen.writeNull();
        }
    }

    @Override
    public Class<Timestamp> handledType() {
        return Timestamp.class;
    }
}

и десериализатор примерно так:

import java.io.IOException;
import java.sql.Timestamp;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.SerializerProvider;

public class TimestampDeserializerTypeHandler extends JsonDeserializer<Timestamp> {

    @Override
    public Timestamp deserialize(JsonParser jp, DeserializationContext ds) throws IOException, JsonProcessingException {
        SqlTimestampConverter s = new SqlTimestampConverter();
        String value = jp.getValueAsString();
        if(value != null && !value.isEmpty() && !value.equals("null"))
            return (Timestamp) s.convert(Timestamp.class, value);
        return null;
    }

    @Override
    public Class<Timestamp> handledType() {
        return Timestamp.class;
    }
}

Ответ 9

Вам нужно переопределить метод handledType, и все будет работать

@Override
public Class<Item> handledType()
{
  return Item.class;
}

Ответ 10

Если ваше единственное требование в вашем пользовательском сериализаторе - пропустить сериализацию поля name User, отметьте его как переходный. Джексон не будет сериализовать или десериализовать поля переходные.

[см. также: Почему Java имеет переходные поля?]