Wie kann man Jackson anweisen, ein Feld während der Serialisierung zu ignorieren, wenn sein Wert null ist?

Wie kann Jackson so konfiguriert werden, dass ein Feldwert während der Serialisierung ignoriert wird, wenn der Wert dieses Felds null ist?

Zum Beispiel:

public class SomeClass {
   // what jackson annotation causes jackson to skip over this value if it is null but will 
   // serialize it otherwise 
   private String someValue; 
}

Um Serialisierungseigenschaften mit Nullwerten mit Jackson> 2.0 zu unterdrücken, können Sie die ObjectMapperdirekt konfigurieren oder die @JsonIncludeAnmerkung verwenden:

mapper.setSerializationInclusion(Include.NON_NULL);

oder:

@JsonInclude(Include.NON_NULL)
class Foo
{
  String bar;
}

Alternativ können Sie @JsonIncludein einem Getter verwenden, damit das Attribut angezeigt wird, wenn der Wert nicht null ist.

Ein vollständigeres Beispiel finden Sie in meiner Antwort auf So verhindern Sie, dass Nullwerte in einer Map und Nullfelder in einer Bean über Jackson serialisiert werden .

Verwenden Sie bei Jackson> 1.9.11 und <2.x die @JsonSerializeAnnotation, um dies zu tun:

@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL)

Nur um die anderen Antworten zu erweitern: Wenn Sie das Auslassen von Nullwerten pro Feld steuern müssen, kommentieren Sie das betreffende Feld (oder alternativ den 'Getter' des Felds).

Beispiel - hier fieldOnewird nur von json ausgelassen, wenn es null ist. fieldTwowird immer eingeschlossen, unabhängig davon, ob es null ist.

public class Foo {

    @JsonInclude(JsonInclude.Include.NON_NULL) 
    private String fieldOne;

    private String fieldTwo;
}

Kommentieren Sie die Klasse mit Anmerkungen, um standardmäßig alle Nullwerte in der Klasse wegzulassen. Anmerkungen pro Feld / Getter können weiterhin verwendet werden, um diese Standardeinstellung bei Bedarf zu überschreiben.

Beispiel - hier fieldOneund fieldTwowird von json ausgelassen, wenn sie jeweils null sind, da dies der Standard ist, der durch die Klassenanmerkung festgelegt wird. fieldThreeDer Standardwert wird jedoch überschrieben und aufgrund der Anmerkungen im Feld immer berücksichtigt.

@JsonInclude(JsonInclude.Include.NON_NULL)
public class Foo {

    private String fieldOne;

    private String fieldTwo;

    @JsonInclude(JsonInclude.Include.ALWAYS)
    private String fieldThree;
}

AKTUALISIEREN

Das obige ist für Jackson 2 . Für frühere Versionen von Jackson müssen Sie Folgendes verwenden:

@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL) 

anstatt

@JsonInclude(JsonInclude.Include.NON_NULL)

Wenn dieses Update nützlich ist, stimmen Sie bitte der Antwort von ZiglioUK unten zu. Es wurde auf die neuere Anmerkung zu Jackson 2 hingewiesen, lange bevor ich meine Antwort aktualisiert habe, um sie zu verwenden!

Verwenden Sie in Jackson 2.x:

@JsonInclude(JsonInclude.Include.NON_NULL)

Sie können die folgende Mapper-Konfiguration verwenden:

mapper.getSerializationConfig().setSerializationInclusion(Inclusion.NON_NULL);

Seit 2.5 können Sie Benutzer:

mapper.setSerializationInclusion(Include.NON_NULL);

Sie können einstellen application.properties:

spring.jackson.default-property-inclusion=non_null

oder application.yaml:

spring:
  jackson:
    default-property-inclusion: non_null

http://docs.spring.io/spring-boot/docs/current/reference/html/common-application-properties.html

in meinem Fall

@JsonInclude(Include.NON_EMPTY)

hat es funktioniert.

@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonInclude(JsonInclude.Include.NON_EMPTY)

sollte arbeiten.

Include.NON_EMPTYGibt an, dass die Eigenschaft serialisiert wird, wenn ihr Wert nicht null und nicht leer ist. Include.NON_NULLGibt an, dass die Eigenschaft serialisiert wird, wenn ihr Wert nicht null ist.

Wenn Sie diese Regel allen Modellen in Jackson 2.6+ hinzufügen möchten, verwenden Sie:

mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

In Spring Boot können Sie den Jackson ObjectMapperdirekt über Eigenschaftendateien anpassen .

Beispiel application.yml:

spring:
  jackson:
    default-property-inclusion: non_null # only include props if non-null

Mögliche Werte sind:

always|non_null|non_absent|non_default|non_empty

Weitere Informationen : https://docs.spring.io/spring-boot/docs/current/reference/html/howto-spring-mvc.html#howto-customize-the-jackson-objectmapper

Dies funktioniert in Spring Boot 2.0.3+ und Jackson 2.0+

import com.fasterxml.jackson.annotation.JsonInclude;

