6. 二十不惑,ObjectMapper使用也不再迷惑(下)

简介: 6. 二十不惑,ObjectMapper使用也不再迷惑(下)

读(反序列化)


提供readValue()系列方法用于读数据(一般读字符串类型),也就是我们常说的反序列化。


image.png


  • readValue(String content, Class<T> valueType):读为指定class类型的对象,此方法最常用
  • readValue(String content, TypeReference<T> valueTypeRef):T表示泛型类型,如List<T>这种类型,一般用于集合/Map的反序列化
  • readValue(String content, JavaType valueType):Jackson内置的JavaType类型,后再详解(使用并不多)


@Test
public void test4() throws JsonProcessingException {
    ObjectMapper objectMapper = new ObjectMapper();
    System.out.println("----------读简单类型----------");
    System.out.println(objectMapper.readValue("18", Integer.class));
    // 抛错:JsonParseException  单独的一个串,解析会抛错
    // System.out.println(objectMapper.readValue("YourBatman", String.class));
    System.out.println("----------读集合类型----------");
    System.out.println(objectMapper.readValue("[1,2,3]", List.class));
    System.out.println(objectMapper.readValue("{\"zhName\":\"A哥\",\"enName\":\"YourBatman\"}", Map.class));
    System.out.println("----------读POJO----------");
    System.out.println(objectMapper.readValue("{\"name\":\"A哥\",\"age\":18}", Person.class));
}


运行程序,输出:


----------读简单类型----------
18
----------读集合类型----------
[1, 2, 3]
{zhName=A哥, enName=YourBatman}
----------读POJO----------
Person(name=A哥, age=18)


不同于序列化,可以把“所有”写成为一个字符串。反序列化场景有它特殊的地方,比如例子中所示:不能反序列化一个“单纯的”字符串。


泛型擦除问题


从例举出来的三个read读方法中,就应该觉得事情还没完,比如这个带泛型的case:


@Test
public void test5() throws JsonProcessingException {
    ObjectMapper objectMapper = new ObjectMapper();
    System.out.println("----------读集合类型----------");
    List<Long> list = objectMapper.readValue("[1,2,3]", List.class);
    Long id = list.get(0);
    System.out.println(id);
}

运行程序,抛错:


----------读集合类型----------
java.lang.ClassCastException: java.lang.Integer cannot be cast to java.lang.Long
  at cn.yourbatman.jackson.core.ObjectMapperDemo.test5(ObjectMapperDemo.java:100)
  ...


异常栈里指出:Long id = list.get(0);这一句出现了类型转换异常,这便是问题原因所在:泛型擦除,参考图示如下(明明泛型类型是Long,但实际装的是Integer类型):



image.png



对这种问题,你可能会“动脑筋”思考:写成[1L,2L,3L]这样行不行。思想很活跃,奈何现实依旧残酷,运行抛错:


com.fasterxml.jackson.core.JsonParseException: Unexpected character ('L' (code 76)): was expecting comma to separate Array entries
 at [Source: (String)"[1L,2L,3L]"; line: 1, column: 4]
 ...


这是典型的泛型擦除问题。该问题只可能出现在读(反序列化)上,不能出现在写上。那么这种问题怎么破?


在解决此问题之前,我们得先对Java中的泛型擦除有所了解,至少知道如下两点结论:


  1. Java 在编译时会在字节码里指令集之外的地方保留部分泛型信息
  2. 泛型接口、类、方法定义上的所有泛型、成员变量声明处的泛型都会被保留类型信息,其它地方的泛型信息都会被擦除


此问题在开发过程中非常高频,有了此理论作为支撑,A哥提供两种可以解决本问题的方案供以参考:

方案一:利用成员变量保留泛型


理论依据:成员变量的泛型类型不会被擦除


@Test
public void test6() throws JsonProcessingException {
    ObjectMapper objectMapper = new ObjectMapper();
    System.out.println("----------读集合类型----------");
    Data data = objectMapper.readValue("{\"ids\" : [1,2,3]}", Data.class);
    Long id = data.getIds().get(0);
    System.out.println(id);
}
@lombok.Data
private static class Data {
    private List<Long> ids;
}


运行程序,一切正常:

----------读集合类型----------
1


方案二:使用官方推荐的TypeReference<T>


官方早早就为我们考虑好了这类泛型擦除的问题,所以它提供了TypeReference<T>方便我们把泛型类型保留下来,使用起来是非常的方便的:


@Test
public void test7() throws JsonProcessingException {
    ObjectMapper objectMapper = new ObjectMapper();
    System.out.println("----------读集合类型----------");
    List<Long> ids = objectMapper.readValue("[1,2,3]", new TypeReference<List<Long>>() {
    });
    Long id = ids.get(0);
    System.out.println(id);
}


运行程序,一切正常:

----------读集合类型----------
1


本方案的理论依据是:泛型接口/类上的泛型类型不会被擦除。


