Jaskson处理复杂的泛型对象

参考链接:ObjectMapper转化对象常用方法(转LIst、Map,以及Type、JavaType、constructType的学习)

文章目录

开篇

Jackson是一个在Java体系中被广泛使用的Json序列化和反序列化类库,它提供了丰富的API给开发者使用。

java 复制代码
@Data
public class DataInfo<T> {
   
    private Integer type;

    private T data;

    public static void main(String[] args) throws JsonProcessingException {
        ObjectMapper mapper = new ObjectMapper();
        DataInfo<Car> dataInfo = new DataInfo<>();
        dataInfo.setType(1);
        dataInfo.setData(new Car("奔驰01", "奔驰", "黑色"));

        String str1 = mapper.writeValueAsString(dataInfo);
        System.out.println(str1);

        DataInfo dataInfo1 = mapper.readValue(str1, DataInfo.class);
        System.out.println(dataInfo1); // 默认是LinkedHashMap类型

        DataInfo<Car> dataInfo2 = mapper.readValue(str1, new TypeReference<DataInfo<Car>>() {});
        System.out.println(dataInfo2); // 正确的泛型 DataInfo<Car>, 缺点是不能将Car.class作为参数

        JavaType javaType = mapper.getTypeFactory().constructParametricType(DataInfo.class, Car.class);
        DataInfo dataInfo3 = mapper.readValue(str1, javaType);
        System.out.println(dataInfo3); // 正确的泛型 DataInfo<Car>, 能将Car.class作为参数

		JavaType carJavaType = mapper.getTypeFactory().constructType(Car.class);
        JavaType dataInfoCarJavaType = mapper.getTypeFactory().constructParametricType(DataInfo.class, carJavaType);
        DataInfo dataInfo4 = mapper.readValue(str1, dataInfoCarJavaType);
        System.out.println(dataInfo4); // 正确的泛型 DataInfo<Car>, 能将Car.class作为参数
    }

}

今天记录下最近利用Jackson处理复杂的泛型对象的心得,其核心就是利用TypeFactory.constructParametricType()方法,从内到外依此构造Type。

范例1:List<Map<String, Person>>

范例2:Map<String, List<Person>>

范例1:List<Map<String, Person>>

假设我有一个对象List<Map<String, Person>>,我先构造对象然后转为字符串。

java 复制代码
//init
List<Map<String, Person>> result = new ArrayList<>();
Map<String, Person> map = new HashMap<>();
map.put("lcf", new Person("lcf"));

Map<String, Person> map2 = new HashMap<>();
map2.put("hh", new Person("hh"));
result.add(map);
result.add(map2);

//toStr
ObjectMapper mapper = new ObjectMapper();
String str = mapper.writeValueAsString(result);

然后将其反序列化:

java 复制代码
//toObj JsonMappingException,json转化异常
Map map1 = mapper.readValue(s, Map.class);

直接这样转换是会报错的!

需要利用 TypeFactory.constructParametricType()进行JavaType的类型构造:List<Map<String, Person>>

需要注意的是,在构造的时候需要从内到外进行构造:

  1. 先构造Map<String,Person>得到innerType
  2. 再构造List<innerType>

代码如下所示:

java 复制代码
//先构造Map<String,Person>得到innerType,第一个参数为外层对象HashMap,第二个参数为String,第三个参数为Person
JavaType innerType = mapper.getTypeFactory().constructParametricType(HashMap.class, String.class, Person.class);
//再构造List<innerType> 
JavaType resultType = mapper.getTypeFactory().constructParametricType(ArrayList.class, innerType);
//反序列化
List<Map<String, Person>> result2 = mapper.readValue(s, resultType);

范例2:Map<String, List<Person>>

java 复制代码
//构造  Map<String, List<Person>>
//1.先构造右边部分
JavaType rightType = mapper.getTypeFactory().constructParametricType(ArrayList.class, Person.class);
//2. 再构造全局
JavaType javaType = mapper.getTypeFactory().constructParametricType(HashMap.class, String.class, rightType.getRawClass());
Map<String, List<Person>> o = mapper.readValue(str, javaType);

这里有一个小知识点,注意的是参数类型要匹配:constructParametricType 方法有如下2种声明需要注意:

java 复制代码
public JavaType constructParametricType(Class<?> parametrized, Class<?>... parameterClasses) 
public JavaType constructParametricType(Class<?> rawType, JavaType... parameterTypes)

方法中后面的可变形参参数必须一致。

可以查看返利2的 再构造全局,我本来是希望:

java 复制代码
JavaType javaType = mapper.getTypeFactory().constructParametricType(HashMap.class, String.class, rightType);

但是IDE提示参数不匹配,认真一查看确实是:一个是Class,一个是JavaType。

