快捷導(dǎo)航

在SpringBoot中配置日期格式化的方法詳解

更新時(shí)間：2023年10月20日 08:56:03 作者：深碼青年

通常情況下,發(fā)起一個(gè) Http 請求,Spring Boot 會根據(jù)請求路徑映射到指定 Controller 上的某個(gè)方法的參數(shù)上,接著,Spring 會自動進(jìn)行類型轉(zhuǎn)換,對于日期類型的參數(shù),Spring 默認(rèn)是沒有配置如何將字符串轉(zhuǎn)換成日期類型的,本文將給大家介紹在SpringBoot中配置日期格式化的方法

未配置日期格式化會如何？

我們新建一個(gè) Web 項(xiàng)目，并定義一個(gè)接口：

package site.exception.springbootdateformat.controller;

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;
import site.exception.springbootdateformat.entity.User;

/**
 * @time 21:03
 * @discription
 **/
@RestController
public class UserController {

    /**
     * 定義一個(gè)創(chuàng)建用戶的接口
     * @param user
     * @return
     */
    @PostMapping("/user")
    public String createUser(User user) {
        // 打印創(chuàng)建時(shí)間
        System.out.println(user.getCreateTime().toString());
        return "Create user success !";
    }
}

User.java:

package site.exception.springbootdateformat.entity;

import java.io.Serializable;
import java.util.Date;

/**
 * @time 21:00
 * @discription
 **/
public class User implements Serializable {
    /**
     * 用戶名
     */
    private String username;
    /**
     * 密碼
     */
    private String password;
    /**
     * 創(chuàng)建時(shí)間
     */
    private Date createTime;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public Date getCreateTime() {
        return createTime;
    }

    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }
}

用 Postman 工具發(fā)起對該接口的表單請求，看看結(jié)果：

服務(wù)報(bào)錯(cuò)，無法將字符串類型轉(zhuǎn)換成 java.util.Date 類型。

配置日期格式化

要讓 Spring Boot 能夠按照指定的格式進(jìn)行日期類型轉(zhuǎn)換，需要做以下步驟：

定義一個(gè) MvcConfig 類，讓其實(shí)現(xiàn) WebMvcConfigurer 接口；
重寫 addFormatters 方法；
添加一個(gè) DateFormatter;

package site.exception.springbootdateformat.config;

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


/**
 * @author www.exception.site (exception 教程網(wǎng))
 * @date 2019/2/16
 * @time 20:55
 * @discription
 **/
@Configuration
public class MvcConfig implements WebMvcConfigurer {

    /**
     * 配置日期格式化
     * @param registry
     */
    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addFormatter(new DateFormatter("yyyy-MM-dd HH:mm:ss"));
    }
}

接下來，再次以表單的形式訪問 /user 接口，看看效果：