SpringBoot三種方法接口返回日期格式化小結

更新時間：2025年01月10日 10:45:03 作者：weixin_46242847

本文介紹了三種在Spring Boot中格式化接口返回日期的方法,包含使用@JsonFormat注解、全局配置JsonConfig、以及在yml文件中配置時區(qū),具有一定的參考價值,感興趣的可以了解一下

方法一：@JsonFormat注解

在返回實體的字段上添加@JsonFormat注解。

@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
private Date createDate;

pattern是日期格式，timezone是時間分區(qū)。格式具體可以參考下圖：

在這里插入圖片描述

方法二：JsonConfig配置

全局配置。好處：無需每個類配置日期格式壞處：不靈活，只能統(tǒng)一。

package com.xy.config;

import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer;
import org.springframework.boot.jackson.JsonComponent;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;

import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.TimeZone;

//jackson日期
@Slf4j
@JsonComponent

public class JacksonConfig {

    @Value("${my.jackson.date-format:yyyy-MM-dd HH:mm:ss}")
    private String pattern;

    @Bean
    public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilder() {

        return builder -> {
            TimeZone tz = TimeZone.getTimeZone("GMT+8");
            DateFormat df = new SimpleDateFormat(pattern);
            df.setTimeZone(tz);
            builder.failOnEmptyBeans(false)
                    .failOnUnknownProperties(false)
                    .featuresToDisable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS)
                    .dateFormat(df);
        };
    }

    @Bean
    public LocalDateTimeSerializer localDateTimeDeserializer() {
        return new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(pattern));
    }

    @Bean
    public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilderCustomizer() {
        return builder -> builder.serializerByType(LocalDateTime.class, localDateTimeDeserializer());
    }

}

然后配置文件里配置好格式就行。

方法三：yml配置

spring:
  jackson:
    date-format: yyyy-MM-dd HH:mm:ss
    time-zone: GMT+8

UTC和 GMT區(qū)別UTC‌：協調世界時間（UTC）是基于原子時鐘的時間計量系統(tǒng)，旨在盡量接近世界時（UT）。UTC的時間尺度是均勻的，不考慮地球自轉速度的變化‌。‌GMT+8‌：格林威治平均時間加8小時，即東八區(qū)的本地時間。GMT+8通常用于表示中國北京時間‌‌UTC‌：在國際無線電通信、衛(wèi)星導航等需要高精度時間計量的場合廣泛使用‌。‌GMT+8‌：常用于表示中國北京時間，在電子郵件信頭、軟件顯示時間等場合使用‌?？偨Y：UTC和GMT+8基本相同，UTC更精確而GMT+8常代表北京時間。