网站免费建站 网页不需要备案,近期国际新闻,小程序开发外包费用,id设计公司作者 | 王磊来源 | Java中文社群#xff08;ID#xff1a;javacn666#xff09;转载请联系授权#xff08;微信ID#xff1a;GG_Stone#xff09;在我们日常工作中#xff0c;时间格式化是一件经常遇到的事儿#xff0c;所以本文我们就来盘点一下 Spring Boot 中时间格… 作者 | 王磊来源 | Java中文社群IDjavacn666转载请联系授权微信IDGG_Stone在我们日常工作中时间格式化是一件经常遇到的事儿所以本文我们就来盘点一下 Spring Boot 中时间格式化的几种方法。时间问题演示为了方便演示我写了一个简单 Spring Boot 项目其中数据库中包含了一张 userinfo 表它的组成结构和数据信息如下项目目录是这样的UserController 实现代码如下RestController
RequestMapping(/user)
public class UserController {Resourceprivate UserMapper userMapper;RequestMapping(/list)public ListUserInfo getList() {return userMapper.getList();}
}
UserMapper 实现代码如下Mapper
public interface UserMapper {public ListUserInfo getList();
}
UserInfo 实现代码如下Data
public class UserInfo {private int id;private String username;private Date createtime;private Date updatetime;
}
UserMapper.xml 实现代码如下?xml version1.0 encodingUTF-8?
!DOCTYPE mapper PUBLIC -//mybatis.org//DTD Mapper 3.0//EN http://mybatis.org/dtd/mybatis-3-mapper.dtd
mapper namespacecom.example.demo.mapper.UserMapperselect idgetList resultTypecom.example.demo.model.UserInfoselect * from userinfo/select
/mapper
经过以上内容的编写我们就制作出了一个简单的 Spring Boot 项目了。接下来我们使用 PostMan 来模拟调用 UserController 接口执行结果如下从上述结果可以看出时间字段 createtime 和 updatetime 的显示方式是很“凌乱”的并不符合我们的阅读习惯也不能直接展示给前端的用户使用这时候我们就需要对时间进行格式化处理了。时间格式化的方法总共包含以下 5 种。1.前端时间格式化如果后端在公司中拥有绝对的话语权或者是后端比较强势的情况下我们可以将时间格式化的这个“锅”强行甩给前端来处理。为了让这个“锅”甩的更平顺一些磊哥不做厨师都可惜了咱们可以给前端工程师提供切实可行的时间格式化方法实现代码如下。JS 版时间格式化function dateFormat(fmt, date) {let ret;const opt {Y: date.getFullYear().toString(), // 年m: (date.getMonth() 1).toString(), // 月d: date.getDate().toString(), // 日H: date.getHours().toString(), // 时M: date.getMinutes().toString(), // 分S: date.getSeconds().toString() // 秒// 有其他格式化字符需求可以继续添加必须转化成字符串};for (let k in opt) {ret new RegExp(( k )).exec(fmt);if (ret) {fmt fmt.replace(ret[1], (ret[1].length 1) ? (opt[k]) : (opt[k].padStart(ret[1].length, 0)))};};return fmt;
}
方法调用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 ListUserInfo getList() {// 定义时间格式化对象SimpleDateFormat dateFormat new SimpleDateFormat(yyyy-MM-dd HH:mm:ss);ListUserInfo list userMapper.getList();// 循环执行时间格式化list.forEach(item - {// 使用预留字段 ctime 接收 createtime 格式化的时间(Date-String)item.setCtime(dateFormat.format(item.getCreatetime()));item.setUtime(dateFormat.format(item.getUpdatetime()));});return list;
}
程序执行结果如下从上述结果可以看出时间格式化没有任何问题以及到底我们预想的目的了。但细心的读者会发现为什么接口的返回字段咋变了呢之前的字段是 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 注解将字段进行隐藏隐藏之后的执行结果如下3.DateTimeFormatter格式化JDK 8 之后我们可以使用 DateTimeFormatter 来替代 SimpleDateFormat因为 SimpleDateFormat 是非线程安全的而 DateTimeFormatter 是线程安全的所以如果是 JDK 8 以上的项目尽量使用 DateTimeFormatter 来进行时间格式化。DateTimeFormatter 格式化的代码和 SimpleDateFormat 类似具体实现如下RequestMapping(/list)
public ListUserInfo getList() {// 定义时间格式化对象DateTimeFormatter dateFormat DateTimeFormatter.ofPattern(yyyy-MM-dd HH:mm:ss);ListUserInfo list userMapper.getList();// 循环执行时间格式化list.forEach(item - {// 使用预留字段 ctime 接收 createtime 格式化的时间(Date-String)item.setCtime(dateFormat.format(item.getCreatetime()));item.setUtime(dateFormat.format(item.getUpdatetime()));});return list;
}
执行结果如下所示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;JsonIgnoreprivate LocalDateTime createtime;private String ctime;JsonIgnoreprivate LocalDateTime updatetime;private String utime;
}
我们可以使用 LocalDateTime 来接收 MySQL 中的 datetime 类型。4.全局时间格式化以上两种后端格式化的实现都有一个致命的缺点它们在进行时间格式化的时候都需要对核心业务类做一定的修改这就相当为了解决一个问题又引入了一个新的问题那有没有简单一点、优雅一点的解决方案呢答案是有的。我们可以不改任何代码只需要在配置文件中设置一下就可以实现时间格式化的功能了。首先我们找到 Spring Boot 的配置文件 application.properties或 application.yml只需要在 application.properties 配置文件中添加以下两行配置# 格式化全局时间字段
spring.jackson.date-formatyyyy-MM-dd HH:mm:ss
# 指定时间区域类型
spring.jackson.time-zoneGMT8
这样设置之后我们将原始的 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 ListUserInfo getList() {return userMapper.getList();
}
然后我们运行程序看到的执行结果如下从以上结果和代码可以看出我们只需要在程序中简单配置一下就可以实现所有时间字段的格式化了。实现原理分析为什么在配置文件中设置一下就可以实现所有时间字段的格式化了呢# 格式化全局时间字段
spring.jackson.date-formatyyyy-MM-dd HH:mm:ss
# 指定时间区域类型
spring.jackson.time-zoneGMT8
这是因为 Controller 在返回数据时会自动调用 Spring Boot 框架中内置的 JSON 框架 Jackson对返回的数据进行统一的 JSON 格式化处理在处理的过程中它会判断配置文件中是否设置了“spring.jackson.date-formatyyyy-MM-dd HH:mm:ss”如果设置了那么 Jackson 框架在对时间类型的字段输出时就会执行时间格式化的处理这样我们就通过配置来实现全局时间字段的格式化功能了。为什么要指定时间区域类型“spring.jackson.time-zoneGMT8”呢最现实的原因是如果我们不指定时间区域类型那么查询出来的时间就会比预期的时间少 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 GMT8)private Date createtime;private Date updatetime;
}
修改完代码之后我们运行项目执行结果如下从上述结果可以看出使用注解的方式也可以实现时间的格式化。它的实现原理和第 4 种时间格式化的实现原理类似都是在返回数据之前对相应的字段进行时间格式化的处理。总结本文我们介绍了 5 种时间格式化的实现方法其中第 1 种为前端时间格式化的方法后 4 种为后端格式化的方法SimpleDateFormat 和 DateTimeFormatter 格式化的方法更适用普通的 Java 项目其中 SimpleDateFormat 是非线程安全的而 DateTimeFormatter 是线程安全的但它们都不是 Spring Boot 项目中最优的时间格式化方案。如果是 Spring Boot 的项目推荐使用第 4 种全局时间格式化或第 5 种局部时间格式化的方式这两种实现方式都无需修改核心业务代码只需要简单的配置一下就可以完成时间的格式化功能了。参考 鸣谢www.jianshu.com/p/49fb78bca621baike.baidu.com/item/世界时/692237
往期推荐
绝Java 中创建对象的 5 种方法SpringBoot 优雅的参数效验面霸篇MQ 的 5 大关键问题详解
