Jackson处理Optional时遇到问题的解决与分析

更新时间：2022年02月16日 11:49:53 作者：汤圆学Java

Optional是Java实现函数式编程的强劲一步,并且帮助在范式中实现,但是Optional的意义显然不止于此,下面这篇文章主要给大家介绍了关于Jackson处理Optional时遇到问题的解决与分析的相关资料,需要的朋友可以参考下

前言

Optional是Java8中增加的一个特性，它的出现是为了解决Java中的空指针问题，相关介绍可以参考这篇 Java8中的Optional操作；

但是在Jackson中操作Optional类型的属性时，会遇到一些问题，比如序列化的数据不符合预期等；

下面就来介绍下遇到的问题以及如何解决；

正文

1. 序列化Optional类型的问题

其他类型的属性序列化时基本没啥问题，都会根据对象的值进行序列化；

但是Optional比较特殊，序列化时会输出present:true这样的数据；

下面我们看下例子；

这是User对象，其中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);

这里预期的结果应该是类似下面这样的：

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

但实际输出如下所示：

2. 原因分析

之所以序列化会输出{"present":true}这样的字符串，是因为Jackson默认的序列化行为导致；

Jackson默认的序列化会把所有public类型的get方法进行序列化，也就是取出对象中所有可访问的属性，然后填充到结果中；

而这里的Optional对象默认只有一个public类型的get方法，就是isPresent()，这个方法会返回true（当Optional的值不为空）或者false（当Optional的值为空）；

Optional类的局部内容如下所示：

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";
    }
}

可以看到，虽然有一个value属性，但因为是private类型，所以无法直接被Jackson读取；

所以此时Jackson默认只读取了isPresent()方法，取得了true值；

3. 解决办法

幸运的是，Jackson官方已经出了一个maven依赖，专门用来解决由于Java8新增的数据类型导致的各种问题；

添加如下依赖：

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

然后在ObjectMapper对象中配置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);

最后输出符合预期，如下所示：

总结

Jackson在操作Optional类型的属性时，会由于Jackson自身的默认行为，导致输出的结果不符合预期；

解决办法就是加载jackson-datatype-jdk8依赖，然后全局注册Java8模块Jdk8Module；

到此这篇关于Jackson处理Optional时遇到问题的解决与分析的文章就介绍到这了,更多相关Jackson处理Optional内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

java使用RSA工具进行信息加解密
我们在开发中需要对用户敏感数据进行加解密,比如密码等信息,这篇文章主要为大家详细介绍了java如何使用RSA工具进行信息加解密,感兴趣的小伙伴可以了解下
2023-12-12
springboot运行时新增/更新外部接口的实现方法
这篇文章主要介绍了springboot运行时新增/更新外部接口的实现方法,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-03-03
Java两种方式实现动态代理
Java 在 java.lang.reflect 包中有自己的代理支持，该类（Proxy.java）用于动态生成代理类，只需传入目标接口、目标接口的类加载器以及 InvocationHandler 便可为目标接口生成代理类及代理对象。我们称这个Java技术为：动态代理
2020-10-10
Spring Boot统一接口返回及全局异常处理
这篇文章主要介绍了Spring Boot统一接口返回及全局异常处理，文章围绕主题展开相关资料，具有一定的参考价值需要的小伙伴可以参考一下
2022-04-04
SpringBoot如何统一处理返回结果和异常情况
这篇文章主要介绍了SpringBoot如何统一处理返回结果和异常情况问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2024-05-05
springboot2.0 @Slf4j log 彩色日志配置输出到文件
这篇文章主要介绍了springboot2.0 @Slf4j log日志配置输出到文件(彩色日志),解决方式是使用了springboot原生自带的一个log框架，结合实例代码给大家讲解的非常详细，需要的朋友可以参考下
2023-08-08
Java内省之Introspector解读
这篇文章主要介绍了Java内省之Introspector解读，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-11-11
在springboot中使用拦截器的步骤详解
拦截器Interceptor，是SpringMVC中的核心内容，在SpringBoot中使用Interceptor，同时采用全注解开发，这篇文章主要介绍了在springboot中使用拦截器的步骤,需要的朋友可以参考下
2022-01-01
spring声明式事务@Transactional底层工作原理
这篇文章主要为大家介绍分析spring声明式事务@Transactional底层工作原理，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步早日升职加薪
2022-02-02
java使用JOptionPane猜数字游戏
这篇文章主要为大家详细介绍了java使用JOptionPane猜数字游戏，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2020-05-05