Wie überspringe ich optionale.leere Felder während der Jackson-Serialisierung?

Question

Ich habe eine Java-Klasse mit einem optionalen Feld. Ich bin die Klasse zu JSON mit Jackson 2.8.3 (aufgerufen von Spring Web 4.3.3).

Ich hoffe, den Serializer das Feld zu überspringen, wenn das Optional leer ist, und die enthaltene Zeichenfolge serialisieren, wenn es vorhanden ist. Ein Beispiel für das Ergebnis, denn ich bin auf der Suche mit einer Liste von zwei Objekten:

[ 
    { 
     "id": 1, 
     "foo": "bar" 
    }, 
    { 
     "id": 2, 
    } 
] 

Hier die foo Optional ist leer für das Objekt mit der ID 2.

Statt dessen, was ich bekommen ist:

[ 
    { 
     "id": 1, 
     "foo": { 
      "present": true 
     } 
    }, 
    { 
     "id": 2, 
     "foo": { 
      "present": false 
     } 
    } 
] 

Dies ist das Ergebnis, auch wenn ich das „bar“ Feld in der Klasse wie

@JsonInclude(JsonInclude.Include.NON_ABSENT) 
public Optional<String> getFoo() { ... 

jede wa gibt es annotieren y Kann ich ein Ergebnis wie die erste Liste mit den Jackson-Anmerkungen oder einem benutzerdefinierten Serializer erzielen?

Answer 1

Verwenden Sie eine JsonSerializer für Ihre Bedürfnisse.

So etwas wie diese (halb-Pseudo-):

public class MySer extends JsonSerializer<Opional<?>> { 

     @Override 
     public void serialize(Optional<?> optString, JsonGenerator generator, SerializerProvider provider) 
              throws IOException, JsonProcessingException { 
     //Check Optional here...   
     generator.writeString(/* DO SOMETHING HERE WHATEVER */); 
    } 

// Dann in Ihrem Modell:

public class ClassWhatever {   
    @JsonSerialize(using = MySer .class) 
    public Optional<String> getFoo() { ... 
} 

mit @JsonSerialize jedes Feld mit Anmerkungen versehen, um zu vermeiden Sie Ihre benutzerdefinierten Serializer Objekt registrieren können Mapper mit

ObjectMapper mapper = new ObjectMapper(); 
SimpleModule testModule = new SimpleModule("MyModule", new Version(1, 0, 0, null)); 
testModule.addSerializer(new MyCustomSerializer()); // assuming serializer declares correct class to bind to 
mapper.registerModule(testModule); 

Auch angegebene Lösung funktioniert nur für die Serialisierung. Die Deserialisierung schlägt fehl, wenn Sie nicht Ihren eigenen Deserializer schreiben. Dann müssen Sie jedes Feld mit @JsonDeserializ e annotieren oder registrieren Sie Ihren benutzerdefinierten Deserializer.

Answer 2

Keine Notwendigkeit, benutzerdefinierten Serializer zu schreiben. Beschriften Sie Ihre Klasse mit @JsonInclude(JsonInclude.Include.NON_NULL). NON_ABSENT und NON_EMPTY wird auch gut funktionieren.

Sie müssen auch com.fasterxml.jackson.datatype:jackson-datatype-jdk8 als Ihre Abhängigkeit einschließen.