Korzystanie Jackson ObjectMapper z Java 8 Wartości opcjonalne

Question

starałem się używać Jackson napisać wartość klasy do formatu JSON, który ma Opcjonalnie jako dziedzinach:

public class Test { 
    Optional<String> field = Optional.of("hello, world!"); 

    public Optional<String> getField() { 
     return field; 
    } 

    public static void main(String[] args) throws JsonProcessingException { 
     ObjectMapper mapper = new ObjectMapper(); 
     System.out.println(mapper.writeValueAsString(new Test())); 
    } 
} 

Po wykonaniu tej klasy generuje następujący wynik:

{"field":{"present":true}} 

Rozumiem, że obecne/nieobecne pole jest zawarte i może obejść go podczas odczytu danych JSON, jednak nie mogę obejść faktu, że rzeczywista zawartość opcjonalna nigdy nie jest zapisywana na wyjściu. :(

żadnego obejścia tutaj wyjątkiem nie używając ObjectMapper

Answer 1

Można użyć jackson-datatype-jdk8 która jest opisana jako:

obsługę nowych typów JDK8 specyficznych, takich jak opcjonalne

Answer 2

w ogóle? Definiować nowe getter która będzie zwracać String zamiast opcjonalne.

public class Test { 
    Optional<String> field = Optional.of("hello, world!"); 

    @JsonIgnore 
    public Optional<String> getField() { 
     return field; 
    } 

    @JsonProperty("field") 
    public String getFieldName() { 
     return field.orElse(null); 
    } 

} 

Answer 3

Klasa Optional ma pole value, ale nie standardowy getter/setter dla niego Domyślnie, Jackson poszukuje podmiotów pobierających/ustawiających, aby znaleźć właściwości klas.

Możesz dodać niestandardowy Mixin, aby zidentyfikować pole jako właściwość

final class OptionalMixin { 
    private Mixin(){} 
    @JsonProperty 
    private Object value; 
} 

i zarejestruj go pod numerem ObjectMapper.

ObjectMapper mapper = new ObjectMapper(); 
mapper.addMixInAnnotations(Optional.class, OptionalMixin.class); 

Można teraz serializować obiekt.

System.out.println(mapper.writeValueAsString(new Test())); 

wypisze

{"field":{"value":"hello, world!","present":true}} 

---

również rozważyć patrząc na jackson-datatype-guava. Istnieje implementacja Jacksona Module dla typów Guava, w tym ich Optional. To może być bardziej kompletne niż to, co pokazałem powyżej.

Answer 4

podobne do @ odpowiedź Manikandan, ale dodać @JsonProperty na polu prywatnym, zamiast getter, więc nie wystawiaj swojej pracy na publiczne api.

Answer 5

Spróbuj przekazać opcje do adnotacji @JsonInclude.
Na przykład, jeśli nie chcesz wyświetlać field, gdy wartość wynosi null. Być może będziesz musiał użyć Jackson-Modules> 2.8.5.

import com.fasterxml.jackson.annotation.JsonInclude; 

public class Test { 
    @JsonInclude(JsonInclude.Include.NON_NULL) 
    Optional<String> field; 
} 

Answer 6

Jeśli używasz najnowszej wersji Wiosna-boot to można to osiągnąć dodając następującą zależność w pliku pom

<dependency> 
    <groupId>com.fasterxml.jackson.datatype</groupId> 
    <artifactId>jackson-datatype-jdk8</artifactId> 
</dependency> 

i auto drutu JacksonObjectMapper.

@Autowired 
private ObjectMapper jacksonObjectMapper; 

Następnie użyj instancji odwzorowujący powyższych Wiosna kontenera konwertować obiekt String

jacksonObjectMapper.writeValueAsString(user); 

Spring blog says :

Niektóre dobrze znane moduły Jackson są automatycznie rejestrowane, jeżeli są one wykryte na ścieżce klasy:

• Jackson typ danych, jdk7: JAVA 7 typów jak java.nio.file.Path (od 4.2.1 uwalnianiu)
• Jackson-JODA typ danych: Typ Joda czasie
• Jackson typ danych, jsr310: JAVA 8 Data typy danych API & Czas
• Jackson-datatype-jdk8: Java 8 typów, takich jak opcjonalne (poczynając od wersji 4.2.0)

Answer 7

wystarczy tylko zarejestrować moduł Jdk8Module. Następnie będzie serializować dowolny Optional<T> jako T, jeśli jest obecny lub w innym przypadku.

ObjectMapper objectMapper = new ObjectMapper(); 
objectMapper.registerModule(new Jdk8Module()); 

Zmodyfikujmy Test klasę nieco więc możemy przetestować dla wartości Optional.empty(). Jest to podobne do oryginalnej klasy Test, gdy jest serializowana, ponieważ obiekt odwzorowujący szuka pozyskiwania (ponieważ pole to jest private). Używanie oryginalnej klasy Test również będzie działać.

class Test { 
    private final String field; 

    public Test(String field) { 
     this.field = field; 
    } 

    public Optional<String> getField() { 
     return Optional.ofNullable(field); 
    } 
} 

Następnie w głównej klasie:

Test testFieldNull = new Test(null); 
Test testFieldNotNull = new Test("foo"); 

// output: {"field":null} 
System.out.println(objectMapper.writeValueAsString(testFieldNull)); 

// output: {"field":"foo"} 
System.out.println(objectMapper.writeValueAsString(testFieldNotNull));