当前位置:主页 > java教程 > SpringBoot基于HttpMessageConverter实现全局日期格式化

SpringBoot全局日期格式化(基于HttpMessageConverter)

发布:2020-02-14 17:04:56 174


给寻找编程代码教程的朋友们精选了Java相关的编程文章,网友步敏智根据主题投稿了本篇教程内容,涉及到SpringBoot、日期格式化、HttpMessageConverter、SpringBoot基于HttpMessageConverter实现全局日期格式化相关内容,已被537网友关注,涉猎到的知识点内容可以在下方电子书获得。

SpringBoot基于HttpMessageConverter实现全局日期格式化

还在为日期格式化的问题头痛?赶紧阅览文章寻找答案吧!

学习目标

快速学会使用Jackson消息转换器并实现日期的全局格式化。

快速查阅

源码下载:SpringBoot-Date-Format

开始教程

一、全局日期格式化(基于自动配置)

关于日期格式化,很多人会想到使用Jackson的自动配置:

spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
spring.jackson.timeZone: GMT+8

这种全局日期格式化固然方便,但在消息传递时只能解析特定的时间格式,在实际业务开展中并不那么方便。例如某接口返回的是long类型的时间戳,显然此时消息转换器将抛出解析失败的异常。

那么有没更好的办法,既支持返回默认的日期格式,又支持解析复杂的日期字符串?

答案是有的,只需要重写Jackson的消息转换器来支持解析复杂的日期格式即可。

二、全局日期格式化(基于消息转换器)

首先在项目引入Jackson、Thymeleaf等相关依赖:
 

   <dependency><!--Web相关依赖-->
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency><!--Thymeleaf依赖-->
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-thymeleaf</artifactId>
    </dependency>
    <dependency><!--JSON 解析工具类-->
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-databind</artifactId>
    </dependency>
    <dependency><!--XML 解析工具类-->
      <groupId>com.fasterxml.jackson.dataformat</groupId>
      <artifactId>jackson-dataformat-xml</artifactId>
      <optional>true</optional>
    </dependency>

然后根据 SimpleDateFormat 来定制支持复杂日期类型解析的工具类。

  private SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss") {
    //根据实际业务支持各种复杂格式的日期字符串。
    @Override
    public Date parse(String source) {
      try {
        return super.parse(source);//支持解析指定pattern类型。
      } catch (Exception e) {
        try {
          return new StdDateFormat().parse(source);//支持解析long类型的时间戳
        } catch (ParseException e1) {
          throw new RuntimeException("日期格式非法:" + e);
        }
      }
    }
  };

紧接着根据使用场景,来介绍如何快速实现日期的格式化。

关于日期时间格式化的三种使用场景

(1)使用@ResponseBody返回JSON信息会用到MappingJackson2HttpMessageConverter 。

 @Bean
  public MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter() {
    MappingJackson2HttpMessageConverter jsonConverter = new MappingJackson2HttpMessageConverter();
    //设置解析JSON工具类
    ObjectMapper objectMapper = new ObjectMapper();
    //设置解析日期的工具类
    objectMapper.setDateFormat(dateFormat);
    //忽略未知属性 防止解析报错
    objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
    jsonConverter.setObjectMapper(objectMapper);
    List<MediaType> list = new ArrayList<>();
    list.add(MediaType.APPLICATION_JSON_UTF8);
    jsonConverter.setSupportedMediaTypes(list);
    return jsonConverter;
  }

(2)使用@ResponseBody返回XML信息会用到MappingJackson2XmlHttpMessageConverter。

 @Bean
  public MappingJackson2XmlHttpMessageConverter mappingJackson2XmlHttpMessageConverter() {
    MappingJackson2XmlHttpMessageConverter xmlConverter = new MappingJackson2XmlHttpMessageConverter();
    //设置解析XML的工具类
    XmlMapper xmlMapper = new XmlMapper();
    //设置解析日期的工具类
    xmlMapper.setDateFormat(dateFormat);
    //忽略未知属性 防止解析报错
    xmlMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
    xmlConverter.setObjectMapper(xmlMapper);
    return xmlConverter;
  }