对于泛型擦除情况,解决思路是hold住泛型类型,这样反序列化的时候才不会抓瞎。但凡只要一抓瞎,Jackson就木有办法只能采用通用/默认类型去装载喽。


加餐


自2.10版本起,给ObjectMapper提供了一个子类:JsonMapper,使得语义更加明确,专门用于处理JSON格式。


严格意义上讲,ObjectMapper不局限于处理JSON格式,比如后面会讲到的它的另外一个子类YAMLMapper用于对Yaml格式的支持(需额外导包,后面见~)


另外,由于构建一个ObjectMapper实例属于高频动作,因此Jackson也顺应潮流的提供了MapperBuilder构建器(2.10版本起)。我们可以通过此构建起很容易的得到一个ObjectMapper(以JsonMapper为例)实例来使用:


@Test
public void test8() throws JsonProcessingException {
    JsonMapper jsonMapper = JsonMapper.builder()
            .configure(JsonReadFeature.ALLOW_SINGLE_QUOTES, true)
            .build();
    Person person = jsonMapper.readValue("{'name':  'YourBatman', 'age': 18}", Person.class);
    System.out.println(person);
}


运行程序,正常输出:

Person(name=YourBatman, age=18)


总结


本文内容很轻松,讲述了ObjectMapper的日常使用,使用它进行读/写,完成日常功能。


对于写来说比较简单,一个writeValueAsString(obj)方法走天下;但对于读来说,除了使用readValue(String content, Class<T> valueType)自动完成数据绑定外,需要特别注意泛型擦除问题:若反序列化成为一个集合类型(Collection or Map),泛型会被擦除,此时你应该使用readValue(String content, TypeReference<T> valueTypeRef)方法代替。


小贴士:若你在工程中遇到objectMapper.readValue(xxx, List.class)这种代码,那肯定是有安全隐患的(但不一定报错)

相关文章
|
监控 druid Java
Spring Boot 3 集成 Druid 连接池详解
在现代的Java应用中,使用一个高效可靠的数据源是至关重要的。Druid连接池作为一款强大的数据库连接池,提供了丰富的监控和管理功能,成为很多Java项目的首选。本文将详细介绍如何在Spring Boot 3项目中配置数据源,集成Druid连接池,以实现更高效的数据库连接管理。
13873 2
Spring Boot 3 集成 Druid 连接池详解
|
SQL 监控 druid
Druid未授权访问 漏洞复现
Druid未授权访问 漏洞复现
22462 1
|
消息中间件 Java Kafka
关于kafka消费者超时配置
关于kafka消费者超时配置
2186 2
|
开发工具 Android开发
AndroidX到底是啥?
AndroidX到底是啥?
866 0
|
消息中间件 架构师 Java
美团面试:对比分析 RocketMQ、Kafka、RabbitMQ 三大MQ常见问题?
美团面试:对比分析 RocketMQ、Kafka、RabbitMQ 三大MQ常见问题?
美团面试:对比分析 RocketMQ、Kafka、RabbitMQ 三大MQ常见问题?
|
人工智能 Java 机器人
基于Spring AI Alibaba + Spring Boot + Ollama搭建本地AI对话机器人API
Spring AI Alibaba集成Ollama,基于Java构建本地大模型应用,支持流式对话、knife4j接口可视化,实现高隐私、免API密钥的离线AI服务。
8004 2
基于Spring AI Alibaba + Spring Boot + Ollama搭建本地AI对话机器人API
|
Java Spring
使用Gradle创建SpringBoot项目
使用Gradle创建SpringBoot项目
1887 0
echarts圆环图设置legend数据对齐百分比样式使用rich富文本标签和formatter函数
echarts圆环图设置legend数据对齐百分比样式使用rich富文本标签和formatter函数
2255 0
|
SQL JavaScript Java
Spring Boot 3 整合 Mybatis-Plus 实现数据权限控制
本文介绍了如何在Spring Boot 3中整合MyBatis-Plus实现数据权限控制,通过使用MyBatis-Plus提供的`DataPermissionInterceptor`插件,在不破坏原有代码结构的基础上实现了细粒度的数据访问控制。文中详细描述了自定义注解`DataScope`的使用方法、`DataPermissionHandler`的具体实现逻辑,以及根据用户的不同角色和部门动态添加SQL片段来限制查询结果。此外,还展示了基于Spring Boot 3和Vue 3构建的前后端分离快速开发框架的实际应用案例,包括项目的核心功能模块如用户管理、角色管理等,并提供Gitee上的开源仓库
3804 11
|
监控 Java Nacos
使用Spring Boot集成Nacos
通过上述步骤,Spring Boot应用可以成功集成Nacos,利用Nacos的服务发现和配置管理功能来提升微服务架构的灵活性和可维护性。通过这种集成,开发者可以更高效地管理和部署微服务。
5456 17