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

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

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

学习目标

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

快速查阅

源码下载：SpringBoot-Date-Format

开始教程

一、全局日期格式化（基于自动配置）

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

spring.jackson.date-format=yyyy-MM-dd HH:mm:ss

spring.jackson.timeZone: GMT+8

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

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

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

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

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

org.springframework.boot

spring-boot-starter-web

org.springframework.boot

spring-boot-starter-thymeleaf

com.fasterxml.jackson.core

jackson-databind

com.fasterxml.jackson.dataformat

jackson-dataformat-xml

true

然后根据 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 MappingJackson2Httphttp://MessageConverter 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 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。

例如：

三、测试日期格式化

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

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());

}

}

页面代码：

账号：

密码：

时间：

账号：

密码：

时间：

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

四、小结

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

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

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

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。