Jackson

拾 -.-

已于 2022-08-31 09:55:20 修改

阅读量315

点赞数

分类专栏：笔记文章标签： java spring

于 2021-09-25 19:42:09 首次发布

本文链接：https://blog.csdn.net/zk86547462/article/details/120476061

版权

笔记专栏收录该内容

7 篇文章 0 订阅

订阅专栏

Jackson常用注解

属性命名

@JsonProperty注解指定一个属性用于JSON映射，默认情况下映射的JSON属性与注解的属性名称相同，不过可以使用该注解的value值修改JSON属性名，该注解还有一个index属性指定生成JSON属性的顺序，如果有必要的话。属性包含还有一些注解可以管理在映射JSON的时候包含或排除某些属性，下面介绍一下常用的几个。

@JsonIgnore注解用于排除某个属性，这样该属性就不会被Jackson序列化和反序列化。

@JsonIgnoreProperties注解是类注解。在序列化为JSON的时候，@JsonIgnoreProperties({“prop1”,“prop2”})会忽略pro1和pro2两个属性。在从JSON反序列化为Java类的时候，@JsonIgnoreProperties(ignoreUnknown=true)会忽略所有没有Getter和Setter的属性。该注解在Java类和JSON不完全匹配的时候很有用。

@JsonIgnoreType也是类注解，会排除所有指定类型的属性。
序列化相关
@JsonPropertyOrder和@JsonProperty的index属性类似，指定属性序列化时的顺序。

@JsonRootName注解用于指定JSON根属性的名称。

1 常用注解

1、 @JsonProperty 此注解用于属性上，作用是把该属性的名称序列化为另外一个名称，如把testPwd属性序列化为pwd，@JsonProperty(value=“pwd”)。

2、@JsonPropertyOrder
作用在类上，被用来指明当序列化时需要对属性做排序，它有2个属性一个是alphabetic：布尔类型，表示是否采用字母拼音顺序排序，默认是为false，即不排序。如@JsonPropertyOrder(alphabetic=true)。

3、@JsonInclude
是用在实体类的方法类的头上作用是实体类的参数查询到的为null的不显示，比如说你想传一些json数据到前台，但是不想传值为null的数据，就可以使用该标签。如@JsonInclude(JsonInclude.Include.NON_NULL)

4、@JsonIgnoreProperties
可以注明是想要忽略的属性列表如@JsonIgnoreProperties({“name”,“age”,“title”})，也可以注明过滤掉未知的属性如@JsonIgnoreProperties(ignoreUnknown=true),@JsonIgnore表示忽略当前属性。

5、@JsonFormat
用在属性和方法上，可以方便的进行格式转换，如把Date转换为我们要的模式@JsonFormat(pattern = “yyyy-MM-dd HH-mm-ss”)。

6、@JsonUnwrapped
当实体类中成员属性是一个类的对象时候，忽略包装。直接显示属性。

ObjectMapper 使用示例

ObjectMapper mapper = new ObjectMapper(); 
Person person = new Person(); 
person.setName("Tom"); 
person.setAge(40); 
String jsonString = mapper.writerWithDefaultPrettyPrinter() 
.writeValueAsString(person); 
Person deserializedPerson = mapper.readValue(jsonString, Person.class);

Jackson常用配置

// 美化输出
mapper.enable(SerializationFeature.INDENT_OUTPUT);
// 允许序列化空的POJO类
// （否则会抛出异常）
mapper.disable(SerializationFeature.FAIL_ON_EMPTY_BEANS);
// 把java.util.Date, Calendar输出为数字（时间戳）
mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);

// 在遇到未知属性的时候不抛出异常
mapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
// 强制JSON 空字符串("")转换为null对象值:
mapper.enable(DeserializationFeature.ACCEPT_EMPTY_STRING_AS_NULL_OBJECT);

// 在JSON中允许C/C++ 样式的注释(非标准，默认禁用)
mapper.configure(JsonParser.Feature.ALLOW_COMMENTS, true);
// 允许没有引号的字段名（非标准）
mapper.configure(JsonParser.Feature.ALLOW_UNQUOTED_FIELD_NAMES, true);
// 允许单引号（非标准）
mapper.configure(JsonParser.Feature.ALLOW_SINGLE_QUOTES, true);
// 强制转义非ASCII字符
mapper.configure(JsonGenerator.Feature.ESCAPE_NON_ASCII, true);
// 将内容包裹为一个JSON属性，属性名由@JsonRootName注解指定
mapper.configure(SerializationFeature.WRAP_ROOT_VALUE, true);

Spring Boot集成

