Spring Boot项目里Jackson的@JsonFormat注解突然不灵了？排查后发现是Gson在‘搞鬼’

张

张建站

2026/4/24 15:51:19

10分钟阅读

Spring Boot项目里Jackson的@JsonFormat注解突然不灵了？排查后发现是Gson在‘搞鬼’

Spring Boot项目中Jackson的JsonFormat注解失效Gson冲突的深度排查指南问题现象当日期格式化突然罢工上周三凌晨两点我被一通紧急电话吵醒。团队里的小王在电话那头焦急地说线上订单系统的创建时间全部变成了时间戳明明上周还正常的我揉了揉眼睛打开IDE检查代码——所有日期字段都规规矩矩地标注着JsonFormat(pattern yyyy-MM-dd HH:mm:ss)但返回给前端的JSON却变成了毫秒数。更诡异的是本地测试环境一切正常只有生产环境出现这个问题。这种看似简单的配置失效背后往往隐藏着Spring Boot生态中JSON库的权力斗争。当你的JsonFormat突然失灵时不要急着怀疑人生——很可能是项目中混入了其他JSON库比如Gson悄悄篡夺了Jackson的序列化权杖。排查思路从症状到根源的侦探游戏1. 基础检查排除低级错误首先进行常规检查就像医生问诊一样// 确认注解使用正确示例 public class OrderDTO { JsonFormat( shape JsonFormat.Shape.STRING, pattern yyyy-MM-dd HH:mm:ss, timezone Asia/Shanghai ) private Date createTime; // getters setters }常见低级错误包括忘记引入jackson-databind依赖虽然Spring Boot starter已经包含注解拼写错误如JsonFormt错误的pattern格式如月份用MM而不是mm时区未指定导致显示时间偏差2. 依赖检查谁在悄悄搞破坏当基础检查无果后就该查看依赖树了。运行以下Maven命令mvn dependency:tree -Dincludescom.fasterxml.jackson,com.google.gson典型输出可能显示[INFO] - com.fasterxml.jackson.core:jackson-databind:jar:2.12.3:compile [INFO] - com.google.code.gson:gson:jar:2.8.6:compile [INFO] \- org.springframework.boot:spring-boot-starter-web:jar:2.5.0:compile危险信号Gson与Jackson共存存在GsonHttpMessageConverter配置引入了Swagger等可能自带Gson的组件3. 配置检查消息转换器的暗战Spring MVC使用HttpMessageConverter处理请求响应转换。关键检查点Configuration public class WebConfig implements WebMvcConfigurer { Override public void configureMessageConverters(ListHttpMessageConverter? converters) { // 这里可能藏着替换Jackson的代码 } }典型问题场景某处配置移除了MappingJackson2HttpMessageConverter添加了GsonHttpMessageConverter且优先级更高自定义了ObjectMapper但配置被覆盖根因定位Gson的政变现场1. 转换器链的真相通过调试模式查看当前生效的HttpMessageConverterGetMapping(/debug/converters) public ListString listConverters() { return request.getServletContext() .getAttribute(WebMvcConfigurer.MESSAGE_CONVERTERS) .toString(); }正常Spring Boot输出应包含[ByteArrayHttpMessageConverter, StringHttpMessageConverter, MappingJackson2HttpMessageConverter, ...]但如果发现GsonHttpMessageConverter出现在MappingJackson2HttpMessageConverter之前问题就找到了。2. 配置冲突的常见来源案例一Swagger配置覆盖Configuration public class SwaggerConfig implements WebMvcConfigurer { Override public void configureMessageConverters(ListHttpMessageConverter? converters) { converters.removeIf(c - c instanceof MappingJackson2HttpMessageConverter); converters.add(new GsonHttpMessageConverter()); // 这就是凶手 } }案例二依赖传递引入Gson某些库会悄悄引入Gson依赖dependency groupIdcom.some.library/groupId artifactIdsome-core/artifactId version1.2.3/version /dependency通过mvn dependency:tree发现后可用exclusions排除exclusions exclusion groupIdcom.google.code.gson/groupId artifactIdgson/artifactId /exclusion /exclusions解决方案恢复Jackson的王座方案1彻底移除Gson推荐如果项目不需要Gson从pom.xml移除Gson依赖删除所有GsonHttpMessageConverter配置确保没有其他配置移除MappingJackson2HttpMessageConverter方案2和平共处策略当必须使用Gson时Configuration public class WebConfig implements WebMvcConfigurer { Bean public MappingJackson2HttpMessageConverter jacksonConverter() { ObjectMapper mapper new ObjectMapper(); mapper.registerModule(new JavaTimeModule()); mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS); return new MappingJackson2HttpMessageConverter(mapper); } Override public void configureMessageConverters(ListHttpMessageConverter? converters) { // 确保Jackson在Gson之前 converters.removeIf(c - c instanceof MappingJackson2HttpMessageConverter); converters.add(0, jacksonConverter()); } }关键点显式创建ObjectMapper并配置日期处理通过converters.add(0, ...)确保Jackson优先级最高保留其他转换器以满足不同需求方案3条件化配置更优雅的方式是使用ConditionalConfiguration ConditionalOnClass(name com.fasterxml.jackson.databind.ObjectMapper) public class JacksonConfig { // Jackson特定配置 } Configuration ConditionalOnClass(name com.google.gson.Gson) public class GsonConfig { // Gson特定配置 }防御性编程避免再次踩坑依赖管理使用dependencyManagement统一版本定期检查依赖树mvn dependency:tree配置检查SpringBootTest public class ConverterTest { Autowired private ListHttpMessageConverter? converters; Test void shouldContainJacksonConverter() { assertTrue(converters.stream() .anyMatch(c - c instanceof MappingJackson2HttpMessageConverter)); } }日志监控logging.level.org.springframework.web.servlet.mvc.method.annotationDEBUG文档记录在项目README中明确JSON库选择记录所有自定义的消息转换器配置深入理解Spring的消息转换机制Spring MVC处理JSON响应的核心流程控制器方法返回对象DispatcherServlet查找匹配的HttpMessageConverter按照canWrite()和getSupportedMediaTypes()筛选按Converter注册顺序选择第一个匹配的调用write()方法生成响应体优先级规则手动添加的转换器优先于自动配置相同类型转换器按添加顺序决定Spring Boot默认注册顺序ByteArrayHttpMessageConverterStringHttpMessageConverterMappingJackson2HttpMessageConverter其他...替代方案当必须使用Gson时如果项目确实需要Gson作为主要JSON库Configuration public class GsonConfig { Bean public Gson gson() { return new GsonBuilder() .setDateFormat(yyyy-MM-dd HH:mm:ss) .create(); } Bean public GsonHttpMessageConverter gsonConverter(Gson gson) { GsonHttpMessageConverter converter new GsonHttpMessageConverter(); converter.setGson(gson); return converter; } Override public void configureMessageConverters(ListHttpMessageConverter? converters) { converters.removeIf(c - c instanceof MappingJackson2HttpMessageConverter); converters.add(gsonConverter(gson())); } }Gson的日期格式化方式// 实体类中不再使用JsonFormat public class Order { private Date createTime; JsonAdapter(DateTypeAdapter.class) public Date getCreateTime() { return createTime; } } public class DateTypeAdapter extends TypeAdapterDate { private final DateFormat format new SimpleDateFormat(yyyy-MM-dd HH:mm:ss); Override public void write(JsonWriter out, Date value) throws IOException { out.value(value ! null ? format.format(value) : null); } Override public Date read(JsonReader in) throws IOException { try { return in.hasNext() ? format.parse(in.nextString()) : null; } catch (ParseException e) { throw new JsonParseException(e); } } }性能考量Jackson vs Gson在决定使用哪个库时可以参考以下对比特性JacksonGson默认日期格式时间戳ISO8601注解支持丰富JsonFormat等有限SerializedName等性能更高稍低配置灵活性高Module系统中等Spring Boot整合默认支持需要显式配置处理复杂对象更稳定可能循环引用问题基准测试建议使用JMH进行序列化/反序列化测试特别注意大对象和深度嵌套场景测试日期处理等特殊场景性能最佳实践总结单一JSON库原则新项目优先使用JacksonSpring Boot默认旧项目迁移时逐步替换避免混用显式配置优于隐式Bean public ObjectMapper objectMapper() { return new ObjectMapper() .registerModule(new JavaTimeModule()) .disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS); }测试覆盖关键场景Test void shouldSerializeDateWithCorrectFormat() { Order order new Order(); order.setCreateTime(new Date()); String json objectMapper.writeValueAsString(order); assertTrue(json.contains(2023-08-01)); // 示例 }监控与告警对API响应进行格式校验设置日期格式异常的监控规则团队规范在项目文档中明确JSON处理规范代码审查时检查消息转换器配置那次生产环境事故最终发现是因为某次紧急热修复时有人添加了一个Swagger配置类里面无意中移除了Jackson转换器。我们花了四小时回滚部署但学到了宝贵的一课在Spring Boot的生态中看似简单的配置变动可能引发连锁反应。现在我们团队所有涉及消息转换器的修改都需要经过双重审查并且在CI流程中添加了Converter的自动化测试。