作者:yizhiwazi

学习目标

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

开始教程

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

jspinput时间格式化SpringBoot 全局日期格局化基于HttpMessageConverter SQL

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

spring.jackson.date-format=yyyy-MM-dd HH:mm:ssspring.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代码

/ 用户管理 /@RestControllerpublic 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=\"大众@{/}\"大众>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}\"大众>2.点击获取JSON信息</a></h3><h3><a th:href=\"大众@{/user/xml}\"大众>3.点击获取XML信息</a></h3></body></html>

启动项目后访问 http://localhost:8080 查看日期格式化效果:

四、小结

1、利用@ResponseBody会根据要求头信息来智能选择JSON/XML转换器。

2、通过重写HttpMessageConverter可以自定义转换器来实现全局日期格式化。

3、采取类似yyyy-MM-dd HH:mm:ss的日期格式更符合国人的阅读习气,能够提升用户体验。