在Spring Boot中自定义JSON返回日期格式的指南

在开发Spring Boot应用时,很多时候需要在返回的JSON数据中以特定格式显示日期和时间。例如,使用LocalDateTimeDate等类型的字段时,默认的序列化格式可能不是你期望的路径。本文将介绍如何在Spring Boot中实现控制返回JSON数据的日期格式 ,主要围绕@JsonFormat进行讲解。


1. 为什么需要控制JSON中的日期格式?

默认情况下,Spring Boot(基于Jackson)会按照Jackson的默认配置将日期字段序列化成类似"yyyy-MM-dd'T'HH:mm:ss"的格式。这在某些场景下可能不符合业务要求,或者在前端展示时需要特定的格式。

示例:

复制代码
{
  "name": "张三",
  "createTime": "2025-06-17T15:20:30"
}

如果你希望日期显示为"yyyy-MM-dd HH:mm:ss"形式,比如"2025-06-17 15:20:30",那么就需要自定义格式。


2. 方案一:在字段上使用@JsonFormat

这是最常用的做法。只需要在日期字段上添加注解,指定格式:

复制代码
public class User {
    private String name;

    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime createTime;

    // getters and setters
}

效果:

复制代码
{
  "name": "张三",
  "createTime": "2025-06-17 15:20:30"
}

3. 方案二:全局配置ObjectMapper

如果项目中大量日期字段都要统一格式,建议配置全局的ObjectMapper

示例:

复制代码
@Configuration
public class JacksonConfig {
    @Bean
    public ObjectMapper objectMapper() {
        ObjectMapper mapper = new ObjectMapper();
        // 设置全局日期格式
        mapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
        return mapper;
    }
}

这会影响整个应用的所有日期序列化行为。


4. 什么时候用@JsonFormat,什么时候用@DateTimeFormat

场景 使用的注解 作用范围
请求参数绑定(例如:请求中日期字符串转换为Java对象的字段) @DateTimeFormat 控制请求参数到Java对象的绑定规则
JSON序列化/反序列化(返回响应的JSON格式控制) @JsonFormat 控制序列化输出的日期格式

总结 :返回JSON数据时,主要用@JsonFormat


5. 具体示例:完整的控制器和实体类

复制代码
import com.fasterxml.jackson.annotation.JsonFormat;

public class User {
    private String name;

    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime createTime;

    // constructors, getters, setters
}

@RestController
public class UserController {

    @GetMapping("/user")
    public User getUser() {
        User user = new User();
        user.setName("张三");
        user.setCreateTime(LocalDateTime.now());
        return user; // 返回的JSON时间会按照@JsonFormat指定的格式输出
    }
}

6. 结语

在Spring Boot中控制返回JSON的日期格式,使用@JsonFormat是最直接、最常用的方法。结合全局配置或者字段配置,可以满足大部分业务需求。

如果你的应用还需要更复杂的日期格式化策略,比如地域性、时区等,也可以在@JsonFormat中加入timezone参数,例如:

复制代码
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")

7. 提示

  • 不建议只依赖@DateTimeFormat来控制JSON输出,它只对请求参数绑定起作用。
  • 全局配置应慎用,避免不同模块的格式不一致。
相关推荐
nbsaas-boot1 小时前
Java 正则表达式白皮书:语法详解、工程实践与常用表达式库
开发语言·python·mysql
岁忧1 小时前
(LeetCode 面试经典 150 题 ) 11. 盛最多水的容器 (贪心+双指针)
java·c++·算法·leetcode·面试·go
chao_7891 小时前
二分查找篇——搜索旋转排序数组【LeetCode】两次二分查找
开发语言·数据结构·python·算法·leetcode
CJi0NG1 小时前
【自用】JavaSE--算法、正则表达式、异常
java
风无雨1 小时前
GO 启动 简单服务
开发语言·后端·golang
Hellyc1 小时前
用户查询优惠券之缓存击穿
java·redis·缓存
斯普信专业组1 小时前
Go语言包管理完全指南:从基础到最佳实践
开发语言·后端·golang
今天又在摸鱼2 小时前
Maven
java·maven
老马啸西风2 小时前
maven 发布到中央仓库常用脚本-02
java·maven
代码的余温2 小时前
MyBatis集成Logback日志全攻略
java·tomcat·mybatis·logback