如何在 SpringBoot 项目中返回的 Json 数据时设置时间显示格式

本文讲述了如何在SpringBoot项目中控制Json响应中的时间格式,包括使用全局日期格式化器、自定义Converter接口以及利用Jackson的@JsonFormat注解进行特定字段的格式化。
摘要由CSDN通过智能技术生成

如何在 SpringBoot 项目中返回的 Json 数据时设置时间显示格式

一般情况下为:

{
    "code": 0,
    "data": {
        "id": "1767787571510149122",
        "departmentName": "小小校长",
        "departmentProfile": "一个学校的统管者",
        "departmentProperty": "校级行政管理",
        "createTime": "2024-03-13T05:39:35.000+00:00",
        "updateTime": "2024-03-13T05:39:35.000+00:00",
        "isDelete": 0
    },
    "message": "ok"
}

方法:

无法奏效

在 Spring Boot 项目中,你可以使用自定义的全局日期格式化器来统一处理返回给前端的日期时间格式。你可以通过实现 org.springframework.core.convert.converter.Converter 接口来创建一个全局的日期格式化器。

以下是一个示例:

import org.springframework.core.convert.converter.Converter;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;

public class CustomDateConverter implements Converter<String, Date> {

    private final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

    @Override
    public Date convert(String source) {
        try {
            return dateFormat.parse(source);
        } catch (ParseException e) {
            return null; // or throw an exception
        }
    }
}

然后,在你的 Spring Boot 应用程序中,你可以将这个转换器注册为一个全局的日期转换器,这样它就会被应用于所有的日期转换操作:

import org.springframework.context.annotation.Configuration;
import org.springframework.format.FormatterRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverter(new CustomDateConverter());
    }
}

现在,当你返回日期时间字符串时,它将会按照你定义的格式进行转换,即 yyyy-MM-dd HH:mm:ss。你可以在你的控制器中返回带有时间戳的日期,Spring Boot 将会使用全局的日期转换器将其转换成指定格式的日期字符串返回给前端。

奏效

如果你希望在返回给前端的 JSON 中将日期时间格式化为指定格式(例如 yyyy-MM-dd hh:mm:ss),你需要在 Spring Boot 应用程序中配置日期格式化。虽然我们已经实现了一个全局的日期转换器来将日期字符串转换为 Date 类型,但在返回 JSON 响应时,Spring Boot 不会自动应用此转换器。

为了使 Spring Boot 在返回 JSON 响应时自动将日期格式化为指定格式,你可以使用 Jackson 库提供的 @JsonFormat 注解。你可以在返回的数据模型中使用 @JsonFormat 注解来指定日期的格式化方式。示例如下:

import com.fasterxml.jackson.annotation.JsonFormat;
import java.util.Date;

public class Department {

    private String id;
    private String departmentName;
    private String departmentProfile;
    private String departmentProperty;

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

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

    private int isDelete;

    // Getters and setters
}

通过在 createTimeupdateTime 字段上添加 @JsonFormat 注解,并指定 pattern 参数为 "yyyy-MM-dd HH:mm:ss",这样在返回 JSON 响应时,Spring Boot 将会自动将这两个日期格式化为指定的格式。

修改后

{
    "code": 0,
    "data": {
        "id": "1767787571510149122",
        "departmentName": "小小校长",
        "departmentProfile": "一个学校的统管者",
        "departmentProperty": "校级行政管理",
        "createTime": "2024-03-13 05:39:35",
        "updateTime": "2024-03-13 05:39:35",
        "isDelete": 0
    },
    "message": "ok"
}

大家好,我是xwhking,一名技术爱好者,目前正在全力学习 Java,前端也会一点,如果你有任何疑问请你评论,或者可以加我QQ(2837468248)说明来意!希望能够与你共同进步

SpringBoot通过使用统一的数据返回格式可以提高开发效率和代码的可维护性。返回统一的JSON数据格式可以统一前后端之间的数据交互方式,减少沟通成本,并且提高了代码的可读性和可维护性。 在SpringBoot,可以定义一个全局异常处理器(GlobalExceptionHandler),用于捕获和处理全局的异常。在异常处理器,可以定义一个统一的数据返回格式,包括状态码、提示信息和返回数据。当发生异常,异常处理器会将异常信息封装成统一的JSON数据格式返回前端,以便前端进行处理。 为了实现统一的数据返回格式,可以定义一个响应对象(ResponseObject),包含对应的状态码、提示信息和返回数据。在业务逻辑处理,统一使用ResponseObject来封装返回数据,然后再返回前端。 在控制器层,可以使用ResponseEntity对象来返回统一的JSON数据格式。通过使用ResponseEntity.ok()方法可以返回一个状态码为200的成功响应,然后将ResponseObject对象作为响应的数据。这样,无论是成功还是失败,都能以统一的JSON数据格式返回前端。 在返回数据,可以添加一些通用的字段,如请求ID、访问间等,以便用于日志记录和跟踪。 通过采用统一的JSON数据返回格式,可以提高代码的可读性、可维护性和规范性,方便前后端的协作和沟通。同,也可以方便后期的维护和扩展,减少了代码的冗余和重复编写。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

xwhking

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值