Springboot2以代码的方式统一配置Jackson

最新推荐文章于 2024-03-26 10:41:11 发布
最新推荐文章于 2024-03-26 10:41:11 发布
阅读量633 收藏 1
点赞数 1
分类专栏： springboot java 文章标签： jackson springboot json
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/daodfs111/article/details/112446605
版权

目录

说明

本文主要配置Jackson对Long、Date、LocalDate、LocalDateTime的序列化和反序列化。

  1. 由于js中整数可精确表示范围小于java Long的范围，故将Long序列化为String，反序列化Jackson会自动处理String转Long，故不需要显式配置。
  2. 由于时间戳在各语言间的兼容性良好，故将Date、LocalDate、LocalDateTime序列化为Long(目前时间戳类的Long类型在js的可精确表示范围内)，将Long反序列化为Date、LocalDate、LocalDateTime。
  3. 将String空字符串反序列化为null。
  4. 本文除了配置Springboot整合的Jackson，还配置了功能一致的Jackson工具类，方便在代码中显示使用Jackson的序列化和反序列化功能。

7个序列化和反序列化规则

package com.xxx.config.serializers;

import java.io.IOException;
import java.util.Date;

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

public class DateSerializer extends JsonSerializer<Date> {

	@Override
	public void serialize(Date value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
		if (value != null) {
			gen.writeNumber(value.getTime());
		}
	}

}

package com.xxx.config.serializers;

import java.io.IOException;
import java.time.LocalDate;
import java.time.ZoneId;

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

public class LocalDateSerializer extends JsonSerializer<LocalDate> {

	@Override
	public void serialize(LocalDate value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
		if (value != null) {
			long millis = value.atStartOfDay(ZoneId.of("+8")).toInstant().toEpochMilli();
			gen.writeNumber(millis);
		}
		
	}

}

package com.xxx.config.serializers;

import java.io.IOException;
import java.time.LocalDateTime;
import java.time.ZoneId;

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

public class LocalDateTimeSerializer extends JsonSerializer<LocalDateTime> {

	@Override
	public void serialize(LocalDateTime value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
		if (value != null) {
			long millis = value.atZone(ZoneId.of("+8")).toInstant().toEpochMilli();
			gen.writeNumber(millis);
		}
	}

}

package com.xxx.config.serializers;

import java.io.IOException;

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;

public class StringDeserializer extends JsonDeserializer<String> {

	@Override
	public String deserialize(JsonParser p, DeserializationContext ctxt)
			throws IOException, JsonProcessingException {
		String text = p.getText();
		if ("".equals(text)) {
			return null;
		}
		return text;
	}

}


package com.xxx.config.serializers;
import java.io.IOException;
import java.util.Date;

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;

public class DateDeserializer extends JsonDeserializer<Date> {

	@Override
	public Date deserialize(JsonParser p, DeserializationContext ctxt)
			throws IOException, JsonProcessingException {
		long timestamp = p.getValueAsLong();
        if (timestamp > 0){
            return new Date(timestamp);
        }else{
            return null;
        }
	}

}

package com.xxx.config.serializers;
import java.io.IOException;
import java.time.Instant;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.ZoneId;

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;

public class LocalDateDeserializer extends JsonDeserializer<LocalDate> {

	@Override
	public LocalDate deserialize(JsonParser p, DeserializationContext ctxt)
			throws IOException, JsonProcessingException {
		long timestamp = p.getValueAsLong();
        if (timestamp > 0){
            return LocalDateTime.ofInstant(Instant.ofEpochMilli(timestamp),ZoneId.of("+8")).toLocalDate();
        }else{
            return null;
        }
	}

}

package com.xxx.config.serializers;
import java.io.IOException;
import java.time.Instant;
import java.time.LocalDateTime;
import java.time.ZoneId;

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;

public class LocalDateTimeDeserializer extends JsonDeserializer<LocalDateTime> {

	@Override
	public LocalDateTime deserialize(JsonParser p, DeserializationContext ctxt)
			throws IOException, JsonProcessingException {
		long timestamp = p.getValueAsLong();
        if (timestamp > 0){
            return LocalDateTime.ofInstant(Instant.ofEpochMilli(timestamp),ZoneId.of("+8"));
        }else{
            return null;
        }
	}

}

