SpringBoot 时间格式化的 5 种实现方法！

心已赠人 2023-09-27 08:30 83阅读 0赞

![beccbffe55fe9d6070e62a21148b4e53.jpeg][]

作者 | 王磊

来源 | Java中文社群（ID：javacn666）

转载请联系授权（微信ID：GG\_Stone）

在我们日常工作中，时间格式化是一件经常遇到的事儿，所以本文我们就来盘点一下 Spring Boot 中时间格式化的几种方法。

### 时间问题演示 ###

为了方便演示，我写了一个简单 Spring Boot 项目，其中数据库中包含了一张 userinfo 表，它的组成结构和数据信息如下：

![648903f85cd4741326357838ac3989e8.png][]

项目目录是这样的：

![a96ec55cd6ac34a3f757a8a112c9dd3c.png][]

UserController 实现代码如下：

@RestController
    @RequestMapping("/user")
    public class UserController {
        @Resource
        private UserMapper userMapper;
    
        @RequestMapping("/list")
        public List<UserInfo> getList() {
            return userMapper.getList();
        }
    }

UserMapper 实现代码如下：

@Mapper
    public interface UserMapper {
        public List<UserInfo> getList();
    }

UserInfo 实现代码如下：

@Data
    public class UserInfo {
        private int id;
        private String username;
        private Date createtime;
        private Date updatetime;
    }

UserMapper.xml 实现代码如下：

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
    <mapper namespace="com.example.demo.mapper.UserMapper">
        <select id="getList" resultType="com.example.demo.model.UserInfo">
            select * from userinfo
        </select>
    </mapper>

经过以上内容的编写，我们就制作出了一个简单的 Spring Boot 项目了。接下来，我们使用 PostMan 来模拟调用 UserController 接口，执行结果如下：

![11f253c795253cdb47e7d7baf0f9daed.png][]

从上述结果可以看出，时间字段 `createtime` 和 `updatetime` 的显示方式是很“凌乱”的，并不符合我们的阅读习惯，也不能直接展示给前端的用户使用，这时候，我们就需要对时间进行格式化处理了。

时间格式化的方法总共包含以下 5 种。

### 1.前端时间格式化 ###

如果后端在公司中拥有绝对的话语权，或者是后端比较强势的情况下，我们可以将时间格式化的这个“锅”强行甩给前端来处理。

为了让这个“锅”甩的更平顺一些（磊哥不做厨师都可惜了），咱们可以给前端工程师提供切实可行的时间格式化方法，实现代码如下。

#### JS 版时间格式化 ####

方法调用：

let date = new Date();
    dateFormat("YYYY-mm-dd HH:MM:SS", date);
    
    >>> 2021-07-25 21:45:12

### 2.SimpleDateFormat格式化 ###

大多数情况下，我们还是需要自力更生，各扫门前雪的，这个时候我们后端程序员就需要发挥自己的特长了，我们提供的第 1 个时间格式化的方法是使用 `SimpleDateFormat` 来进行时间格式化，它也是 JDK 8 之前重要的时间格式化方法，它的核心实现代码如下：

// 定义时间格式化对象和定义格式化样式
    SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    // 格式化时间对象
    String date = dateFormat.format(new Date())

接下来我们使用 `SimpleDateFormat` 来实现一下本项目中的时间格式化，它的实现代码如下：

@RequestMapping("/list")
    public List<UserInfo> getList() {
        // 定义时间格式化对象
        SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        List<UserInfo> list = userMapper.getList();
        // 循环执行时间格式化
        list.forEach(item -> {
            // 使用预留字段 ctime 接收 createtime 格式化的时间(Date->String)
            item.setCtime(dateFormat.format(item.getCreatetime()));
            item.setUtime(dateFormat.format(item.getUpdatetime()));
        });
        return list;
    }

程序执行结果如下：

![e570f5a7d80bb9f613a4b903d15062ce.png][]