@JsonInclude(JsonInclude.Include.NON_NULL)
public class ApiDTO
{
    // your class variable and 
    // methods
}

Für Jackson 2.5 verwenden Sie:

@JsonInclude(content=Include.NON_NULL)

Das hat mich schon seit einiger Zeit beunruhigt und ich habe das Problem endlich gefunden. Das Problem war auf einen falschen Import zurückzuführen. Früher hatte ich benutzt

com.fasterxml.jackson.databind.annotation.JsonSerialize

Welches war veraltet. Ersetzen Sie einfach den Import durch

import org.codehaus.jackson.map.annotate.JsonSerialize;
import org.codehaus.jackson.map.annotate.JsonSerialize.Inclusion;

und benutze es als

@JsonSerialize(include=Inclusion.NON_NULL)

Globale Konfiguration, wenn Sie Spring verwenden

@Configuration
public class JsonConfigurations {

    @Bean
    public Jackson2ObjectMapperBuilder objectMapperBuilder() {
        Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder();
        builder.serializationInclusion(JsonInclude.Include.NON_NULL);
        builder.serializationInclusion(JsonInclude.Include.NON_EMPTY);
        builder.failOnUnknownProperties(false);
        return builder;
    }

}

Wenn Sie versuchen, eine Liste von Objekten zu serialisieren und eines davon null ist, wird das Null-Element sogar mit in den JSON aufgenommen

mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

wird darin enden, dass:

[{myObject},null]

um dies zu bekommen:

[{myObject}]

man kann so etwas machen wie:

mapper.getSerializerProvider().setNullValueSerializer(new JsonSerializer<Object>() {
        @Override
        public void serialize(Object obj, JsonGenerator jsonGen, SerializerProvider unused)
                throws IOException
        {
            //IGNORES NULL VALUES!
        }
    });

TIPP: Wenn Sie DropWizard verwenden, können Sie ObjectMapperdas von Jersey verwendete abrufenenvironment.getObjectMapper()

Wir haben viele Antworten auf diese Frage. Diese Antwort kann in einigen Szenarien hilfreich sein. Wenn Sie die Nullwerte ignorieren möchten, können Sie NOT_NULL auf Klassenebene verwenden. wie nachstehend

@JsonInclude(Include.NON_NULL)
class Foo
{
  String bar;
}

Manchmal müssen Sie möglicherweise die leeren Werte ignorieren, z. B. wenn Sie die ArrayList initialisiert haben, aber diese Liste enthält keine Elemente. In dieser Zeit verwenden Sie die Annotation NOT_EMPTY, um diese leeren Wertefelder zu ignorieren

@JsonInclude(Include.NON_EMPTY)
class Foo
{
  String bar;
}

Jackson 2.x + verwenden

mapper.getSerializationConfig().withSerializationInclusion(JsonInclude.Include.NON_NULL);

Außerdem müssen Sie Ihren Ansatz ändern, wenn Sie Map myVariable verwenden, wie in der Dokumentation beschrieben, um Nullen zu beseitigen:

From documentation:
com.fasterxml.jackson.annotation.JsonInclude

@JacksonAnnotation
@Target(value={ANNOTATION_TYPE, FIELD, METHOD, PARAMETER, TYPE})
@Retention(value=RUNTIME)
Annotation used to indicate when value of the annotated property (when used for a field, method or constructor parameter), or all properties of the annotated class, is to be serialized. Without annotation property values are always included, but by using this annotation one can specify simple exclusion rules to reduce amount of properties to write out.

*Note that the main inclusion criteria (one annotated with value) is checked on Java object level, for the annotated type, and NOT on JSON output -- so even with Include.NON_NULL it is possible that JSON null values are output, if object reference in question is not `null`. An example is java.util.concurrent.atomic.AtomicReference instance constructed to reference null value: such a value would be serialized as JSON null, and not filtered out.

To base inclusion on value of contained value(s), you will typically also need to specify content() annotation; for example, specifying only value as Include.NON_EMPTY for a {link java.util.Map} would exclude Maps with no values, but would include Maps with `null` values. To exclude Map with only `null` value, you would use both annotations like so:
public class Bean {
   @JsonInclude(value=Include.NON_EMPTY, content=Include.NON_NULL)
   public Map<String,String> entries;
}

Similarly you could Maps that only contain "empty" elements, or "non-default" values (see Include.NON_EMPTY and Include.NON_DEFAULT for more details).
In addition to `Map`s, `content` concept is also supported for referential types (like java.util.concurrent.atomic.AtomicReference). Note that `content` is NOT currently (as of Jackson 2.9) supported for arrays or java.util.Collections, but supported may be added in future versions.
Since:
2.0

Fall eins

@JsonInclude(JsonInclude.Include.NON_NULL)
private String someString;

Fall zwei

@JsonInclude(JsonInclude.Include.NON_EMPTY)
private String someString;

Wenn someStringnull ist, wird es in beiden Fällen ignoriert. WennsomeString "" ist, wird es nur in Fall zwei ignoriert.

Das gleiche gilt für List = nulloderList.size() = 0