Jackson 使用说明

Jackson 使用说明

philo-尼可 123 2022-09-27

解析json 数据，处理封装和返回，国内很多开发者喜欢用fastjson，其实这都无所谓，但 Springboot 提供对Jackson的自动配置spring-boot-starter-json，它才是Springboot支持的默认json lib。所以，如果是简单的Springboot项目，推荐用Jackson。

引入依赖

<dependency>  
    <groupId>com.fasterxml.jackson.core</groupId>  
    <artifactId>jackson-databind</artifactId>  
    <version>${jackson-version}</version>  
</dependency>  
<dependency>  
    <groupId>com.fasterxml.jackson.core</groupId>  
    <artifactId>jackson-core</artifactId>  
    <version>${jackson-version}</version>  
</dependency>  
<dependency>  
    <groupId>com.fasterxml.jackson.core</groupId>  
    <artifactId>jackson-annotations</artifactId>  
    <version>${jackson-version}</version>  
</dependency> 
<!-- 其中Jackson Annotations依赖Jackson Core，Jackson Databind依赖Jackson Annotations。-->

基本使用

反序列化

  • 使用ObjectMapper，将json字符串转成对象：
 String str = "{\"id\":1,\"name\":\"haha\",
 \"elements\":[{\"age\":1,\"elName\":\"zll\"},{\"age\":2,\"elName\":\"zll1\"}]}";
 
 ObjectMapper objectMapper = new ObjectMapper();
 TestBean testBean = objectMapper.readValue(str, TestBean.class);
 System.out.println(testBean.toString());
  • 使用ObjectMapper，读取json某些字段值
 String str = "{\"id\":1,\"name\":\"haha\",\"elements\":[{\"age\":1,\"elName\":\"zll\"},{\"age\":2,\"elName\":\"zll1\"}]}";
 ObjectMapper objectMapper = new ObjectMapper();
 JsonNode jsonNode = objectMapper.readTree(str);
 //获取name字段值
 JsonNode name = jsonNode.get("name");
 String s = name.asText();
 System.out.println(s);
 //获取elements字段下数组第二个对象的age
 JsonNode elements = jsonNode.get("elements");
 JsonNode object2 = elements.get(1);//从0开始哦
 JsonNode age = object2.get("age");
 int i = age.asInt();
 System.out.println(i);

序列化

  • ObjectMapper（将JavaObject转化成JSON）
 Element element = new Element();
 element.setAge(1);
 element.setElName("zll");
 ObjectMapper objectMapper = new ObjectMapper();
 String elementStr = objectMapper.writeValueAsString(element);
 System.out.println(elementStr);

其他常用序列化方法：

  • writeValue(File arg0, Object arg1)把arg1转成json序列，并保存到arg0文件中
  • writeValue(OutputStream arg0, Object arg1)把arg1转成json序列，并保存到arg0输出流中
  • writeValueAsBytes(Object arg0)把arg0转成json序列，并把结果输出成字节数组
  • writeValueAsString(Object arg0)把arg0转成json序列，并把结果输出成字符串

ObjectMapper的常用设置

ObjectMapper objectMapper = new ObjectMapper();  
 
//序列化的时候序列对象的所有属性  
objectMapper.setSerializationInclusion(Include.ALWAYS);  
 
//反序列化的时候如果多了其他属性,不抛出异常  
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);  
 
//如果是空对象的时候,不抛异常  
objectMapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);  
 
//属性为null的转换
objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
 
//取消时间的转化格式,默认是时间戳,可以取消,同时需要设置要表现的时间格式  
objectMapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);  
objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));

常用注解

  • 将这个注解加载类上，不存在的字段将被忽略
    @JsonIgnoreProperties(ignoreUnknown = true)
  • 指定忽略字段
    @JsonIgnoreProperties({ “password”, “secretKey” })
  • 标在注解上，将忽略此字段
    @JsonIgnore
  • 标在时间自端上序列化是使用制定规则格式化（默认转化成时间戳）
    @JsonFormat(timezone = “GMT+8”, pattern = “yyyy-MM-dd HH:mm:ss”)
  • JsonInclude.Include.NON_EMPTY：属性为空或者null都不参与序列化JsonInclude.Include.NON_NULL：属性为null不参与序列化
    @JsonInclude(参数)
  • 标在字段上，指定序列化后的字段名
    @JsonProperty("firstName")
  • 自定义某些类型字段的序列化与反序列化规则
    @JsonDeserialize(using= T extends JsonDeserializer.class)和@JsonSerialize(using= T extends     JsonSerializer.class)

# JSON # jacson