BeanMappingKey,Java开发者们的福星!!!

和耳朵
English

背景

一切还要从我的上一家公司讲起,我的上一家公司是一家独角兽企业,说大不大说小不小的那种,公司氛围也是比较注重技术,我当时入职之后的第一课就是阅读我们 CTO 写的开发规范,其中他把 Java 项目的目录结构划分的非常清楚,大概是下面这个样子的:
image.png
我当时觉得这种分层结构划分的非常优雅与合理,当然以上只是一个大概,更细节的分层我没有表露,但是随之而来在实际中使用的过程中,这样一个三层结构也带来了一个问题,那就是对象传输非常麻烦,因为每层都会有一个特有的对象。

下面我举一个例子,假如我们要插入一个 User 对象,那么它可能要经过以下二次对象转换:
image.png

以上只是一个比较简单的例子,相信大家已经可以从中看出开发者们需要写一些很繁琐但是很没意思的代码(手动 get/set),比如上图中的三个对象可能字段都是一模一样的,但却需要重复写两次 Convert 去进行对象的转换。

当然这样设计当然也有好处,那就是解耦,比如我们现在用的数据库是 Mysql,如果要换成 Mongo 只需要把第二次对象转换的代码稍微修改一下即可,这也是这样设计的初衷。

常见方案

这么一个繁琐的事难道就没有一些方案进行解决吗?当然有,一般来说有两种方式:

  1. BeanUtil / JSONObject
  2. MapStruct

先来说第一种方式吧,无论 BeanUtil 是深拷贝还是浅拷贝,它对我们开发者来说细节都是不可见的,一旦某个字段赋值出现了问题,我们并没有办法去进行代码的排查,因为我们没办法查看对象转换的细节,JSONObject 也有相同的问题。

然后就是第二种方式,MapStruct 在前段时间是一个非常火的方案,它和 Lombok 非常类似,在代码编译期帮助我们去生成对象之间的转换代码,我们也可以通过 IDEA 的提示去查看编译后的代码,我司除了手动 get/set 代码,最多的就是使用 MapStruct 进行处理。

但是对我而言,MapStruct 还是有一些缺点,首先我的 IDEA 经常没有查看编译后代码的提示,其次就是如果转换对象的某个字段不一样的时候,需要学习 MapStruct 的一些用法进行处理,有一定的学习负担,反正我到现在都没学会😂。

我的方案

最终我为了方便,决定自己开发一个 IDEA 插件并起名为 BeanMappingKey,目前已经迭代到 1.X 版本,主要思想是通过插件的方式为我们需要转换的对象自动生成转换代码。

目前暂时有三种用法:

  1. 根据对象生成对应的 get/set 方法,支持建造者模式。
  2. 根据 Class 生成对应的 get/set 方法,支持建造者模式。
  3. 根据一个方法的入参和返回值,进行对象的转换代码生成,支持建造者模式。

其中,第一种和第二种生成起来是差不多的,具体可见以下例子:
GIF 2022-4-4 18-08-30.gif
GIF 2022-1-1 17-31-53.gif
上图的示例,是我们选中一个 Class 类进行代码的生成,根据这个类是否是建造者模式,来生成对应风格的代码,生成之后的代码被拷贝到剪贴板上,可以自由粘贴。

第二种方式,对于我来说是更加常用的,因为转换代码往往是写在一个方法里面的,通过选中方法名匹配入参和返回值进行代码生成,类似下面的例子:
GIF 2022-1-1 17-29-24.gif
匹配的逻辑就是根据字段名进行匹配,匹配失败的话则会留空,同时不只支持一个入参,可以对多个入参进行匹配,就像下面这样:
GIF 2022-4-4 20-35-56.gif


以上就是我对这个插件的介绍了,各位读者如果有兴趣的话可以在IDEA上面下载上试试:

  • Windows 系统上安装:

    • File > Settings > Plugins > Browse repositories... > Search for "BeanMappingKey" > Install Plugin
  • MacOS 系统上安装:

    • Preferences > Settings > Plugins > Browse repositories... > Search for "BeanMappingKey" > Install Plugin
  • 手动安装:

    • 下载 latest release 之后, 选择 Preferences > Plugins > Install plugin from disk...

注:暂且只支持 2020 以上版本的 IDEA,安装之后无需重启。

目前我的这个插件依然还在完善中,对于复杂类型支持的还不够完善,比如对象里面嵌套对象的情况,我打算下一阶段继续对这块痛点进行升级完善,下面是此插件的地址:


2022-06-06更新:插件更新 2.0 版本,已经支持对象嵌套的生成,欢迎大家在IDEA中下载使用。

阅读 3.1k

争做认真学习冠军
争做认真学习冠军
743 声望
5.4k 粉丝
0 条评论
743 声望
5.4k 粉丝
文章目录
宣传栏