快捷導(dǎo)航

SpringBoot幾種常用的接口日期格式化方法

更新時間：2024年11月08日 10:01:07 作者：塵世中-迷途小書童

在 Springboot 應(yīng)用程序中,日期時間格式化處理是非常重要的一方面,本文將總結(jié)SpringBoot幾種常用的接口日期格式化方法,通過示例代碼介紹了非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下

全局時間格式化

通過在配置文件中設(shè)置可以實現(xiàn)全局時間格式化。在 Spring Boot 的配置文件 application.properties（或 application.yml）中添加以下兩行配置：

# 格式化全局時間字段
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
# 指定時間區(qū)域類型
spring.jackson.time-zone=GMT+8

實現(xiàn)原理分析：Controller 在返回數(shù)據(jù)時，會自動調(diào)用 Spring Boot 框架中內(nèi)置的 JSON 框架 Jackson，對返回的數(shù)據(jù)進(jìn)行統(tǒng)一的 JSON 格式化處理。在處理過程中，它會判斷配置文件中是否設(shè)置了 “spring.jackson.date-format=yyyy-MM-dd HH:mm:ss”，如果設(shè)置了，那么 Jackson 框架在對時間類型的字段輸出時就會執(zhí)行時間格式化的處理，從而實現(xiàn)全局時間字段的格式化功能。

部分時間格式化

在某些場景下，不需要對全局的時間都進(jìn)行統(tǒng)一處理，可以使用注解的方式實現(xiàn)部分時間字段的格式化。在實體類 UserInfo 中添加 @JsonFormat 注解，實現(xiàn)代碼如下：

import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.Data;
import java.util.Date;
 
@Data
public class UserInfo {
    private int id;
    private String username;
    // 對 createtime 字段進(jìn)行格式化處理
    @JsonFormat(pattern = "yyyy-MM-dd hh:mm:ss", timezone = "GMT+8")
    private Date createtime;
    private Date updatetime;
}

自定義參數(shù)轉(zhuǎn)換器

在 Spring Boot 中，可以使用自定義參數(shù)轉(zhuǎn)換器實現(xiàn)日期格式化。實現(xiàn) org.springframework.core.convert.converter.Converter接口，自定義參數(shù)轉(zhuǎn)換器，如下：

@Configuration
public class DateConverterConfig {
    @Bean
    public Converter<String, LocalDate> localDateConverter() {
        return new Converter<String, LocalDate>() {
            @Override
            public LocalDate convert(String source) {
                return LocalDate.parse(source, DateTimeFormatter.ofPattern("yyyy-MM-dd"));
            }
        };
    }
    @Bean
    public Converter<String, LocalDateTime> localDateTimeConverter() {
        return new Converter<String, LocalDateTime>() {
            @Override
            public LocalDateTime convert(String source) {
                return LocalDateTime.parse(source, DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
            }
        };
    }
}

在使用自定義參數(shù)轉(zhuǎn)換器時可能會遇到一些問題。例如，將匿名內(nèi)部類的寫法精簡成 lambda 表達(dá)式的方式時，啟動項目可能會出現(xiàn)異常。原因是 lambda 表達(dá)式的接口是 Converter，不能得到具體的類型。解決辦法有兩種：一是不使用 lambda 表達(dá)式，老老實實使用匿名內(nèi)部類；二是等 requestMappingHandlerAdapter bean 注冊完成之后再添加自己的 converter，這樣就不會注冊到 FormattingConversionService中。

此外，還可以對前端傳遞的 string 進(jìn)行正則匹配，如 yyyy-MM-dd HH:mm:ss、yyyy-MM-dd、HH:mm:ss等，以適應(yīng)多種場景。

使用 Spring 注解

Spring 自帶注解 @DateTimeFormat可以進(jìn)行日期格式化。它通常用于將字符串格式的日期轉(zhuǎn)換為日期類型。在需要進(jìn)行日期格式轉(zhuǎn)換的 Date屬性上添加注解 @DateTimeFormat(pattern = "需要轉(zhuǎn)換的格式")。例如：

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

使用 @DateTimeFormat注解時需要注意，pattern指定的格式是和傳入的參數(shù)的格式相對應(yīng)。如果格式不對應(yīng)，可能會拋出異常。

使用 ControllerAdvice 配合 initBinder

在 controller 做環(huán)切時，可以使用 initBinder進(jìn)行時間格式化。新建 InitBinderDateController類，進(jìn)行全局時間入?yún)⒏袷交?/p>

@ControllerAdvice
public class InitBinderDateController {
    /**
     * 將前臺傳遞過來的日期格式的字符串，自動轉(zhuǎn)化為時間類型
     * [攔截不到@RequestBody注解修飾的參數(shù)]
     */
    @InitBinder("date")
    public void initBinder(WebDataBinder binder) {
        // Date 類型轉(zhuǎn)換
        //        DateFormat dateFormat=new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        //        binder.registerCustomEditor(Date.class,new CustomDateEditor(dateFormat, true));
        //       System.out.println("test");
        // LocalDateTime 類型轉(zhuǎn)換
        binder.registerCustomEditor(LocalDateTime.class, new PropertyEditorSupport() {
            @Override
            public void setAsText(String text) {
                if (!StringUtils.isEmpty(text)) {
                    setValue(LocalDateTime.parse(text, DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
                }
            }
        });
    }
}

后端全局設(shè)置

可以通過配置后端實現(xiàn)全局請求日期格式轉(zhuǎn)換。例如，在配置文件中配置：

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

或者使用配置類方式，適合前后端都是 json 格式交互。只需要用 @Configuration定義一個配置類，注入兩個 Bean即可完成全局日期響應(yīng)格式化處理。

@Configuration
public class LocalDateTimeSerializerConfig {
    private static final String YYYY_MM_DD_HH_MM_SS = "yyyy-MM-dd HH:mm:ss";
    @Bean
    public LocalDateTimeSerializer localDateTimeSerializer() {
        return new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(YYYY_MM_DD_HH_MM_SS));
    }
    @Bean
    public LocalDateTimeDeserializer localDateTimeDeserializer() {
        return new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(YYYY_MM_DD_HH_MM_SS));
    }
    @Bean
    public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilderCustomizer() {
        return builder -> {
            builder.serializerByType(LocalDateTime.class, localDateTimeSerializer());
            builder.deserializerByType(LocalDateTime.class, localDateTimeDeserializer());
        };
    }
}

接口輸出日期格式為時間戳

在 Spring Boot 中，實現(xiàn)接口輸出日期格式為時間戳的步驟如下：

配置日期格式化器：在 Spring Boot 的配置文件中，我們可以配置一個日期格式化器，將日期格式化為時間戳。可以在 application.properties（或 application.yml）中添加以下配置：spring.mvc.format.date=unix。
定義實體類：我們首先需要定義一個實體類，用于表示需要輸出的日期字段：

public class MyEntity {
    private Date date;
    // getter and setter
}

編寫控制器：接下來，我們需要編寫一個控制器類，用于處理接口請求并返回日期字段的時間戳形式。我們可以使用 @JsonFormat注解來指定日期字段的格式化方式。下面是一個簡單的示例：

@RestController
public class MyController {
    @GetMapping("/entity")
    public MyEntity getEntity() {
        MyEntity entity = new MyEntity();
        entity.setDate(new Date());
        return entity;
    }
}