所以通过直接getRawClass解决该问题:

java 复制代码
//构造  Map<String, List<Person>>
JavaType javaType = mapper.getTypeFactory().constructParametricType(HashMap.class, String.class, rightType.getRawClass());

范例3:JsonResponse<Map<String,List<JsonPerson>>>

java 复制代码
// 为什么需要这一层呢?
// 1\. 接口的返回值将会封装为下述结构体,当调用方接受到报文的时候,可以直接优先判断code即返回码,可快速知道这次请求到底是成功还是失败
// 若失败,则直接读取错误信息message,若成功,直接读取data数据。
// 2\. 也是给会报错的代码打个标志,若出错误了,可以快速根据code返回码,判断对应代码是那段出问题,快速定位。
  @Getter
  @ToString
  static class JsonResponse<T> {
      private String code;
      private String message;
      private T data;
  }

  @Getter
  @ToString
  static class JsonPerson {
      private String name;
      private String pwd;
  }

private static void json11(ObjectMapper objectMapper) throws JsonProcessingException {
      String json11 = "{\n" +
              "    \"code\": \"success\",\n" +
              "    \"data\": {\n" +
              "        \"TestData1\": [\n" +
              "            {\n" +
              "                \"name\": \"test-data-name-one\",\n" +
              "                \"pwd\": \"test-data-pwd-one\"\n" +
              "            },\n" +
              "            {\n" +
              "                \"name\": \"test-data-name-two\",\n" +
              "                \"pwd\": \"test-data-pwd-two\"\n" +
              "            }\n" +
              "        ],\n" +
              "        \"TestData2\": [\n" +
              "            {\n" +
              "                \"name\": \"test-data2-name-one\",\n" +
              "                \"pwd\": \"test-data2-pwd-one\"\n" +
              "            },\n" +
              "            {\n" +
              "                \"name\": \"test-data2-name-two\",\n" +
              "                \"pwd\": \"test-data2-pwd-two\"\n" +
              "            }\n" +
              "        ]\n" +
              "    }\n" +
              "}";

      // 获取Type的工厂
      final TypeFactory typeFactory = objectMapper.getTypeFactory();

      // 因为转化的是JsonResponse<Map<String,List<JsonPerson>>> 类型 由里到外,一层层创建对应类型
      // 先创建List<JsonPerson> 类型
      final JavaType listJsonPersonType = typeFactory.constructCollectionType(List.class, JsonPerson.class);

      // 由于 constructMapType方法有如下两种:
      //  1\. constructMapType(Class<? extends Map> mapClass,Class<?> keyClass, Class<?> valueClass)
      //  2\. constructMapType(Class<? extends Map> mapClass, JavaType keyType, JavaType valueType)

      // 对应的key value入参,要不都是class,要不都是JavaType 类型
      // 因此需要把Map中的String先创建 JavaType 类型
      final JavaType stringType = typeFactory.constructType(String.class);

      // 再创建Map<String,List<JsonPerson>> 类型
      final JavaType mapType = typeFactory.constructMapType(Map.class, stringType, listJsonPersonType);

      // 再创建JsonResponse<Map<String,List<JsonPerson>>> 类型
      final JavaType lastType = typeFactory.constructParametricType(JsonResponse.class, mapType);

      // 反序列化
      final JsonResponse<Map<String,List<JsonPerson>>> jsonResponse = objectMapper.readValue(json11, lastType);
      // 得到结果
      System.out.println(jsonResponse);
  }

结语

核心思路:从内到外构造类型,一步一步来!

相关推荐
亚林瓜子3 个月前
Jackson注解屏蔽某些字段读取权限
spring·json·jackson
shyの同学5 个月前
Jackson常用注解详解
java·后端·json·jackson·springboot
Black_Cat_yyds5 个月前
Jackson 库简介--以及数据脱敏
jackson·数据脱敏
10km6 个月前
java:sqlj2ava的静态字段保护
java·json·jackson·fastjson·thrift·sql2java·字段保护
云烟成雨TD8 个月前
Jackson 2.x 系列【31】Spring Boot 集成之字典回写
spring boot·json·jackson
云烟成雨TD8 个月前
Jackson 2.x 系列【30】Spring Boot 集成之数据脱敏
spring boot·json·jackson
云烟成雨TD8 个月前
Jackson 2.x 系列【29】Spring Boot 集成之 Redis 序列化/反序列化
spring boot·redis·jackson
云烟成雨TD8 个月前
Jackson 2.x 系列【25】Spring Boot 集成之起步依赖、自动配置
spring boot·json·jackson
黑风风8 个月前
SpringBoot中使用Jackson序列化返回
jackson·springboot