Jackson统一配置类

package com.xxx.config;

import java.time.LocalDate;
import java.time.LocalDateTime;
import java.util.Date;

import org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;

import com.xxx.config.serializers.DateDeserializer;
import com.xxx.config.serializers.DateSerializer;
import com.xxx.config.serializers.LocalDateDeserializer;
import com.xxx.config.serializers.LocalDateSerializer;
import com.xxx.config.serializers.LocalDateTimeDeserializer;
import com.xxx.config.serializers.LocalDateTimeSerializer;
import com.xxx.config.serializers.StringDeserializer;
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;

@Configuration
public class JacksonConfig {

	@Bean
	public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilderCustomizer() {
		Jackson2ObjectMapperBuilderCustomizer customizer = new Jackson2ObjectMapperBuilderCustomizer() {
			
			@Override
			public void customize(Jackson2ObjectMapperBuilder jacksonObjectMapperBuilder) {
				jacksonObjectMapperBuilder
						.serializerByType(Long.TYPE, ToStringSerializer.instance)
						.serializerByType(Long.class, ToStringSerializer.instance)
						.serializerByType(Date.class, new DateSerializer())
						.serializerByType(LocalDate.class, new LocalDateSerializer())
						.serializerByType(LocalDateTime.class, new LocalDateTimeSerializer())
						.deserializerByType(String.class, new StringDeserializer())
						.deserializerByType(Date.class, new DateDeserializer())
						.deserializerByType(LocalDate.class, new LocalDateDeserializer())
						.deserializerByType(LocalDateTime.class, new LocalDateTimeDeserializer())
						.failOnEmptyBeans(false)
						.failOnUnknownProperties(false);
			}
		};
		return customizer;
	}
}

Jackson工具类

package com.xxx.util;

import java.io.IOException;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.util.Date;
import java.util.TimeZone;

import com.xxx.config.serializers.StringDeserializer;
import com.xxx.config.serializers.DateDeserializer;
import com.xxx.config.serializers.DateSerializer;
import com.xxx.config.serializers.LocalDateDeserializer;
import com.xxx.config.serializers.LocalDateSerializer;
import com.xxx.config.serializers.LocalDateTimeDeserializer;
import com.xxx.config.serializers.LocalDateTimeSerializer;
import com.fasterxml.jackson.core.JsonParser.Feature;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;

public class JsonUtils {
	 
	private static final ObjectMapper objectMapper;

	static {
		objectMapper = new ObjectMapper();
		// 去掉默认的时间戳格式
		objectMapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
		// 设置为中国北京时区
		objectMapper.setTimeZone(TimeZone.getTimeZone("GMT+8"));
		// 空值不序列化
//		objectMapper.setSerializationInclusion(Include.NON_NULL);//已过时
//		objectMapper.setDefaultPropertyInclusion(Include.NON_NULL);//新API
		// 反序列化时，属性不存在的兼容处理
		objectMapper.getDeserializationConfig().withoutFeatures(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
 
		objectMapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
		objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
		// 单引号处理
		objectMapper.configure(Feature.ALLOW_SINGLE_QUOTES, true);
		
		JavaTimeModule javaTimeModule = new JavaTimeModule();
		javaTimeModule.addSerializer(Long.TYPE, ToStringSerializer.instance);
		javaTimeModule.addSerializer(Long.class, ToStringSerializer.instance);
		javaTimeModule.addSerializer(Date.class, new DateSerializer());
		javaTimeModule.addSerializer(LocalDate.class, new LocalDateSerializer());
        javaTimeModule.addSerializer(LocalDateTime.class, new LocalDateTimeSerializer());
        
        javaTimeModule.addDeserializer(String.class, new StringDeserializer());
        javaTimeModule.addDeserializer(Date.class, new DateDeserializer());
        javaTimeModule.addDeserializer(LocalDate.class, new LocalDateDeserializer());
        javaTimeModule.addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer());
        objectMapper.registerModule(javaTimeModule);
	}
 
