Jackson Serialisierung: leere Werte (oder null) ignorieren

Question

Ich benutze derzeit Jackson 2.1.4 und ich habe Probleme beim Ignorieren von Feldern, wenn ich ein Objekt in eine JSON-Zeichenfolge konvertieren.

Hier ist meine Klasse, die wirkt als das Objekt umgewandelt werden:

public class JsonOperation { 

public static class Request { 
    @JsonInclude(Include.NON_EMPTY) 
    String requestType; 
    Data data = new Data(); 

    public static class Data { 
    @JsonInclude(Include.NON_EMPTY) 
     String username; 
     String email; 
     String password; 
     String birthday; 
     String coinsPackage; 
     String coins; 
     String transactionId; 
     boolean isLoggedIn; 
    } 
} 

public static class Response { 
    @JsonInclude(Include.NON_EMPTY) 
    String requestType = null; 
    Data data = new Data(); 

    public static class Data { 
     @JsonInclude(Include.NON_EMPTY) 
     enum ErrorCode { ERROR_INVALID_LOGIN, ERROR_USERNAME_ALREADY_TAKEN, ERROR_EMAIL_ALREADY_TAKEN }; 
     enum Status { ok, error }; 

     Status status; 
     ErrorCode errorCode; 
     String expiry; 
     int coins; 
     String email; 
     String birthday; 
     String pictureUrl; 
     ArrayList <Performer> performer; 
    } 
} 
} 

Und hier ist, wie ich es konvertieren:

ObjectMapper mapper = new ObjectMapper(); 
mapper.setVisibility(PropertyAccessor.FIELD, Visibility.ANY); 

JsonOperation subscribe = new JsonOperation(); 

subscribe.request.requestType = "login"; 

subscribe.request.data.username = "Vincent"; 
subscribe.request.data.password = "test"; 


Writer strWriter = new StringWriter(); 
try { 
    mapper.writeValue(strWriter, subscribe.request); 
} catch (JsonGenerationException e) { 
    // TODO Auto-generated catch block 
    e.printStackTrace(); 
} catch (JsonMappingException e) { 
    // TODO Auto-generated catch block 
    e.printStackTrace(); 
} catch (IOException e) { 
    // TODO Auto-generated catch block 
    e.printStackTrace(); 
} 

Log.d("JSON", strWriter.toString()) 

Hier ist der Ausgang:

{"data":{"birthday":null,"coins":null,"coinsPackage":null,"email":null,"username":"Vincent","password":"test","transactionId":null,"isLoggedIn":false},"requestType":"login"} 

Wie kann Ich vermeide diese Nullwerte? Ich möchte nur die erforderlichen Informationen für den "Abonnement" Zweck nehmen!

Hier ist genau die Ausgabe, die ich suche:

{"data":{"username":"Vincent","password":"test"},"requestType":"login"} 

Ich habe auch versucht @JsonInclude (Include.NON_NULL) und meine Variablen alle auf null gesetzt, aber es hat nicht funktioniert! Danke für eure Hilfe!

Answer 1

Sie haben die Annotation an der falschen Stelle - sie muss auf der Klasse sein, nicht auf dem Feld. dh:

@JsonInclude(Include.NON_NULL) //or Include.NON_EMPTY, if that fits your use case 
public static class Request { 
    // ... 
} 

Wie in den Kommentaren erwähnt, in der Version 2.x + die Syntax für diese Anmerkung ist:

@JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL) // or JsonSerialize.Inclusion.NON_EMPTY 

Die andere Option ist die ObjectMapper direkt zu konfigurieren, einfach durch mapper.setSerializationInclusion(Include.NON_NULL);

Aufruf

(für die Aufzeichnung, ich denke, die Popularität dieser Antwort ist ein Hinweis darauf, dass diese Anmerkung Feld für Feld anwendbar sein sollte * ahem @faste rxml *)

Answer 2

Sie können auch die globale Option:

objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL); 

