瑞当

瑞当科技
创新引领未来

Spring全局格式化日期

一、Spring全局日期格式化

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

spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
spring.jackson.timeZone: GMT+8
这种全局日期格式化最简单方便,但只适用于解析特定时间格式,如果业务中某接口返回long类型的时间戳,如此解析将抛出解析失败的异常。

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

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

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

第一步在项目引入JacksonThymeleaf等相关依赖:

       <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')}">