	/**
	 * json 转换成 Object
	 *
	 * @param json
	 * @param clazz
	 * @return
	 */
	public static <T> T json2Object(String json, Class<T> clazz) {
		try {
			return objectMapper.readValue(json, clazz);
		} catch (IOException e) {
			throw new RuntimeException("解析json错误");
		}
	}
 
	@SuppressWarnings("unchecked")
	public static <T> T json2Object(String json, TypeReference<T> tr) {
		try {
			return (T)objectMapper.readValue(json, tr);
		} catch (IOException e) {
			throw new RuntimeException("解析json错误", e);
		}
	}
 
	/**
	 * obj 转换成json
	 *
	 * @param entity
	 * @return
	 */
	public static <T> String object2Json(T entity) {
		try {
			return objectMapper.writeValueAsString(entity);
		} catch (IOException e) {
			throw new RuntimeException("转换json错误");
		}
	}
 
	/**
	 * obj对象 转换成树型JSON
	 *
	 * @param obj
	 * @return
	 */
	public static JsonNode object2TreeJson(Object obj) {
		try {
			return objectMapper.valueToTree(obj);
		} catch (Exception e) {
			throw new RuntimeException("转换json错误");
		}
	}
 
	  /**
     * 解码json串成对象
     *
     * @param <T>
     * @param json
     * @param valueType
     * @return T
     */
    @SuppressWarnings("unchecked")
    public static <T> T decode(String json, Class<?> valueType) {
        try {
            return (T) objectMapper.readValue(json, valueType);
        } catch (Exception e) {
            throw new RuntimeException(json, e);
        }
    }

	/**
     * 解码json串成JsonNode
     * @param json
     * @return
     */
    public static JsonNode readTree(String json) {
    	try {
			return objectMapper.readTree(json);
		} catch (Exception e) {
			throw new RuntimeException(json, e);
		}
    }
    
}

结语

有不足之处或错误之处，欢迎指正

