在日常开发中，后端经常需要返回时间数据给前端，但你是否遇到过这样的问题：
- 前端想要”yyyy-MM-dd HH:mm:ss”格式，后端返回的却是时间戳
- 时区不对，显示的时间总是差8小时
- 每次都要手动格式化，代码重复且繁琐
今天我们要介绍的@JsonFormat注解，就是解决这些问题的利器！
@JsonFormat是Jackson库提供的注解，主要用于在序列化和反序列化过程中格式化日期时间字段。通过在实体类字段上添加这个注解，我们可以轻松控制日期时间的显示格式和时区。
基本用法详解
public class User {
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
private Date createTime;
// getter和setter方法
}
主要参数说明：
1. pattern（必填）
定义日期时间格式，支持的各种格式符号：
- yyyy：四位年份
- MM：两位月份
- dd：两位日期
- HH：24小时制的小时
- mm：分钟
- ss：秒
- SSS：毫秒
2. timezone（重要）
设置时区，避免时间差问题：
- GMT+8：东八区（中国标准时间）
- 建议始终明确指定时区
3. shape（可选）
定义序列化的形状，默认为Shape.ANY
实际应用示例
1. 基本日期格式化
@JsonFormat(pattern = "yyyy-MM-dd")
private Date birthday; // 输出：2023-10-15
2. 完整日期时间格式
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
private Date createTime; // 输出：2023-10-15 14:30:25
3. 带毫秒的时间格式
在日常开发中，后端经常需要返回时间数据给前端，但你是否遇到过这样的问题：
- 前端想要”yyyy-MM-dd HH:mm:ss”格式，后端返回的却是时间戳
- 时区不对，显示的时间总是差8小时
- 每次都要手动格式化，代码重复且繁琐
今天我们要介绍的@JsonFormat注解，就是解决这些问题的利器！
@JsonFormat是Jackson库提供的注解，主要用于在序列化和反序列化过程中格式化日期时间字段。通过在实体类字段上添加这个注解，我们可以轻松控制日期时间的显示格式和时区。
基本用法详解
public class User {
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
private Date createTime;
// getter和setter方法
}
主要参数说明：
1. pattern（必填）
定义日期时间格式，支持的各种格式符号：
- yyyy：四位年份
- MM：两位月份
- dd：两位日期
- HH：24小时制的小时
- mm：分钟
- ss：秒
- SSS：毫秒
2. timezone（重要）
设置时区，避免时间差问题：
- GMT+8：东八区（中国标准时间）
- 建议始终明确指定时区
3. shape（可选）
定义序列化的形状，默认为Shape.ANY
实际应用示例
1. 基本日期格式化
@JsonFormat(pattern = "yyyy-MM-dd")
private Date birthday; // 输出：2023-10-15
2. 完整日期时间格式
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
private Date createTime; // 输出：2023-10-15 14:30:25
3. 带毫秒的时间格式
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss.SSS", timezone = "GMT+8")
private Date updateTime; // 输出：2023-10-15 14:30:25.123
时区问题解决方案
很多开发者都会遇到时区问题，这里给出最佳实践：
// 推荐做法：明确指定时区
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
private Date createTime;
// 不推荐：依赖系统默认时区，容易出问题
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private Date createTime;
配合其他注解使用
@JsonFormat可以与其他Jackson注解配合使用：
// 忽略null值并格式化时间
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
private Date lastLoginTime;
注意事项
- 依赖要求：确保项目中引入了Jackson库
- 线程安全：SimpleDateFormat非线程安全，但Jackson内部已做处理
- 性能影响：大量使用时会轻微影响性能，但在可接受范围内
- LocalDateTime支持：从Jackson 2.6开始支持Java 8的日期时间API
总结
@JsonFormat注解虽然简单，但在实际开发中却能解决大问题。通过本文的介绍，相信你已经掌握了：
- 基本用法和参数配置
- 时区问题的解决方法
- 实际应用的最佳实践
下次遇到时间格式化需求时，记得使用@JsonFormat注解，让你的代码更加简洁优雅！
如果你在使用过程中遇到任何问题，欢迎在评论区留言讨论～
