Inkludierung von Null-Werten in JSON-Serialisierung mit Jackson und Gson

Die Serialisierung von Java-Objekten in das JSON-Format ist eine häufige Anforderung in der Entwicklung von Anwendungen, insbesondere in der Webentwicklung und bei der Erstellung von APIs. Bei der Arbeit mit JSON kann es vorkommen, dass Java-Objekte Null-Werte enthalten. Die Art und Weise, wie diese Null-Werte behandelt werden, kann je nach den Anforderungen der Anwendung variieren. In diesem Artikel werden wir uns damit befassen, wie man Null-Werte in der JSON-Serialisierung mit den beiden populären Java-Bibliotheken Jackson und Gson behandelt.

Jackson

Jackson ist eine leistungsstarke JSON-Bibliothek für Java, die eine umfangreiche Unterstützung für JSON-Daten bietet. Standardmäßig ignoriert Jackson Null-Werte während der Serialisierung. Das bedeutet, dass Felder mit dem Wert null nicht im generierten JSON erscheinen. Dieses Verhalten kann jedoch geändert werden, wenn Null-Werte explizit inkludiert werden sollen.

Um Null-Werte in der JSON-Serialisierung mit Jackson zu inkludieren, können wir verschiedene Ansätze verwenden. Eine Möglichkeit besteht darin, die JsonInclude.Include.NON_NULL-Annotation auf Klassenebene oder Feldebene zu verwenden. Diese Annotation gibt an, dass Felder mit Null-Werten nicht serialisiert werden sollen. Hier ist ein Beispiel:

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.databind.ObjectMapper;

@JsonInclude(JsonInclude.Include.ALWAYS) // Include null values globally
public class MyClass {
    private String name;
    private Integer age;
    // Getter and Setter methods
}

// Serializing object to JSON
ObjectMapper mapper = new ObjectMapper();
String jsonString = mapper.writeValueAsString(myObject);Code-Sprache: JavaScript (javascript)

In diesem Beispiel wird die JsonInclude.Include.ALWAYS-Annotation verwendet, um anzugeben, dass Null-Werte immer in die JSON-Ausgabe aufgenommen werden sollen. Wenn Sie möchten, dass Null-Werte nur für bestimmte Felder enthalten sind, können Sie die Annotation auf Feldebene anwenden:

public class MyClass {
    @JsonInclude(JsonInclude.Include.ALWAYS)
    private String name;
    private Integer age;
    // Getter and Setter methods
}Code-Sprache: PHP (php)

Mit dieser Konfiguration wird das Feld name immer im JSON enthalten sein, auch wenn es den Wert null hat, während das Feld age ignoriert wird, wenn es null ist.

Eine weitere Möglichkeit besteht darin, benutzerdefinierte Serialisierer zu erstellen, die das gewünschte Verhalten für Null-Werte steuern. Dies kann durch Implementieren der JsonSerializer-Schnittstelle erfolgen und die serialize-Methode entsprechend anzupassen.

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import java.io.IOException;

public class NullSerializer extends JsonSerializer<Object> {
    @Override
    public void serialize(Object value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        if (value == null) {
            gen.writeNull();
        } else {
            gen.writeObject(value);
        }
    }
}Code-Sprache: JavaScript (javascript)

Dann müssen Sie den Serializer für Ihre Klassenfelder konfigurieren:

public class MyClass {
    @JsonSerialize(using = NullSerializer.class)
    private String name;
    // Getter and Setter methods
}Code-Sprache: JavaScript (javascript)

Mit dieser Konfiguration wird der NullSerializer verwendet, um das Feld name zu serialisieren. Wenn das Feld null ist, wird ein null-Wert im JSON erzeugt.

Gson

Gson ist eine Java-Bibliothek, die von Google entwickelt wurde und eine einfache API für die JSON-Verarbeitung bereitstellt. Im Gegensatz zu Jackson serialisiert Gson standardmäßig Null-Werte, dh Felder mit dem Wert null werden im JSON generiert. Dennoch bietet Gson auch Möglichkeiten, das Verhalten der Serialisierung von Null-Werten anzupassen.

Eine Möglichkeit besteht darin, den Gson-Builder zu konfigurieren, um das gewünschte Verhalten für Null-Werte festzulegen. Dies kann durch Verwendung der serializeNulls()-Methode erfolgen:

Gson gson = new GsonBuilder().serializeNulls().create();
String jsonString = gson.toJson(myObject);Code-Sprache: JavaScript (javascript)

Mit serializeNulls() werden Null-Werte explizit in die JSON-Ausgabe aufgenommen. Wenn Sie möchten, dass Null-Werte ignoriert werden, verwenden Sie stattdessen excludeFieldsWithNullValues().

Gson gson = new GsonBuilder().excludeFieldsWithNullValues().create();
String jsonString = gson.toJson(myObject);Code-Sprache: JavaScript (javascript)

Eine andere Möglichkeit besteht darin, benutzerdefinierte Serialisierer zu erstellen, ähnlich wie bei Jackson. Dies kann durch Implementieren der JsonSerializer-Schnittstelle und Anpassen der serialize-Methode erreicht werden.

import com.google.gson.JsonElement;
import com.google.gson.JsonNull;
import com.google.gson.JsonSerializationContext;
import com.google.gson.JsonSerializer;
import java.lang.reflect.Type;

public class NullSerializer implements JsonSerializer<Object> {
    @Override
    public JsonElement serialize(Object src, Type typeOfSrc, JsonSerializationContext context) {
        return src == null ? JsonNull.INSTANCE : context.serialize(src);
    }
}Code-Sprache: JavaScript (javascript)

Dann müssen Sie den Serializer für Ihre Klassenfelder konfigurieren:

Gson gson = new GsonBuilder().registerTypeAdapter(MyClass.class, new NullSerializer()).create();
String jsonString = gson.toJson(myObject);Code-Sprache: JavaScript (javascript)

Mit dieser Konfiguration wird der NullSerializer verwendet, um das Objekt zu serialisieren, wodurch Null-Werte entsprechend behandelt werden.

Insgesamt bieten sowohl Jackson als auch Gson verschiedene Ansätze, um Null-Werte in der JSON-Serialisierung anzupassen. Durch die Verwendung der bereitgestellten Funktionen können Entwickler das gewünschte Verhalten für ihre Anwendung erzielen und eine effektive JSON-Verarbeitung sicherstellen.