Answer 3

Sie können auch versuchen

@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL) 

zu verwenden, wenn Sie mit jackson mit Version handelt unter 2+ (1.9.5) Ich habe es getestet, Sie können diese Annotation einfach oberhalb der Klasse verwenden. Nicht für die Attribute angegeben, nur für die Klassen-Deklaration.

Answer 4

Oder Sie können GSON [], wo diese Nullfelder automatisch entfernt werden.

SampleDTO.java

public class SampleDTO { 

    String username; 
    String email; 
    String password; 
    String birthday; 
    String coinsPackage; 
    String coins; 
    String transactionId; 
    boolean isLoggedIn; 

    // getters/setters 
} 

Test.java

import com.google.gson.Gson; 

public class Test { 

    public static void main(String[] args) { 
     SampleDTO objSampleDTO = new SampleDTO(); 
     Gson objGson = new Gson(); 
     System.out.println(objGson.toJson(objSampleDTO)); 
    } 
} 

OUTPUT:

{"isLoggedIn":false} 

I verwendet Gson-2.2.4

Answer 5

Für jackson 2.x

@JsonInclude (JsonInclude.Include.NON_NULL) kurz vor dem Feld.

Answer 6

Sie müssen import com.fasterxml.jackson.annotation.JsonInclude hinzufügen;

hinzufügen

@JsonInclude(JsonInclude.Include.NON_NULL) 

oben auf POJO

Wenn Sie POJO dann auf alle Werte

@JsonInclude(JsonInclude.Include.NON_NULL) 

Bedarf hinzufügen verschachtelt haben.

HINWEIS: JAXRS (Jersey) behandelt automatisch dieses Szenario 2.6 und höher.

Answer 7

Ich hatte vor kurzem ein ähnliches Problem mit der Version 2.6.6.

@JsonInclude(JsonInclude.Include.NON_NULL) 

Die obige Annotation entweder auf der archivierten oder Klassenebene funktioniert nicht wie erwartet. Das POJO war veränderlich, wo ich die Anmerkung anwendete. Als ich das Verhalten des POJO als unveränderlich änderte, wirkte die Annotation wie magisch.

Ich bin mir nicht sicher, ob seine neue Version oder frühere Versionen dieser Bibliothek ein ähnliches Verhalten hatten, aber für 2.6.6 müssen Sie unbedingt Unveränderlich POJO für die Annotation arbeiten.

objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL); 

Above Option in verschiedenen Antworten erwähnt Serialisierung Aufnahme in ObjectMapper direkt auf globaler Ebene der Einstellung funktioniert auch, aber ich es auf Klasse oder eingereicht Ebene bevorzugen steuern.

Wenn Sie also möchten, dass alle Nullfelder während der JSON-Serialisierung ignoriert werden, verwenden Sie die Annotation auf Klassenebene. Wenn Sie jedoch nur wenige Felder in einer Klasse ignorieren möchten, verwenden Sie sie über diesen spezifischen Feldern. Auf diese Weise ist es besser lesbar & einfach für die Wartung, wenn Sie Verhalten für spezifische Antwort ändern wollten.

Answer 8

es 2 Möglichkeiten erreicht werden kann:

1. Markieren Sie die POJO null/leer Eigenschaften zu ignorieren

   import com.fasterxml.jackson.annotation.JsonInclude 
   
   @JsonInclude(Include.NON_NULL) // or @JsonInclude(Include.NON_EMPTY) 
   

2. konfigurieren ObjectMapper, die als unter den POJO/json serialisiert:

   import com.fasterxml.jackson.annotation.JsonInclude; 
   import com.fasterxml.jackson.databind.ObjectMapper; 
   
   ObjectMapper mapper = new ObjectMapper();    
   mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL); 
   

Answer 9

C ode balgen kann helfen, wenn Sie booleschen Typ von Serialisierung entweder ausschließen möchten:

@JsonInclude(JsonInclude.Include.NON_ABSENT)