(3)使用ModelAndView返回HTML页面信息。

值得注意的是,无论上面哪种消息转换器均无法满足页面日期的全局格式化,因为th:object默认调用的日期Date的toString方法,所以在Thymemleaf页面对日期格式化需要借助工具类#dates。

例如:<input th:value="*{#dates.format(createTime,'yyyy-MM-dd HH:mm:ss')}">

三、测试日期格式化

推荐大家下载源码对照撸一遍,实践是检验真理的唯一标准。

JAVA代码:

/**
 * 用户管理
 */
@RestController
public class UserController {

  /**
   * 打开主页
   */
  @GetMapping("/")
  public ModelAndView index() {
    ModelAndView mv = new ModelAndView("user/user");
    mv.addObject("user", new User("1", "admin", "123456", new Date()));
    return mv;
  }

  /**
   * 自动根据请求来判断返回用户JSON或XML
   */
  @GetMapping("/user")
  public User get() {
    return new User("1", "admin", "123456", new Date());
  }

  /**
   * 返回用户JSON
   */
  @GetMapping(value = "/user/json", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
  public User getJson() {
    return new User("1", "admin", "123456", new Date());
  }

  /**
   * 返回用户XML
   */
  @GetMapping(value = "/user/xml", produces = MediaType.APPLICATION_XML_VALUE)
  public User getXml() {
    return new User("1", "admin", "123456", new Date());
  }

}

页面代码:

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
  <meta charset="UTF-8">
  <title>日期格式化</title>
</head>
<body>
<h3><a th:href="@{

参考资料

相关文章

  • springboot整合xxl-job实现分布式定时任务的过程

    springboot整合xxl-job实现分布式定时任务的过程

    发布:2023-01-03

    为网友们分享了关于springboot的教程,XXL-JOB是一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展,这篇文章主要介绍了springboot整合xxl-job分布式定时任务,需要的朋友可以参考下


  • springboot使用mybatis开启事务回滚

    发布:2023-04-14

    本文主要介绍了springboot使用mybatis开启事务回滚,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧


  • SpringBoot实用小技巧之如何动态设置日志级别

    发布:2022-09-23

    给大家整理了关于SpringBoot的教程,这篇文章主要给大家介绍了关于SpringBoot实用小技巧之如何动态设置日志级别的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用SpringBoot具有一定的参考学习价值,需要的朋友


  • SpringBoot集成Nacos实现注册中心与配置中心流程详解

    发布:2023-03-30

    这篇文章主要介绍了SpringBoot集成Nacos实现注册中心与配置中心流程,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习吧


  • SpringBoot实现自定义启动器的示例详解

    发布:2023-03-08

    虽然Spring官方给我们提供了很多的启动器供我们使用,但有时候我们也会遇到某些特殊场景,这些启动器满足不了。这个时候就需要自定义一个启动器供我们使用,本文为大家介绍了SpringBoot实现自定义启动器的方法,希望对大家有所帮助


  • SpringBoot访问静态资源的配置及顺序说明

    SpringBoot访问静态资源的配置及顺序说明

    发布:2022-07-06

    给网友们整理关于SpringBoot的教程,这篇文章主要介绍了SpringBoot访问静态资源的配置及顺序说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教


  • Spring boot 整合Logback过程示例解析

    发布:2023-04-05

    这篇文章主要为大家介绍了Spring boot 整合Logback的过程及示例解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪


  • SpringBoot2零基础到精通之自动配置底层分析及小技巧

    SpringBoot2零基础到精通之自动配置底层分析及小技巧

    发布:2022-10-21

    给网友们整理关于SpringBoot的教程,SpringBoot是一种整合Spring技术栈的方式(或者说是框架),同时也是简化Spring的一种快速开发的脚手架,本篇让我们一起学习自动配置的底层分析与一些开发中的小技巧


网友讨论