从上述结果可以看出，时间格式化没有任何问题，以及到底我们预想的目的了。但细心的读者会发现，为什么接口的返回字段咋变了呢？（之前的字段是 `createtime` 现在却是 `ctime`...）

这是因为使用 `#SimpleDateFormat.format` 方法之后，它返回的是一个 `String` 类型的结果，而我们之前的 `createtime` 和 `updatetime` 字段都是 `Date` 类型的，因此它们是不能接收时间格式化得结果的。

所以此时我们就需要在实体类 `UserInfo` 新增两个字符串类型的“时间”字段，再将之前 `Data` 类型的时间字段进行隐藏，最终实体类 UserInfo 的实现代码如下：

import com.fasterxml.jackson.annotation.JsonIgnore;
    import lombok.Data;
    
    import java.util.Date;
    
    @Data
    public class UserInfo {
        private int id;
        private String username;
        @JsonIgnore // 输出结果时隐藏此字段
        private Date createtime;
        // 时间格式化后的字段
        private String ctime;
        @JsonIgnore // 输出结果时隐藏此字段
        private Date updatetime;
        // 时间格式化后的字段
        private String utime;
    }

我们可以使用 `@JsonIgnore` 注解将字段进行隐藏，隐藏之后的执行结果如下：

![5ae09ec9a91a62fc177d8a3d15a4acb7.png][]

### 3.DateTimeFormatter格式化 ###

JDK 8 之后，我们可以使用 `DateTimeFormatter` 来替代 `SimpleDateFormat`，因为 `SimpleDateFormat` 是非线程安全的，而 `DateTimeFormatter` 是线程安全的，所以如果是 JDK 8 以上的项目，尽量使用 `DateTimeFormatter` 来进行时间格式化。

`DateTimeFormatter` 格式化的代码和 `SimpleDateFormat` 类似，具体实现如下：

@RequestMapping("/list")
    public List<UserInfo> getList() {
        // 定义时间格式化对象
        DateTimeFormatter dateFormat = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
        List<UserInfo> list = userMapper.getList();
        // 循环执行时间格式化
        list.forEach(item -> {
            // 使用预留字段 ctime 接收 createtime 格式化的时间(Date->String)
            item.setCtime(dateFormat.format(item.getCreatetime()));
            item.setUtime(dateFormat.format(item.getUpdatetime()));
        });
        return list;
    }

执行结果如下所示：

![be0dae0dca203444724127df299bc38b.png][]

`DateTimeFormatter` 和 `SimpleDateFormat` 在使用上的区别是 `DateTimeFormatter` 是用来格式化 JDK 8 提供的时间类型的，如 `LocalDateTime`，而 `SimpleDateFormat` 是用来格式化 `Date` 类型的，所以我们需要对 UserInfoer 实体类做如下的修改：

import com.fasterxml.jackson.annotation.JsonIgnore;
    import lombok.Data;
    
    import java.time.LocalDateTime;
    
    @Data
    public class UserInfo {
        private int id;
        private String username;
        @JsonIgnore
        private LocalDateTime createtime;
        private String ctime;
        @JsonIgnore
        private LocalDateTime updatetime;
        private String utime;
    }

我们可以使用 `LocalDateTime` 来接收 MySQL 中的 `datetime` 类型。

### 4.全局时间格式化 ###

**以上两种后端格式化的实现都有一个致命的缺点，它们在进行时间格式化的时候，都需要对核心业务类做一定的修改**，这就相当为了解决一个问题，又引入了一个新的问题，那有没有简单一点、优雅一点的解决方案呢？

答案是：有的。我们可以不改任何代码，只需要在配置文件中设置一下就可以实现时间格式化的功能了。

首先，我们找到 Spring Boot 的配置文件 application.properties（或 application.yml），只需要在 application.properties 配置文件中添加以下两行配置：

# 格式化全局时间字段
    spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
    # 指定时间区域类型
    spring.jackson.time-zone=GMT+8

这样设置之后，我们将原始的 UserInfo 和 UserController 进行还原。

UserInfo 实现代码如下：

