Gestion des valeurs de champ nulles dans la sérialisation Jackson

Jackson, une bibliothèque de sérialisation Java populaire, fournit diverses options de configuration pour adapter son comportement de sérialisation. Un scénario courant consiste à supprimer la sérialisation des valeurs de champ nulles. Cela garantit que seules les propriétés non nulles sont incluses dans la sortie sérialisée.

Configurer Jackson pour la suppression des valeurs nulles

Il existe deux approches principales pour demander à Jackson d'ignorer les valeurs nulles. valeurs des champs pendant la sérialisation.

1. Utilisation de SerializationInclusion :

ObjectMapper mapper = new ObjectMapper();
mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

Cette configuration globale s'applique à tous les champs de toutes les classes traitées par ObjectMapper. Cela garantit que tout champ avec une valeur nulle sera omis de la sortie sérialisée.

2. Utilisation de l'annotation @JsonInclude :

@JsonInclude(Include.NON_NULL)
public class SomeClass {
    private String someValue;
}

L'application de l'annotation @JsonInclude à une classe ou à une méthode getter vous permet de spécifier le comportement de sérialisation pour des propriétés ou des sous-classes spécifiques. En définissant Include.NON_NULL, cela indique que seules les valeurs non nulles de ce champ doivent être sérialisées.

Approches alternatives

Vous pouvez également utiliser l'annotation @JsonInclude dans la méthode getter d'une propriété particulière pour sérialiser la propriété de manière conditionnelle uniquement lorsque sa valeur n'est pas nulle.

@JsonInclude(value = JsonInclude.Include.NON_NULL, condition = JsonInclude.Include.Condition.NON_NULL)
public String getSomeValue() {
    return someValue;
}

Considérations supplémentaires

Notez que ces configurations n'affectent pas le processus de désérialisation. Si une valeur nulle est rencontrée lors de la désérialisation, elle sera toujours définie dans le champ correspondant. Pour contrôler le comportement de la désérialisation, reportez-vous à la documentation Jackson pour @JsonIgnoreProperties et @JsonIgnore.