关于springboot项目中及mysql中Date、datetime、timestamp类型的相关说明

2022年6月10日11:28:52

〇、问题背景

自古以来，我们的springboot项目中常有这样的不一致问题：

  1. 数据库的默认字段，create_time、update_time等字段，使用什么数据类型？（datetime，date，还是timestamp）
  2. 数据库的其他业务字段，用来表示时间的，用什么数据类型？（同上的困惑）
  3. 使用了这些类型后，java代码中的DO、BO要用什么数据类型来接（Date，String，Long，还是别的什么？），各层和各个方法之间传递的时候以什么类型传？
  4. 当某些字段需要通过RestController接口返回给前端的时候，ResDTO的字段类型又要如何设计，是 String、Date 还是通过某种注解配合字段来实现？
  5. 后端java方法中，使用什么类型传递呢? Date，String，Long，还是别的什么？
  6. 前后端交互的时候，形式要如何确定，是看起来不知所云的数字时间戳呢，还是让某一方转换一次使用人人期待的“yyyy-MM-dd HH:mm:ss” 呢？

在没有一个统一约定的情况下，这些确实是老大难问题。

现在约定一个统一标准。

一、统一标准约束

注：以下内容都经过验证，非凭空臆想。

  1. myslq表设计中，固定字段 create_time, update_time 字段使用timestamp格式，且update_time 勾选“根据当前时间戳更新”
  2. mysql表中的其他表示时间的字段，日期的则使用 date 格式，日期时间的则使用 datetime格式 （因为业务时间可能需要时间范围为很多年之后的情况，比如卖了一个终身有效的课程，超出了timestamp的范围）。
  3. java代码中的DO、BO以及最终返回给前端的ResDTO ，甚至方法之间的传参，都用 java 的 Date 类型。都可以直接接收，不会报错。
  4. ReqDTO中的参数就用java的 Date 格式，前端直接传 “yyyy-MM-dd” 或 “yyyy-MM-dd HH:mm:ss” 即可识别。

如果这样约定的话，则任何地方，我们都不再需要：

  1. 把难以理解，不能望文生义的数值时间戳传来传去和反复转换
    2.各种DateUtil转换，@Date注解以生成“yyyy-MM-dd HH:mm:ss”类型字符串给前端的过程，都不需要了
  2. mybatis映射时，Date 类型直接就能成功，无需额外关心。

二、 为什么可以，以及怎样做

2.1 通常情况 (jackson)

springboot项目中，如果声明一个@RestController 接口，如果返回 Date格式的话，则前端通过http接收到的格式默认为：Tue May 24 2022 17:49:42。

这一点想必大家深受其扰。

但实际上，这是因为springboot框架中默认使用了jackson 进行序列化。我们只需指定一个全局的jackson序列化格式即可，非常简单

在application.properties配置文件增加以下配置:

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

2.2 有些时候 (如 Gson)

有些时候，有的人并不想用默认的jackson序列化内容，于是就采用了自定义的序列化库。

如Gson等。

办法：在指定自定义的序列化库的时候，顺便指定Date序列化的格式。

三、完美示例

项目很简单试一下就明白了。

https://download.csdn.net/download/festone000/85465322

或仓库地址:
https://gitee.com/festone/springboot-datetime-demo

内容是一样的。

综上，此做法具备一切优点，没有任何不足，值得大力推广。

四、结合现状(我司现状，其他人不必参考)

但由于现状的原因，返回给前端的不是“yyyy-MM-dd HH:mm:ss”格式，而是 毫秒时间戳格式。

故，我们统一全局配置一下格式，使得：

ResDTO中的Date类型，给前端的时候直接就是毫秒时间戳格式。

毫秒时间戳格式的请求参数，后端也可以直接用Date类型接收。

前后端双方都不需要额外的任何显式转换。

示例（springboot版本 2.1.9.RELEASE，与当前我们项目中用的版本一致）:

application.yml文件：

spring:
  jackson:
    # yyyy-MM-dd HH:mm:ss 格式
    #date-format: yyyy-MM-dd HH:mm:ss
    time-zone: GMT+8
    serialization:
      # 毫秒时间戳格式
      write-dates-as-timestamps: true

resDTO 示例:
关于springboot项目中及mysql中Date、datetime、timestamp类型的相关说明
java 类型：

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class XtResponse implements Serializable {
 
    private String name;
 
    private Date date;
}

reqDTO示例：

关于springboot项目中及mysql中Date、datetime、timestamp类型的相关说明
java类型：

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class DateReq implements Serializable {
 
    private String name;
 
    private Date date;
}

综上，完美，具备一切优点，基本上可以说没有任何缺点。

  • 作者：harry2016
  • 原文链接：https://blog.csdn.net/festone000/article/details/124983350
    更新时间：2022年6月10日11:28:52 ，共 2193 字。