Использование Джексона ObjectMapper с Java 8 факультативных значений

Question

Я пытался использовать Джексон, чтобы написать значение класса в формате JSON, который имеет Дополнительно в качестве полей:

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())); 
    } 
} 

При выполнении этого класса генерирует следующий вывод:

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

Я понимаю, что настоящее/не настоящее поле включено и может работать вокруг него при чтении данных JSON, однако я не могу обойти тот факт, что фактическое содержимое необязательного никогда не записывается на выход. :(

Любой обходные здесь кроме не использовать ObjectMapper вообще?

Answer 1

Вы можете использовать jackson-datatype-jdk8, который описан как:

Поддержка новых JDK8 специфических типов, таких как Факультативный

Answer 2

Определить новый поглотитель, который будет возвращать строку вместо необязательного.

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

Optional класса имеет value поля, но не стандартный геттерные/setter для него. По умолчанию Джексон ищет геттеры/сеттеры для поиска свойств класса.

Вы можете добавить пользовательский Mixin, чтобы идентифицировать поле как свойство

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

и зарегистрируйте его с помощью ObjectMapper.

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

Теперь вы можете сериализовать свой объект.

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

напечатает

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

---

Рассматривают также смотрит на jackson-datatype-guava. Существует реализация Jackson Module для типов Guava, включая их Optional. Возможно, это более полно, чем показано выше.

Answer 4

Подобный @ ответ Manikandan, но добавить @JsonProperty к частному поле вместо геттер, чтобы вы не раскрывали свою работу на публичной странице api.

public class Test { 

    @JsonProperty("field") 
    private String field; 

    @JsonIgnore 
    public Optional<String> getField() { 
     return Optional.of(field); // or Optional.ofNullable(field); 
    } 
} 

Answer 5

Попробуйте передать варианты в @JsonInclude аннотация.
Например, если вы не хотите показывать field, когда значение null. Возможно, вам придется использовать Jackson-Modules> 2.8.5.

import com.fasterxml.jackson.annotation.JsonInclude; 

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

Answer 6

Если вы используете последнюю версию Spring-загрузки, то вы могли бы добиться этого, добавив следующую зависимость в файле пом

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

И авто проволоке JacksonObjectMapper.

@Autowired 
private ObjectMapper jacksonObjectMapper; 

Затем используйте экземпляр сопоставителя приведенный выше Spring контейнера для преобразования объекта в строку

jacksonObjectMapper.writeValueAsString(user); 

Spring blog says :

Некоторые хорошо известные модули Джексон автоматически регистрируются, если они обнаружены на пути к классам:

• джексон-тип данных-jdk7: Java 7 типов, как java.nio.file.Path (по 4.2.1) выпуска
• джексон-тип данных-Joda: типы Joda-Time
• джексон-тип данных-jsr310: Java-8 Дата & Время типов данных API
• ДЖЕКСОН-тип_данный-jdk8: другие Ja 8 типов, такие как факультативные (по состоянию на 4.2.0 выпуска)

Answer 7

Вам нужно только зарегистрировать модуль Jdk8Module. Затем он будет сериализовать любые Optional<T> как T, если он присутствует, или null в противном случае.

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

Давайте изменим класс Test немного, чтобы мы могли проверить для Optional.empty() значения. Это похоже на исходный класс Test при сериализации, потому что объект mapper ищет геттер (поскольку поле private). Однако использование оригинального класса Test тоже будет работать.

class Test { 
    private final String field; 

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

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

Тогда в главном классе:

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));