论坛 › Java › Spring Boot 日期格式化

我爱普洱茶 发表于 2023-10-27 00:49:38

Spring Boot 日期格式化

https://img2023.cnblogs.com/blog/2583030/202310/2583030-20231011204315874-398401107.png
我们先了解下，为什么需要配置日期格式化？
通常情况下，发起一个 Http 请求，Spring Boot 会根据请求路径映射到指定 Controller 上的某个方法的参数上，接着，Spring 会自动进行类型转换。
对于日期类型的参数，Spring 默认是没有配置如何将字符串转换成日期类型的
未配置日期格式化会如何？

我们新建一个 Web 项目，并定义一个接口：
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 {

    /**
   * 定义一个创建用户的接口
   * @param user
   * @return
   */
    @PostMapping("/user")
    public String createUser(User user) {
      // 打印创建时间
      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;
    /**
   * 创建时间
   */
    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 工具发起对该接口的表单请求，看看结果：
https://img2023.cnblogs.com/blog/2583030/202310/2583030-20231011204342103-927881048.png
服务报错，无法将字符串类型转换成 java.util.Date 类型。
配置日期格式化

要让 Spring Boot 能够按照指定的格式进行日期类型转换，需要做以下步骤：

[*]定义一个 MvcConfig 类，让其实现 WebMvcConfigurer 接口；
[*]重写 addFormatters 方法；
[*]添加一个 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 教程网)
* @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 接口，看看效果：
https://img2023.cnblogs.com/blog/2583030/202310/2583030-20231011204352432-426976337.png
正确输出 Create user Success !  接口，并且控制台，也打印了 createTime 值，说明 Spring Boot 已经自动帮我们做了转换操作：
https://img2023.cnblogs.com/blog/2583030/202310/2583030-20231011204358525-452280382.png
至此，如何在 Spring Boot 中配置全局的日期格式化就完成了！
注意：本节中的转换仅支持表单形式请求，不支持 application/json 的请求方式！

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

查看完整版本: Spring Boot 日期格式化