Jackson處理Optional時(shí)遇到問題的解決與分析

更新時(shí)間：2022年02月16日 11:49:53 作者：湯圓學(xué)Java

Optional是Java實(shí)現(xiàn)函數(shù)式編程的強(qiáng)勁一步,并且?guī)椭诜妒街袑?shí)現(xiàn),但是Optional的意義顯然不止于此,下面這篇文章主要給大家介紹了關(guān)于Jackson處理Optional時(shí)遇到問題的解決與分析的相關(guān)資料,需要的朋友可以參考下

前言

Optional是Java8中增加的一個(gè)特性，它的出現(xiàn)是為了解決Java中的空指針問題，相關(guān)介紹可以參考這篇 Java8中的Optional操作；

但是在Jackson中操作Optional類型的屬性時(shí)，會(huì)遇到一些問題，比如序列化的數(shù)據(jù)不符合預(yù)期等；

下面就來介紹下遇到的問題以及如何解決；

正文

1. 序列化Optional類型的問題

其他類型的屬性序列化時(shí)基本沒啥問題，都會(huì)根據(jù)對(duì)象的值進(jìn)行序列化；

但是Optional比較特殊，序列化時(shí)會(huì)輸出present:true這樣的數(shù)據(jù)；

下面我們看下例子；

這是User對(duì)象，其中nickname為Optional類型：

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    public String username;
    public Optional<String> nickname;
}

序列化的代碼如下所示：

User user = new User("jalon", Optional.of("xiaowang"));
ObjectMapper objectMapper = new ObjectMapper();
String str = objectMapper.writeValueAsString(user);
System.out.println(str);

這里預(yù)期的結(jié)果應(yīng)該是類似下面這樣的：

{"username":"jalon","nickname":"xiaowang"}

但實(shí)際輸出如下所示：

2. 原因分析

之所以序列化會(huì)輸出{"present":true}這樣的字符串，是因?yàn)镴ackson默認(rèn)的序列化行為導(dǎo)致；

Jackson默認(rèn)的序列化會(huì)把所有public類型的get方法進(jìn)行序列化，也就是取出對(duì)象中所有可訪問的屬性，然后填充到結(jié)果中；

而這里的Optional對(duì)象默認(rèn)只有一個(gè)public類型的get方法，就是isPresent()，這個(gè)方法會(huì)返回true（當(dāng)Optional的值不為空）或者false（當(dāng)Optional的值為空）；

Optional類的局部?jī)?nèi)容如下所示：

public final class Optional<T> {
    private final T value;
    public T get() {
        if (value == null) {
            throw new NoSuchElementException("No value present");
        }
        return value;
    }

    public boolean isPresent() {
        return value != null;
    }

    @Override
    public String toString() {
        return value != null
            ? String.format("Optional[%s]", value)
            : "Optional.empty";
    }
}

可以看到，雖然有一個(gè)value屬性，但因?yàn)槭莗rivate類型，所以無法直接被Jackson讀取；

所以此時(shí)Jackson默認(rèn)只讀取了isPresent()方法，取得了true值；

3. 解決辦法

幸運(yùn)的是，Jackson官方已經(jīng)出了一個(gè)maven依賴，專門用來解決由于Java8新增的數(shù)據(jù)類型導(dǎo)致的各種問題；

添加如下依賴：

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

然后在ObjectMapper對(duì)象中配置jdk8模塊：objectMapper.registerModule(new Jdk8Module());

User user = new User("jalon", Optional.of("xiaowang"));
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.registerModule(new Jdk8Module());
String str = objectMapper.writeValueAsString(user);
System.out.println(str);

最后輸出符合預(yù)期，如下所示：