application.yml

  spring:
    jackson:
      # 设置属性命名策略,对应jackson下PropertyNamingStrategy中的常量值，SNAKE_CASE-返回的json驼峰式转下划线，json body下划线传到后端自动转驼峰式
      property-naming-strategy: SNAKE_CASE
      # 全局设置@JsonFormat的格式pattern
      date-format: yyyy-MM-dd HH:mm:ss
      # 当地时区
      locale: zh
      # 设置全局时区
      time-zone: GMT+8
      # 常用，全局设置pojo或被@JsonInclude注解的属性的序列化方式
      default-property-inclusion: NON_NULL #不为空的属性才会序列化,具体属性可看JsonInclude.Include
   	    #Include.Include.ALWAYS 默认 
		#Include.NON_DEFAULT 属性为默认值不序列化 
		#Include.NON_EMPTY 属性为 空（“”） 或者为 NULL 都不序列化 
		#Include.NON_NULL 属性为NULL 不序列化 
      # 常规默认,枚举类SerializationFeature中的枚举属性为key，值为boolean设置jackson序列化特性,具体key请看SerializationFeature源码
      serialization:
        WRITE_DATES_AS_TIMESTAMPS: true # 返回的java.util.date转换成timestamp
        FAIL_ON_EMPTY_BEANS: true # 对象为空时是否报错，默认true
      # 枚举类DeserializationFeature中的枚举属性为key，值为boolean设置jackson反序列化特性,具体key请看DeserializationFeature源码
      deserialization:
        # 常用,json中含pojo不存在属性时是否失败报错,默认true
        FAIL_ON_UNKNOWN_PROPERTIES: false
      # 枚举类MapperFeature中的枚举属性为key，值为boolean设置jackson ObjectMapper特性
      # ObjectMapper在jackson中负责json的读写、json与pojo的互转、json tree的互转,具体特性请看MapperFeature,常规默认即可
      mapper:
        # 使用getter取代setter探测属性，如类中含getName()但不包含name属性与setName()，传输的vo json格式模板中依旧含name属性
        USE_GETTERS_AS_SETTERS: true #默认false
      # 枚举类JsonParser.Feature枚举类中的枚举属性为key，值为boolean设置jackson JsonParser特性
      # JsonParser在jackson中负责json内容的读取,具体特性请看JsonParser.Feature，一般无需设置默认即可
      parser:
        ALLOW_SINGLE_QUOTES: true # 是否允许出现单引号,默认false
      # 枚举类JsonGenerator.Feature枚举类中的枚举属性为key，值为boolean设置jackson JsonGenerator特性，一般无需设置默认即可
      # JsonGenerator在jackson中负责编写json内容,具体特性请看JsonGenerator.Feature
  swagger:
    enabled: true
    docket:
      base-package: io.github

SpringBoot2.X中spring.jackson.date-format 配置文件中失效的解决办法

实现 WebMvcConfigurer。

package com.iyouya.common.config;


import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.PropertyNamingStrategy;
import com.fasterxml.jackson.databind.module.SimpleModule;
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
import org.springblade.core.tool.utils.DateUtil;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;

import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import java.text.SimpleDateFormat;
import java.util.List;


/**
 * @author zhoukun
 * @email 86547462@qq.com
 * @date 2021/9/25
 */
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    /**
     * 使用此方法, 以下 spring-boot: jackson时间格式化 配置 将会失效
     * spring.jackson.time-zone=GMT+8
     * spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
     * 原因: 会覆盖 @EnableAutoConfiguration 关于 WebMvcAutoConfiguration 的配置
     * */
    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
        ObjectMapper objectMapper = converter.getObjectMapper();
        // 生成JSON时,将所有Long转换成String
        SimpleModule simpleModule = new SimpleModule();
        simpleModule.addSerializer(Long.class, ToStringSerializer.instance);
        simpleModule.addSerializer(Long.TYPE, ToStringSerializer.instance);
        objectMapper.registerModule(simpleModule);
        //空值字段不传输
        objectMapper.setDefaultPropertyInclusion(JsonInclude.Include.NON_NULL);
        //常用请求与响应自动转下划线
        objectMapper.setPropertyNamingStrategy(PropertyNamingStrategy.SNAKE_CASE);
        // 时间格式化
        objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        objectMapper.setDateFormat(new SimpleDateFormat(DateUtil.PATTERN_DATETIME));
        // 设置格式化内容
        converter.setObjectMapper(objectMapper);
        converters.add(0, converter);

    }

}

使用`@JsonSerialize`注解实现保留两位小数，通过此注解我们可以自定义序列化代码

配置类

package org.springblade.common.serializer;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;

import java.io.IOException;
import java.math.BigDecimal;
import java.text.DecimalFormat;

/**
 * @author 可乐
 * @date 2022/8/31 9:42
 * BigDecimal保留两位序列化器
 **/
public class TwoDecimalSerialize extends JsonSerializer<BigDecimal> {

	private final DecimalFormat df = new DecimalFormat("0.00");
	@Override
	public void serialize(BigDecimal value, JsonGenerator gen, SerializerProvider serializers) throws IOException {

		if (value != null) {
			if (value .equals(BigDecimal.ZERO) ) {
				gen.writeString("0");
			} else {
				gen.writeString(df.format(value));
			}
		}
	}
}

然后只需要在返回的对象上添加注解即可

	/**
	 * 重量
	 */
	@JsonSerialize(using = TwoDecimalSerialize.class)
	private BigDecimal weight;