import lombok.Data;
    import java.util.Date;
    
    @Data
    public class UserInfo {
        private int id;
        private String username;
        private Date createtime;
        private Date updatetime;
    }

UserController 实现代码：

@RequestMapping("/list")
    public List<UserInfo> getList() {
        return userMapper.getList();
    }

然后我们运行程序，看到的执行结果如下：

![a342866f6bb2d7600af1bedf5b826540.png][]

从以上结果和代码可以看出，我们只需要在程序中简单配置一下，就可以实现所有时间字段的格式化了。

#### 实现原理分析 ####

为什么在配置文件中设置一下，就可以实现所有时间字段的格式化了呢？

# 格式化全局时间字段
    spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
    # 指定时间区域类型
    spring.jackson.time-zone=GMT+8

这是因为 Controller 在返回数据时，会自动调用 Spring Boot 框架中内置的 JSON 框架 Jackson，对返回的数据进行统一的 JSON 格式化处理，在处理的过程中它会判断配置文件中是否设置了“spring.jackson.date-format=yyyy-MM-dd HH:mm:ss”，如果设置了，那么 Jackson 框架在对时间类型的字段输出时就会执行时间格式化的处理，这样我们就通过配置来实现全局时间字段的格式化功能了。

为什么要指定时间区域类型“spring.jackson.time-zone=GMT+8”呢？

最现实的原因是，如果我们不指定时间区域类型，那么查询出来的时间就会比预期的时间少 8 个小时，这因为我们（中国）所处的时间区域比世界时间少 8 个小时导致的，而当我们设置了时区之后，我们的时间查询才会和预期时间保持一致。

#####  #####

##### GMT 是什么？ #####

时间区域设置中的“GMT” 是什么意思？

Greenwich Mean Time (GMT) **格林尼治时间**，也叫做世界时间。

##### 格林尼治时间 #####

格林尼治是英国伦敦南郊原皇家格林尼治天文台所在地，地球本初子午线的标界处，世界计算时间和经度的起点。以其海事历史、作为本初子午线的标准点、以及格林尼治时间以其命名而闻名于世。这里地势险要，风景秀丽，兼具历史和地方风情，也是伦敦在泰晤士河的东方门户。

不光是天文学家使用格林尼治时间，就是在新闻报刊上也经常出现这个名词。我们知道各地都有各地的地方时间。如果对国际上某一重大事情，用地方时间来记录，就会感到复杂不便．而且将来日子一长容易搞错。因此，天文学家就提出一个大家都能接受且又方便的记录方法，那就是以格林尼治的地方时间为标准。

以本初子午线的平子夜起算的平太阳时。又称格林尼治平时或格林尼治时间。各地的地方平时与世界时之差等于该地的地理经度。1960年以前曾作为基本时间计量系统被广泛应用。由于地球自转速率曾被认为是均匀的,因此在1960年以前,世界时被认为是一种均匀时。由于地球自转速度变化的影响，它不是一种均匀的时间系统，它与原子时或力学时都没有任何理论上的关系,只有通过观测才能对它们进行比较。后来世界时先后被历书时和原子时所取代，但在日常生活、天文导航、大地测量和宇宙飞行等方面仍属必需；同时，世界时反映地球自转速率的变化，是地球自转参数之一，仍为天文学和地球物理学的基本资料。

### 5.部分时间格式化 ###

某些场景下，我们不需要对全局的时间都进行统一的处理，这种情况我们可以使用注解的方式来实现部分时间字段的格式化。

我们需要在实体类 UserInfo 中添加 `@JsonFormat` 注解，这样就可以实现时间的格式化功能了，实现代码如下：

import com.fasterxml.jackson.annotation.JsonFormat;
    import lombok.Data;
    
    import java.util.Date;
    
    @Data
    public class UserInfo {
        private int id;
        private String username;
        // 对 createtime 字段进行格式化处理
        @JsonFormat(pattern = "yyyy-MM-dd hh:mm:ss", timezone = "GMT+8")
        private Date createtime;
        private Date updatetime;
    }

