Spring Boot 日期格式化
一则或许对你有用的小广告
欢迎加入小哈的星球 ,你将获得:专属的项目实战 / Java 学习路线 / 一对一提问 / 学习打卡/ 赠书活动
目前,
星球
内第2个项目《仿小红书(微服务架构)》正在更新中。第1个项目:全栈前后端分离博客项目已经完结,演示地址:http://116.62.199.48/。采用技术栈 Spring Boot + Mybatis Plus + Vue 3.x + Vite 4
,手把手,前端 + 后端全栈开发,从 0 到 1 讲解每个功能点开发步骤,1v1 答疑,陪伴式直到项目上线,目前已更新了 255 小节,累计 39w+ 字,讲解图:1716 张,还在持续爆肝中,后续还会上新更多项目,目标是将 Java 领域典型的项目都整上,如秒杀系统、在线商城、IM 即时通讯、权限管理等等,已有 1300+ 小伙伴加入,欢迎点击围观
。
本节中,您将学习如何在 Spring Boot 中全局配置日期格式化。在那之前,我们先了解下,为什么需要配置日期格式化?
通常情况下,发起一个 Http 请求,Spring Boot 会根据请求路径映射到指定 Controller 上的某个方法的参数上,接着,Spring 会自动进行类型转换。
但是,对于日期类型的参数,Spring 默认是没有配置如何将字符串转换成日期类型的。
未配置日期格式化会如何?
不信的话,我们可以来做个试验, 我们新建一个 Web 项目,并定义一个接口:
package site.exception.springbootdateformat.controller;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;
import site.exception.springbootdateformat.entity.User;
/**
* @author www.exception.site (exception 教程网)
* @date 2019/2/16
* @time 21:03
* @discription
**/
@RestController
public class UserController {
/**
* 定义一个创建用户的接口
* @param user
* @return
*/
@PostMapping("/user")
public String createUser(User user) {
// 打印创建时间
System.out.println(user.getCreateTime().toString());
return "Create user success !";
}
}
User.java
:
package site.exception.springbootdateformat.entity;
import java.io.Serializable;
import java.util.Date;
/**
* @author www.exception.site (exception 教程网)
* @date 2019/2/16
* @time 21:00
* @discription
**/
public class User implements Serializable {
/**
* 用户名
*/
private String username;
/**
* 密码
*/
private String password;
/**
* 创建时间
*/
private Date createTime;
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public Date getCreateTime() {
return createTime;
}
public void setCreateTime(Date createTime) {
this.createTime = createTime;
}
}
用 Postman 工具发起对该接口的表单请求,看看结果:
服务报错,无法将字符串类型转换成 java.util.Date
类型。
配置日期格式化
要让 Spring Boot 能够按照指定的格式进行日期类型转换,需要做以下步骤:
- 定义一个
MvcConfig
类,让其实现WebMvcConfigurer
接口; - 重写
addFormatters
方法; - 添加一个
DateFormatter
;
package site.exception.springbootdateformat.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.format.FormatterRegistry;
import org.springframework.format.datetime.DateFormatter;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
/**
* @author www.exception.site (exception 教程网)
* @date 2019/2/16
* @time 20:55
* @discription
**/
@Configuration
public class MvcConfig implements WebMvcConfigurer {
/**
* 配置日期格式化
* @param registry
*/
@Override
public void addFormatters(FormatterRegistry registry) {
registry.addFormatter(new DateFormatter("yyyy-MM-dd HH:mm:ss"));
}
}
接下来,再次以表单的形式访问 /user
接口,看看效果:
正确输出 Create user Success ! 接口,并且控制台,也打印了 createTime
值,说明 Spring Boot 已经自动帮我们做了转换操作:
至此,如何在 Spring Boot 中配置全局的日期格式化就完成了!
注意:本节中的转换仅支持表单形式请求,不支持
application/json
的请求方式!