首页 > 软件编程 > java > SpringBoot Jackson日期的时区和日期格式

SpringBoot中 Jackson 日期的时区和日期格式问题解决

2022-12-10 11:26:12 作者：蜀山雪松

因为最近项目需要国际化，需要能够支持多种国际化语言，目前需要支持三种(法语、英语、简体中文)，这篇文章主要介绍了SpringBoot中 Jackson 日期的时区和日期格式问题,需要的朋友可以参考下

1、使用场景

因为最近项目需要国际化，需要能够支持多种国际化语言，目前需要支持三种(法语、英语、简体中文)。我们的项目部署环境为使用阿里云(德国)节点。以前我们项目主要用户在中国国内。一部署到德国服务器节点就出现一个问题了。数据返回的时间不对，存储的时间也有时差了。此文章仅仅与UTC标准时间与北京时间(东八区时间)作为实际例子。最后跟踪发现，如下几点原因：

1.1、数据库MySQL也是有时区的概念的。

通过如下命令可以查询MySQL的时区

 show variables like "%time_zone%";

如果未做任何修改会显示如下：

+------------------+--------+
| Variable_name  | Value |
+------------------+--------+
| system_time_zone | CST  |
| time_zone    | SYSTEM |
+------------------+--------+
2 rows in set (0.00 sec)
#time_zone说明mysql使用system的时区，system_time_zone说明system使用CST时区

1.2、系统时区意味着与计算机的操作系统时区相同。

以下是我们北京时间使用MySQL时区

 set global time_zone = '+8:00'; ##修改mysql全局时区为北京时间，即我们所在的东8区
> set time_zone = '+8:00'; ##修改当前会话时区
> flush privileges; #立即生效

或者通过修改MySQL的 my.cnf配置文件来修改时区
# vim /etc/my.cnf ##在[mysqld]区域中加上
default-time_zone = '+8:00'
# /etc/init.d/mysqld restart ##重启mysql使新时区生效

1.2、SpringBoot默认的Json视图转换框架Jackson也有时区概念

Jackson日期反序列化时区问题，Jackson里 JsonFormat的源码

/**
 * Value that indicates that default {@link java.util.TimeZone}
 * (from deserialization or serialization context) should be used:
 * annotation does not define value to use.
 *<p>
 * NOTE: default here does NOT mean JVM defaults but Jackson databindings
 * default, usually UTC, but may be changed on <code>ObjectMapper</code>.
 */
public final static String DEFAULT_TIMEZONE = "##default";
 
值，该值指示默认{@链接java.util.TimeZone}
 
（来自反序列化或序列化上下文）应使用：
 
注释未定义要使用的值。
 
注意：这里的默认值并不意味着JVM默认值，而是Jackson数据绑定。
 
默认值，通常为UTC，但可以在<code>objectmapper<code>上更改。

那个注释已经说明默认情况下会将时区设置为UTC ，Jackson反序列化时间类型的底层实际上调用的是Java的 SimpleDateFormat#parse() 方法，而JVM中的时区则会根据你的操作系统来获取，所以JVM认为你的时区应该是 GMT+8 时区，
而要将 UTC 时区的时间转成 GMT+8 时区的时间，就会将你传进来的时间+8个小时。

2、代码实现

2.1、解决方案一下在每个带有日期地方加上注解

日期类型的字段上的 @JsonFormat 加上属性 timezone="GMT+8"

@NotNull
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss",timezone="GMT+8")
@JsonProperty("start_time")
private Date startTime;

此类方法需要在包含日期地方都加上注解属性，比较繁琐。

2.2、只需要配置一个bean实现整体修改

@Bean
    public Jackson2ObjectMapperBuilderCustomizer jacksonObjectMapperCustomization() {
        return jacksonObjectMapperBuilder ->
                jacksonObjectMapperBuilder.timeZone(TimeZone.getTimeZone("GMT+8"));
    }

参考文章：Jackson日期反序列化时区问题

2.3、使用SpringBoot的配置方式

spring.jackson.default-property-inclusion=NON_NULL
spring.jackson.time-zone=GMT+8
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss

第一个设置就是使用24小时的时间格式；第二个设置就是设置时区为东八区。

但是配置时候需要注意

Finally, if you opt out of the Spring Boot default MVC configuration by providing your own @EnableWebMvc configuration, you can take control completely and do everything manually by using getMessageConverters from WebMvcConfigurationSupport.

《Spring Boot Reference Guide》

需要去掉

@EnableWebMvc

参考文章：

SpringBoot升级指定jackson版本的问题

SpringBoot利用jackson格式化时间的三种方法

java如何利用FastJSON、Gson、Jackson三种Json格式工具自定义时间序列化