daodfs1
关注
专栏目录
[springboot一本通]-2.3.2.JSON格式处理利器Jackson全局配置
字母哥博客
02-15 1034
在Spring框架内使用Jackson的时候，通常需要一些特殊的全局配置，来应对我们JSON序列化与反序列化中出现的各种问题。 Spring Boot 提供了两种配置方式，一是配置文件的方式
Spring Boot进阶(39)：如何让你的日期时间格式在全局生效，解决Jackson序列化时间问题
**My Coding Family**
05-23 1923
SpringBoot之Jackson配置全局时间日期格式，如果你不会，我可以教你。
最新版本 jackson 2.8.2 jar与spring 4.x @ResponseBody配合使用
09-14
具体包括三个jar： jackson-databind-2.8.2.jar jackson-core-2.8.2.jar jackson-annotations-2.8.2.jar
解决jackson版本和springboot版本不兼容的问题
qq_44837912的博客
05-23 1万+
一、错误搭配 错误搭配一： <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.13.RELEASE</version> </dependency> <dependency>
springboot 之 常用jackson配置与使用
enjoy.day
03-10 3158
jackson的应用
java jackson全局设置LocalDateTime的格式
GHY
10-16 5919
在之前jackson设置Date类型的格式时，只需要在springboot的配置文件里面加上以下配置即可： spring: jackson: default-property-inclusion: non_null # 不处理空值 date-format: yyyy-MM-dd HH:mm:ss time-zone: GMT+8 但是最近用到了LocalDateTime，这种全局配置的方式就失效了，当将json字符串反序列化为java对象时，也会出现反序列化的错误，因为Loca
Spring Boot2自动化配置及使用jackson进行json解析
江南雨敲窗的博客
01-09 3715
快速体验 jackson jackson是spring boot 默认的json解析方案，当我们创建maven工程引入 spring-boot-starter-web时 jackson的相关依赖就以及自动引入了，如下， <dependency> <groupId>org.springframework.boot</groupId> <ar...
SpringBoot配置全局日期格式转换器
桐花思雨
10-15 826
在 应用中， 注解的 默认序列化中，日期格式默认为： 类型的显示在实际显示中，我们需要对其转换成我们需要的显示格式配置文件配置 配置方式 这里需要修改时区 ：数据库默认时区是格林尼治的时间，如果不设置，会比实际时间少 个小时（北京时间） 来源于 ，它是一个简单基于 Java 应用库。 注解用于属性或方法上，将 类型转换为我们需要的类型显示
SpringBoot2.x系列教程（十）Json之基础使用详解
程序新视界
12-31 1396
JSON是一种轻量级的数据交换格式，易于阅读、编写、机器解析和生成。JSON采用完全独立于编程语言的文本格式，是一种理想的数据交换语言。在Spring Boot中，对JSON进行了简单而又完善的支持，基本上是开箱即用。本篇文章通过Spring Web中对Json的使用来进行讲解。 Spring Boot对Json的支持 默认情况下Spring Boot支持三种Json类库：Gson、Jackson...
公共服务响应：SpringBoot 统一后端返回格式、处理全局异常
最新发布
iOS逆向与安全
03-26 590
status 状态值：由后端统一定义各种返回结果的状态码message 描述：本次接口调用的结果描述data 数据：本次返回的数据。sign ： 签名信息@Getter@Setter@ApiModelProperty(value = "请求结果状态000000成功 其他是失败")@ApiModelProperty(value = "附加消息")@ApiModelProperty(value = "返回签名")@ApiModelProperty(value = "数据")
springboot2.0使用jackson序列化对象配置
liuyu2783的博客
05-20 3029
1、时间类型自动格式化 spring: profiles: active: dev application: name: workorder jackson: date-format: yyyy-MM-dd HH:mm:ss time-zone: GMT+8 2、过滤掉不想序列化的属性 /** * 创建时间 */ @JsonProper...
springboot之整合jackson
胃小的博客
09-09 1万+
springboot默认配置json转换工具就是jackson, 本文介绍自定义各种配置的方法, 废话不多说 直接上代码 配置文件: #jackson #日期格式化 spring.jackson.date-format=yyyy-MM-dd HH:mm:ss #spring.jackson.date-format=yyyy-MM-dd #格式化输出 spring.jackson.seria...
Spring Mvc使用Jackson进行json转对象时，遇到的字符串转日期的异常处理（Can not deserialize value of type Date from String）
热门推荐
黄雄杰
03-09 6万+
1、问题排查 出现的场景： 服务端通过springmvc写了一个对外的接口，返回一个json字符串，其中该json带有日期，格式为yyyy-MM-dd HH:mm:ss 客户端通过feign调用该http接口，指定返回值为一个Dto，Dto中日期的字段为Date类型 客户端调用该接口后抛异常了。 报错异常如下： feign.co...
spring boot 最佳实践（一）--使用jackson
老螺丝的技术人生
05-17 5万+
目前java json解析工具有阿里的fastjson，google的GSON，以及SpringMVC 默认的解析工具Jackson。建议在spring boot项目中只使用Jackson。
Springboot 编码格式设置为UTF-8
简简单单Onlinezuozuo
05-09 5万+
Springboot 编码格式设置为UTF-8 1.配置文件新增属性 // 文件格式为yml spring: #--------------------------charset-------------------------- http: encoding: charset: UTF-8 enabled: true force: t...
SpringBoot使用Jackson，全局反序列化去除字符串前后空格
u011186019的专栏
04-02 4576
方法一 继承SimpleModule @Component public class StringTrimModule extends SimpleModule { private static final long serialVersionUID = 1L; public StringTrimModule() { addDeserializer(String.class, n...
Springboot2整合Redis以及jackson序列化
zaincs的博客
11-23 2521
pom.xml &lt;!--redis--&gt; &lt;dependency&gt; &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt; &lt;artifactId&gt;spring-boot-starter-data-redis&lt;/artifactId&gt; &lt;/dependency&gt;
第十三节-SpringBoot项目字符编码处理方式
zxb847687944的博客
01-08 233
SpringBoot2整合redis三种序列化方式（Jdk,Jackson,FastJson）
m0_56555119的博客
07-29 851
转载自https//blog.csdn.net/u014212540/article/details/118611381。
SpringBoot中统一响应数据案例详解
- 无需配置大量XML，减少了繁琐的模板代码。 - 强调约定优于配置，使得开发者能够专注于业务逻辑的开发。 2. RESTful Web服务： - REST（Representational State Transfer）是一种网络架构风格，通常用于Web API...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值