SpringBoot:使用TypeConvert实现类型String到LocalDate/LocalDateTime转换

在上一篇博客中我们有介绍过 springboot从request parameter中转换Data与Time, 相对于没那么多Controller中的方法需要转换的处理,上述提供的解决方案是比较直接且清晰的。

但是上述博客中提供的解决方案的缺点也比较明显,那就是我们需要对每个使用的方法处都加上@DateTimeFormat并配置相应的iso或者pattern属性值。

那有没有什么方式可以全局的解决这样的问题么,这就引入了这篇文章中我们讨论的spring的type converters。

还是以jdk8中的LocalDate 与 LocalDateTime 类型转换为例进行说明。

创建Type Converters

我们可以新建一个类,实现org.springframework.core.convert.converter.Converter<S, T>接口,其中S表示source源对象类型,T表示target目标对象类型。

String对象转换为LocalDate对象

  • 创建LocalDateConverter类
  • 实现Converter<S, T>接口,设置源对象类型为String,目标对象类型为LocalDate
  • 在LocalDateConverter类中新增一个私有的DateTimeFormatter成员变量
  • 新建一个构造器,传入一个dateFormat的格式化字符串,比如dd.MM.yyyy,用于生成DateTimeFormatter对象, 赋值给第三步定义的私有的DateTimeFormatter成员变量
  • 复写convert() 方法,具体逻辑如下所示
public final class LocalDateConverter implements Converter<String, LocalDate> {

    private final DateTimeFormatter formatter;

    public LocalDateConverter(String dateFormat) {
        this.formatter = DateTimeFormatter.ofPattern(dateFormat);
    }

    @Override
    public LocalDate convert(String source) {
        if (source == null || source.isEmpty()) {
            return null;
        }

        return LocalDate.parse(source, formatter);
    }
}

String对象转换为LocalDateTime对象

  • 创建LocalDateTimeConverter类
  • 实现Converter<S, T>接口,设置源对象类型为String,目标对象类型为LocalDateTime
  • 在LocalDateTimeConverter类中新增一个私有的DateTimeFormatter成员变量
  • 新建一个构造器,传入一个datetimeFormat的格式化字符串,比如dd.MM.yyyy HH:mm:ss.SSSZ,用于生成DateTimeFormatter对象, 赋值给第三步定义的私有的DateTimeFormatter成员变量
  • 复写convert() 方法,具体逻辑如下所示
public final class LocalDateTimeConverter implements Converter<String, LocalDateTime> {
 
    private final DateTimeFormatter formatter;
 
    public LocalDateTimeConverter(String dateFormat) {
        this.formatter = DateTimeFormatter.ofPattern(dateFormat);
    }
 
    @Override
    public LocalDateTime convert(String source) {
        if (source == null || source.isEmpty()) {
            return null;
        }
 
        return LocalDateTime.parse(source, formatter);
    }
}

上述Converter如何在springboot应用中生效

上述新增的LocalDateConverter 与LocalDateTimeConverter 需要经历如下几步才能在springboot应用中生效

  • 实现WebMvcConfigurer接口
  • 复写WebMvcConfigurer接口的addFormatters(FormatterRegistry registry) 方法
  • 在上述复写的方法内部逻辑中加入我们新增的LocalDateConverter 与LocalDateTimeConverter
@Configuration
public class WebMvcExtend implements WebMvcConfigurer {
    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverter(new LocalDateConverter("yyyy-MM-dd"));
        registry.addConverter(new LocalDateTimeConverter("yyyy-MM-dd'T'HH:mm:ss.SSS"));
    }
}

上述操作全部完成后,启动springboot应用,原先需要@DateTimeFormat注解进行处理才能正确转换的方法,现在可以使用全局的Converter进行处理,程序也能正常运行成功。

引用地址:https://www.petrikainulainen.net/programming/spring-framework/spring-from-the-trenches-using-type-converters-with-spring-mvc/

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

推荐阅读更多精彩内容