SpringBoot基于HttpMessageConverter实现全局日期格式化
更新时间：2018年12月26日 11:15:52 作者：yizhiwazi
这篇文章主要介绍了SpringBoot基于HttpMessageConverter实现全局日期格式化，使用Jackson消息转换器，非常具有实用价值，需要的朋友可以参考下
还在为日期格式化的问题头痛？赶紧阅览文章寻找答案吧！
学习目标
快速学会使用Jackson消息转换器并实现日期的全局格式化。
快速查阅
开始教程
一、全局日期格式化（基于自动配置）
关于日期格式化，很多人会想到使用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="@{/}" rel="external nofollow" >1.在页面中对日期格式化</a></h3>
<form th:object="${user}">
<input th:value="*{userId}" type="hidden">
账号：<input th:value="*{username}">
密码：<input th:value="*{password}" type="password">
时间：<input th:value="*{createTime}" type="text">
</form>
<form th:object="${user}">
账号：<input th:value="*{username}">
密码：<input th:value="*{password}" type="password">
时间：<input th:value="*{#dates.format(createTime,'yyyy-MM-dd HH:mm:ss')}">
</form>
<h3><a th:href="@{/user/json}" rel="external nofollow" >2.点击获取JSON信息</a></h3>
<h3><a th:href="@{/user/xml}" rel="external nofollow" >3.点击获取XML信息</a></h3>
</body>
</html>
启动项目后访问 http://localhost:8080 查看日期格式化效果：
四、小结
1、使用@ResponseBody会根据请求头信息来智能选择JSON/XML消息转换器。
2、通过重写HttpMessageConverter可以自定义消息转换器来实现全局日期格式化。
3、采用类似yyyy-MM-dd HH:mm:ss的日期格式更符合国人的阅读习惯，能够提升用户体验。
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。
相关文章
SpringMVC HttpMessageConverter报文信息转换器
这篇文章主要为大家介绍了SpringMVC HttpMessageConverter报文信息转换器，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2022-05-05
Spring Boot下如何自定义Repository中的DAO方法
这篇文章主要介绍了Spring Boot下如何自定义Repository中的DAO方法,需要的朋友可以参考下2017-06-06
以下教程是小编在参与开发公司的一个crm系统，整理些相关资料，在该系统中有很多消息推送功能，在其中用到了websocket技术。下面小编整理分享到脚本之家平台供大家参考2016-04-04
这篇文章主要为大家详细介绍了Java实现贪吃蛇游戏源码，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2020-11-11
这篇文章主要介绍了Java基础教程之封装与接口,本文用浅显易懂的语言讲解了Java中的封装与接口,很形象的说明了这两个面向对象术语,需要的朋友可以参考下2014-08-08
AOP（面向切面编程）技术可以高效地解决日志记录、事务管理、权限控制等问题,日志记录通过自定义注解和切面类,自动记录方法调用详情,减少重复代码,事务管理方面,通过AOP可以在不改变业务代码的情况下,实现事务的自动开启、提交和回滚,保证数据一致性2024-10-10
这篇文章主要为大家介绍了字符编码的处理和BeanUtils组件的使用详解,有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2022-09-09
这篇文章主要介绍了JAVA容器集合全面解析(Collection和Map)本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2021-08-08
springboot整合mybatis的超详细过程(配置模式+注解模式)
这篇文章主要介绍了springboot整合mybatis的详细过程(配置模式+注解模式),这里我使用的是配置模式+注解模式所以需要配置全局文件，本文通过实例代码给大家介绍的非常详细，需要的朋友可以参考下2022-04-04
学习java以来，都是以语法，类库入手，最基本的也是最基础的java编译过程往往被我遗忘，先解释一下学习java第一课时，都听到过的一句话，“java是半解释语言”。什么是半解释语言。本文将介绍Java文件被执行的历程。2021-06-06
最新评论