Spring?Boot?中的?@DateTimeFormat?和?@JsonFormat?的用法及作用詳解

更新時間：2024年11月28日 11:41:24 作者：小林想被監(jiān)督學習

本文介紹了SpringBoot中的@DateTimeFormat和@JsonFormat注解的用法,解釋了它們在處理日期和時間數(shù)據(jù)時的作用,并通過實例代碼展示了如何在REST控制器中使用這些注解,感興趣的朋友跟隨小編一起看看吧

在開發(fā) Spring Boot 應用時，處理日期和時間數(shù)據(jù)是一個常見的需求。Spring Boot 提供了兩個注解 @DateTimeFormat 和 @JsonFormat 來幫助我們處理這些問題。這兩個注解分別用于將日期字符串解析為日期對象以及將日期對象格式化為字符串。本文將詳細介紹這兩個注解的用法及作用，并通過實例代碼進行說明。

@DateTimeFormat 注解

@DateTimeFormat 是一個 Spring 框架提供的注解，用于格式化和解析日期時間字段。它主要用于將請求參數(shù)或表單數(shù)據(jù)中的日期字符串解析為 Java 的日期對象。

用法

@DateTimeFormat 可以應用于以下數(shù)據(jù)類型：

java.util.Date
java.util.Calendar
java.time.LocalDate
java.time.LocalDateTime
java.time.ZonedDateTime

該注解的常用屬性包括：

pattern：指定日期格式的模式字符串，例如 "yyyy-MM-dd"。
iso：指定標準的 ISO 日期時間格式?？蛇x值為 DateTimeFormat.ISO.DATE、DateTimeFormat.ISO.TIME 和 DateTimeFormat.ISO.DATE_TIME。

示例

假設我們有一個處理日期的 REST 控制器：

package com.example.demo.controller;
import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
@RestController
public class DateController {
    @GetMapping("/date")
    public String handleDate(@RequestParam("date") @DateTimeFormat(pattern = "yyyy-MM-dd") LocalDate date) {
        return "Parsed date: " + date.format(DateTimeFormatter.ISO_DATE);
    }
    @GetMapping("/datetime")
    public String handleDateTime(@RequestParam("datetime") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) LocalDateTime dateTime) {
        return "Parsed datetime: " + dateTime.format(DateTimeFormatter.ISO_DATE_TIME);
    }
}

在上述示例中：

/date 端點處理格式為 "yyyy-MM-dd" 的字符串，并將其解析為 LocalDate 對象。
/datetime 端點處理 ISO 標準格式的日期時間字符串，并將其解析為 LocalDateTime 對象。

你可以通過以下 URL 測試這些端點：

http://localhost:8080/date?date=2023-10-01
http://localhost:8080/datetime?datetime=2023-10-01T10:15:30

@JsonFormat 注解

@JsonFormat 是 Jackson 庫提供的注解，用于序列化和反序列化 JSON 數(shù)據(jù)中的日期時間字段。它可以幫助我們將日期時間對象格式化為特定的字符串格式，或將特定格式的字符串解析為日期時間對象。

用法

@JsonFormat 可以應用于類的字段或方法上。其常用屬性包括：

pattern：指定日期時間格式的模式字符串。
shape：指定日期時間的格式化類型。常用值為 JsonFormat.Shape.STRING。
timezone：指定時區(qū)。

示例

假設我們有一個包含日期時間字段的實體類，并使用 @JsonFormat 注解格式化日期時間：

package com.example.demo.model;
import com.fasterxml.jackson.annotation.JsonFormat;
import java.time.LocalDate;
import java.time.LocalDateTime;
public class Event {
    private String name;
    @JsonFormat(pattern = "yyyy-MM-dd")
    private LocalDate date;
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "UTC")
    private LocalDateTime dateTime;
    // getters and setters
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public LocalDate getDate() {
        return date;
    }
    public void setDate(LocalDate date) {
        this.date = date;
    }
    public LocalDateTime getDateTime() {
        return dateTime;
    }
    public void setDateTime(LocalDateTime dateTime) {
        this.dateTime = dateTime;
    }
}

接著，我們創(chuàng)建一個 REST 控制器來測試該實體類的序列化和反序列化：

package com.example.demo.controller;
import com.example.demo.model.Event;
import org.springframework.web.bind.annotation.*;
import java.time.LocalDate;
import java.time.LocalDateTime;
@RestController
public class EventController {
    @GetMapping("/event")
    public Event getEvent() {
        Event event = new Event();
        event.setName("Spring Boot Workshop");
        event.setDate(LocalDate.of(2023, 10, 1));
        event.setDateTime(LocalDateTime.of(2023, 10, 1, 10, 15, 30));
        return event;
    }
    @PostMapping("/event")
    public String createEvent(@RequestBody Event event) {
        // 持久化邏輯...
        return "Event created: " + event.getName();
    }
}

在上述示例中：

/event GET 端點返回一個 Event 對象，其中日期和日期時間字段將根據(jù) @JsonFormat 注解指定的格式序列化為 JSON 字符串。
/event POST 端點接受一個 JSON 請求體，并將其反序列化為 Event 對象。

你可以通過以下方式測試這些端點：

GET 請求

curl -X GET http://localhost:8080/event

返回結果：

{
"name": "Spring Boot Workshop",
"date": "2023-10-01",
"dateTime": "2023-10-01 10:15:30"
}

POST 請求

curl -X POST http://localhost:8080/event -H "Content-Type: application/json" -d '{
    "name": "Spring Boot Workshop",
    "date": "2023-10-01",
    "dateTime": "2023-10-01 10:15:30"
}'

返回結果：

Event created: Spring Boot Workshop

小結

在本文中，我們詳細介紹了 Spring Boot 中的 @DateTimeFormat 和 @JsonFormat 注解的用法及作用。@DateTimeFormat 主要用于將請求參數(shù)或表單數(shù)據(jù)中的日期字符串解析為日期對象，而 @JsonFormat 則用于序列化和反序列化 JSON 數(shù)據(jù)中的日期時間字段。

通過這些注解，我們可以更方便地處理日期和時間數(shù)據(jù)，確保數(shù)據(jù)在不同層次間傳遞時的格式一致性。這對于開發(fā)高質量的 Spring Boot 應用至關重要

到此這篇關于Spring Boot 中的 @DateTimeFormat 和 @JsonFormat 的用法及作用的文章就介紹到這了,更多相關Spring Boot @DateTimeFormat 和 @JsonFormat內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: