Springboot全局日期格式化

说在前边

最近部门几位同事受了一些委屈相继离职,共事三年临别之际颇有不舍,待一切手续办妥帖,寒暄过后送他们出公司,几个老哥临别时冲我鬼魅一笑,我顿时心里一紧有种不好的预感,这事绝对没有这么简单。等我接手这几个大佬的项目后,应验了我的预感,此刻我居然有点后悔,为啥送别之时没揍他们一顿!哈哈哈~ 而这种打人的冲动,在我开始优化几位老哥的项目时候,变得越来越强烈。

有个坑

技术部每个月都会组织一下代码走查及优化,以前是各自审查优化自己的项目,如今几位老哥的离职他们的项目就落到了我的头上。对于程序员来说最痛苦的事情就是接手别人的项目,还要做优化改造,因为这一点也不比重构一遍项目简单。不过,军令在前,没办法硬着头皮上吧!

第一个优化的点就让我有点崩溃,这几个大佬的技能能力很强,一直都是我学习的榜样,但在项目里几乎所有的日期格式化都这样用 SimpleDateFormat ,像如下代码这样实现,emm~ ,受过伤的男人怎么啥事都做的出来,哈哈哈~

SvcOrderDailyStatisticsPo orderDailyStatisticsPo =newSvcOrderDailyStatisticsPo();SimpleDateFormat dateFormat =newSimpleDateFormat("yyyy-MM-dd");DatestationTime = dateFormat.parse(dateFormat.format(svcWorkOrderPo.getPayEndTime()));orderDailyStatisticsPo.setStatisticalDate(stationTime);

而且项目中的时间和日期API用的也比较混乱,考虑到 java.util.Date 和 java.util.Calendar 不支持时区,且非线程安全,对于日期的计算相对繁琐,技术部一致要求用JDK1.8以后的 java.time LocalDateTime 。但不少人还是在用 java.util.Date 和 java.util.Calendar 处理日期。

优化方案

时间格式化是使用频率非常高的,如何让时间格式化变得既简单又不用重复造轮子,那么就应将它抽象出来,作为全局的日期格式化处理,下面就结合实践简单介绍下几种优化方案。

测试地址: http://127.0.0.1:8080/timeTest

@GetMapping("/timeTest")publicOrderInfotimeTest(){        OrderInfo order =newOrderInfo();        order.setCreateTime(LocalDateTime.now());        order.setUpdateTime(newDate());returnorder;    }

1、@JsonFormat注解

使用 @JsonFormat 注解格式化时间,应该算是一个基本操作了,大部分开发者都应用此种方式,简单方便。

/** *@Author: xiaofu *@Description: */publicclassOrderInfo{@JsonFormat(locale ="zh", timezone ="GMT+8", pattern ="yyyy-MM-dd HH:mm:ss")privateLocalDateTime createTime;@JsonFormat(locale ="zh", timezone ="GMT+8", pattern ="yyyy-MM-dd HH:mm:ss")privateDate updateTime;publicLocalDateTime getCreateTime() {returncreateTime;    }publicvoid setCreateTime(LocalDateTime createTime) {this.createTime = createTime;    }publicDate getUpdateTime() {returnupdateTime;    }publicvoid setUpdateTime(Date updateTime) {this.updateTime = updateTime;    }}

测试一下结果,发现 Date 类型和 LocalDateTime 类型都格式化成功,但还是有个问题,这样做仍然比较繁琐,每个实体类的日期字段都要加 @JsonFormat 注解,重复的工作量也不小。接着往下看~

2、全局配置 (1)

Springboot 已经为我们提供了日期格式化 ${spring.jackson.date-format:yyyy-MM-dd HH:mm:ss} ,这里我们需要进行全局配置,配置比较简单,也无需在实体类属性上添加 @JsonFormat 注解。

/** *@Author: xiaofu *@Description: */publicclassOrderInfo{//@JsonFormat(locale = "zh", timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")privateLocalDateTime createTime;//@JsonFormat(locale = "zh", timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")privateDate updateTime;publicLocalDateTimegetCreateTime(){returncreateTime;    }publicvoidsetCreateTime(LocalDateTime createTime){this.createTime = createTime;    }publicDategetUpdateTime(){returnupdateTime;    }publicvoidsetUpdateTime(Date updateTime){this.updateTime = updateTime;    }}

只需要用 @Configuration 定义一个配置类,注入两个 Bean 即可完成全局日期格式化处理,这种方式也是当前我项目中正在用的方式。

/** *@Author: xiaofu *@Description: */@ConfigurationpublicclassLocalDateTimeSerializerConfig{@Value("${spring.jackson.date-format:yyyy-MM-dd HH:mm:ss}")privateString pattern;@BeanpublicLocalDateTimeSerializer localDateTimeDeserializer() {returnnew LocalDateTimeSerializer(DateTimeFormatter.ofPattern(pattern));    }@BeanpublicJackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilderCustomizer() {returnbuilder -> builder.serializerByType(LocalDateTime.class, localDateTimeDeserializer());    }}

这种方式可支持 Date 类型和 LocalDateTime 类型并存,那么有一个问题就是现在全局时间格式是 yyyy-MM-dd HH:mm:ss ,但有的字段却需要 yyyy-MM-dd 格式咋整?

那就需要配合 @JsonFormat 注解使用,在特定的字段属性添加 @JsonFormat 注解即可,因为 @JsonFormat 注解优先级比较高,会以 @JsonFormat 注解标注的时间格式为主。

3、全局配置 (2)

这种全局配置的实现方式与上边的效果是一样的,不过,要注意的是使用这种配置后,字段手动配置 @JsonFormat 注解将不再生效。

/** *@Author: xiaofu *@Description: */publicclassOrderInfo{//@JsonFormat(locale = "zh", timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")privateLocalDateTime createTime;//@JsonFormat(locale = "zh", timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")privateDate updateTime;publicLocalDateTimegetCreateTime(){returncreateTime;    }publicvoidsetCreateTime(LocalDateTime createTime){this.createTime = createTime;    }publicDategetUpdateTime(){returnupdateTime;    }publicvoidsetUpdateTime(Date updateTime){this.updateTime = updateTime;    }}

/**

* @Author: xiaofu

* @Description:

*/@ConfigurationpublicclassLocalDateTimeSerializerConfig{@Value("${spring.jackson.date-format:yyyy-MM-dd HH:mm:ss}")privateStringpattern;@Bean@PrimarypublicObjectMapperserializingObjectMapper() {ObjectMapperobjectMapper =newObjectMapper();JavaTimeModulejavaTimeModule =newJavaTimeModule();        javaTimeModule.addSerializer(LocalDateTime.class,newLocalDateTimeSerializer());        javaTimeModule.addDeserializer(LocalDateTime.class,newLocalDateTimeDeserializer());        objectMapper.registerModule(javaTimeModule);returnobjectMapper;    }    publicclassLocalDateTimeSerializerextendsJsonSerializer<LocalDateTime>{@Overridepublic void serialize(LocalDateTimevalue,JsonGeneratorgen,SerializerProviderserializers)throwsIOException{            gen.writeString(value.format(ofPattern(pattern)));        }    }    publicclassLocalDateTimeDeserializerextendsJsonDeserializer<LocalDateTime>{@OverridepublicLocalDateTimedeserialize(JsonParserp,DeserializationContextdeserializationContext)throwsIOException{returnLocalDateTime.parse(p.getValueAsString(), ofPattern(pattern));        }    }}

总结

分享了一个 Springboot 项目开发过程中的一个小技巧,也顺便吐槽一下项目优化中遇到的坑,优化别的人的代码虽然是一件比较痛苦的事情,但在这个过程中确实能学习到很多技巧,对个人的技能提升也是很有帮助,因为都是些能够实实在在提高开发效率的干货。



原文 https://segmentfault.com/a/1190000022355979

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,417评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,921评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,850评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,945评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,069评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,188评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,239评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,994评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,409评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,735评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,898评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,578评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,205评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,916评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,156评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,722评论 2 363
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,781评论 2 351

推荐阅读更多精彩内容