修改完代码之后，我们运行项目执行结果如下：

![4bc32385011060d301d555ec9c9bb5a1.png][]

从上述结果可以看出，使用注解的方式也可以实现时间的格式化。它的实现原理和第 4 种时间格式化的实现原理类似，都是在返回数据之前，对相应的字段进行时间格式化的处理。

### 总结 ###

本文我们介绍了 5 种时间格式化的实现方法，其中第 1 种为前端时间格式化的方法，后 4 种为后端格式化的方法，`SimpleDateFormat` 和 `DateTimeFormatter` 格式化的方法更适用普通的 Java 项目，其中 `SimpleDateFormat` 是非线程安全的，而 `DateTimeFormatter` 是线程安全的，但它们都不是 Spring Boot 项目中最优的时间格式化方案。

**如果是 Spring Boot 的项目，推荐使用第 4 种全局时间格式化或第 5 种局部时间格式化的方式，这两种实现方式都无需修改核心业务代码，只需要简单的配置一下，就可以完成时间的格式化功能了。**

##### 参考 & 鸣谢 #####

www.jianshu.com/p/49fb78bca621

baike.baidu.com/item/世界时/692237

![53fceb14cdb7c7d73269401cfb81fa71.gif][]

往期推荐

![950c8fb88c675319023b9b75ed186795.jpeg][]

绝，Java 中创建对象的 5 种方法！

![c5d72374e2503a76b4101e14db93df95.jpeg][]

SpringBoot 优雅的参数效验！

![3ca277032b456ba77c10d3dfd4038523.jpeg][]

面霸篇：MQ 的 5 大关键问题详解

[beccbffe55fe9d6070e62a21148b4e53.jpeg]: https://img-blog.csdnimg.cn/img_convert/beccbffe55fe9d6070e62a21148b4e53.jpeg
[648903f85cd4741326357838ac3989e8.png]: https://img-blog.csdnimg.cn/img_convert/648903f85cd4741326357838ac3989e8.png
[a96ec55cd6ac34a3f757a8a112c9dd3c.png]: https://img-blog.csdnimg.cn/img_convert/a96ec55cd6ac34a3f757a8a112c9dd3c.png
[11f253c795253cdb47e7d7baf0f9daed.png]: https://img-blog.csdnimg.cn/img_convert/11f253c795253cdb47e7d7baf0f9daed.png
[e570f5a7d80bb9f613a4b903d15062ce.png]: https://img-blog.csdnimg.cn/img_convert/e570f5a7d80bb9f613a4b903d15062ce.png
[5ae09ec9a91a62fc177d8a3d15a4acb7.png]: https://img-blog.csdnimg.cn/img_convert/5ae09ec9a91a62fc177d8a3d15a4acb7.png
[be0dae0dca203444724127df299bc38b.png]: https://img-blog.csdnimg.cn/img_convert/be0dae0dca203444724127df299bc38b.png
[a342866f6bb2d7600af1bedf5b826540.png]: https://img-blog.csdnimg.cn/img_convert/a342866f6bb2d7600af1bedf5b826540.png
[4bc32385011060d301d555ec9c9bb5a1.png]: https://img-blog.csdnimg.cn/img_convert/4bc32385011060d301d555ec9c9bb5a1.png
[53fceb14cdb7c7d73269401cfb81fa71.gif]: https://img-blog.csdnimg.cn/img_convert/53fceb14cdb7c7d73269401cfb81fa71.gif
[950c8fb88c675319023b9b75ed186795.jpeg]: https://img-blog.csdnimg.cn/img_convert/950c8fb88c675319023b9b75ed186795.jpeg
[c5d72374e2503a76b4101e14db93df95.jpeg]: https://img-blog.csdnimg.cn/img_convert/c5d72374e2503a76b4101e14db93df95.jpeg
[3ca277032b456ba77c10d3dfd4038523.jpeg]: https://img-blog.csdnimg.cn/img_convert/3ca277032b456ba77c10d3dfd4038523.jpeg