Wie verwende ich einen benutzerdefinierten Serializer mit Jackson?

Wie bereits erwähnt, @JsonValue ist ein guter Weg. Aber wenn Sie nichts dagegen haben, eine benutzerdefinierte serializer, es gibt keine Notwendigkeit zu schreiben, eine für die Artikel, sondern eher eine für den Benutzer-wenn so, es würde so einfach sein wie:

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

Noch eine weitere Möglichkeit, ist die Umsetzung JsonSerializablein dem Fall ist keine Anmeldung erforderlich.

Als Fehler; das ist seltsam-Sie wollen wahrscheinlich ein upgrade auf eine neuere version. Aber es ist auch sicherer zu verlängern org.codehaus.jackson.map.ser.SerializerBase wie es standard-Implementierungen von nicht-essentiellen Methoden (d.h. alles, aber die aktuelle Serialisierung nennen).

InformationsquelleAutor der Antwort StaxMan

Ich habe versucht zu tun, zu, und es ist ein Fehler im Beispiel-code auf der Jackson-Webseite, die fehl beinhalten den Typ (.Klasse) im Aufruf addSerializer Methode, die Lesen sollte, wie diese:

simpleModule.addSerializer(Item.class, new ItemSerializer());

In anderen Worten, dies sind die Zeilen, die Sie instanziieren, die simpleModule und fügen Sie den serializer (mit vorheriger falsche Zeile auskommentiert):

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: Hier ist die Referenz für die korrekte Beispiel-code: http://wiki.fasterxml.com/JacksonFeatureModules

Hoffe, das hilft!

InformationsquelleAutor der Antwort pmhargis

Diese sind Verhaltensweisen, die ich bemerkt habe, während Sie versuchen zu verstehen, Jackson Serialisierung.

1) Angenommen, es gibt ein Objekt im Klassenzimmer und eine Klasse Student. Ich habe alles öffentlich und endgültig für die Leichtigkeit.

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) davon Ausgehen, dass diese sind die serialisierungsprogramme wir verwenden für die Serialisierung der Objekte in JSON. Die writeObjectField nutzt das Objekt, die eigene Serialisierung, wenn es registriert ist, mit dem Objekt-mapper; wenn nicht, dann ist es serialisiert als ein POJO. Die writeNumberField ausschließlich nur akzeptiert primitive als Argumente.

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) Registrieren Sie sich nur ein DoubleSerializer mit DecimalFormat Ausgabe Muster ###,##0.000 im SimpleModule und die Ausgabe ist:

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

Können Sie sehen, dass die POJO-Serialisierung unterscheidet zwischen Doppel-und Doppelbettzimmer, mit der DoubleSerialzer für Doppel-und mit einem normalen String-format für Doppelzimmer.

4) Registrieren DoubleSerializer und ClassroomSerializer, ohne die StudentSerializer. Wir erwarten, dass die Ausgabe so ist, dass wenn wir schreiben ein doppeltes, als ein Objekt, es verhält sich wie ein Doppel -, und wenn wir schreiben eine Doppelte als eine Zahl, es verhält sich wie eine doppelte. Der Student-Instanz-variable geschrieben werden soll als POJO und Folgen dem Muster oben, da es nicht registriert.

{
  "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) Registrieren alle serialisierungsprogramme. Die Ausgabe ist:

{
  "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
  }
}

genau wie erwartet.

Ein weiterer wichtiger Hinweis: Wenn Sie mehrere serialisierungsprogramme für die gleiche Klasse mit der gleichen registriert Modul, dann wird das Modul wählen Sie die serializer für die Klasse, die zuletzt in die Liste aufgenommen. Dies sollte nicht verwendet werden - es ist verwirrend und ich bin mir nicht sicher, wie konsequent dies ist

Moral: wenn Sie anpassen möchten die Serialisierung von primitiven in Ihrem Objekt, Sie müssen schreiben Sie Ihre eigenen serializer für das Objekt. Verlassen Sie sich nicht auf die POJO-Jackson-Serialisierung.

InformationsquelleAutor der Antwort laughing_man

In meinem Fall (Frühjahr 3.2.4 und Jackson 2.3.1), XML-Konfiguration für die benutzerdefinierte serializer:

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

war in unerklärliche Weise überschrieben Werkseinstellungen zurück, indem Sie etwas.

Dieser arbeitete für mich:

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

Keine XML-Konfiguration (<mvc:message-converters>(...)</mvc:message-converters>) notwendig ist, meine Lösung.

InformationsquelleAutor der Antwort user11153

Haben Sie zum überschreiben der Methode handledType und alles funktioniert

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

InformationsquelleAutor der Antwort Sergey Kukurudzyak