SpringBoot 全局日期格式化（基于HttpMessageConverter）

柔光的暖阳◎ 2024-04-19 09:22 9阅读 0赞

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

# 学习目标 #

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

# 快速查阅 #

专题阅读：[《SpringBoot 布道系列》][SpringBoot]

源码下载：[springboot-date-format][]

— Hey Man，Don't forget to Star or Fork . —

# 开始教程 #

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

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

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

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

那么有没更好的办法，既支持返回默认的日期格式，又支持解析复杂的日期字符串？  
答案是有的，只需要重写Jackson的消息转换器来支持解析复杂的日期格式即可。

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

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

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-thymeleaf</artifactId>
            </dependency>
            <dependency>
                <groupId>com.fasterxml.jackson.core</groupId>
                <artifactId>jackson-databind</artifactId>
            </dependency>
            <dependency>
                <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="@{/}">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][http_localhost_8080] 查看日期格式化效果：

## 四、小结 ##

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

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

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

转载于:https://my.oschina.net/abcijkxyz/blog/3057136

[SpringBoot]: https://www.jianshu.com/p/964370d9374e
[springboot-date-format]: https://github.com/yizhiwazi/springboot-socks/tree/master/springboot-date-format
[http_localhost_8080]: http://localhost:8080