从本人微信公众号迁移到此
清和 清和小记 2020-05-15
之前因为Lombok插件的原因,导致我去引用其他应用API的时候发生了jira包冲突,所以组长明确要求不能使用Lombok插件,但是最近看部门其他组有同事在用,所以在网上查了下资料,整理了下Lombok的优缺点,弄个公众号也是主要起记录的作用
Lombok有什么好处?
Lombok是一个可以大量减少代码的工具, 在编译期为class文件注入getter或setter或toString等代码。
想在项目中使用Lombok,需要三个步骤:
一、支持Lombok插件的IDA
目前Lombok支持多种IDE,其中包括主流的Eclips、Intellji IDEA等
在IDE中安装方式如下:
File → Settings → Plugins,输入“lombok”,选中“install”进行安装即可,安装后需重启IDEA才能运行
二、导入相关依赖
Lombok 支持使用多重构建工具进行导入依赖,大部分使用maven导入的方式
如使用maven导入方式如下:
三、代码中使用注解
Lombok精简代码的方式主要是通过注解来实现,其中常用的有@Data、@Getter/@Setter等。
如使用@Data注解,即可简单的定义一个Bean:
使用@Data注解在类上,相当于同时使用了@ToString、@EqualsAndHashCode、@Getter、@Setter和@RequiredArgsConstrutor这些注解
自动帮忙给Bean中定义了toString、Getter、Setter等方法。
通过上面的例子,大家可以看到我们使用@Data注解大大减少了代码量,使代码非常简洁。这也是很多人喜欢用Lombok的主要原因。
但是,关于Lombok的使用,也有人有不同看法,因为很多人都使用过Lombok,对于他的优缺点都比较了解清楚,所以接下来我们说一下Lombok的使用会带来哪些问题。
Lombok有什么缺点
传染队友
因为Lombok的使用要求开发者一定要在IDE中安装对应的插件。
如果没有安装插件的话,使用IDE打开一个基于Lombok的项目的话会提示找不到方法等错误。导致项目编译失败。
也就是说,如果项目组中有一个人使用了Lombok,那么其他人就必须也要安装IDE插件。否则就没办法协同开发。
一般来说,对外打的jar包最好尽可能地减少三方包依赖,这样可以加快编译速度,也 能减少 版本冲突。一旦在resource包里用了lombok,别人想看源码也不得不装插 件。 而这种不在对外jar包中使用lombok仅仅是约定俗成,当某一天lombok第一次 被 引入 这个jar包时,新的感染者无法避免。
代码可读性,可调试性低
在代码中使用了Lombok,确实可以帮忙减少很多代码,因为Lombok会帮忙自动生成很多代码。
但是这些代码是要在编译阶段才会生成的,所以在开发的过程中,其实很多代码其实是缺失的。
在代码中大量使用Lombok,就导致代码的可读性会低很多,而且也会给代码调试带来一定的问题。
比如,我们想要知道某个类中的某个属性的getter方法都被哪些类引用的话,就呵呵了。
有坑
用Lombok让我们代码开发非常简洁方便,这就使很人对Lombok产生过度依赖。
在使用Lombok过程中,如果对于各种注解的底层原理不理解的话,很容易产生意想不到的问题
我们知道,当我们使用@Data定义一个类的时候,会自动帮我们生成equals()方法
但是如果只使用了@Data,而不使用@EqualsAndHashCode(callSuper=true)的话,会默认是@EqualsAndHashCode(callSuper=false),这时候生成的equals()方法只会比较子类的属性,不会考虑从父类继承的属性,无论父类属性访问权限是否开放。
这就可能得到意想不到的结果。
影响升级
因为Lombok对于代码有很强的侵入性,就可能带来一个比较大的问题,那就是会影响我们对JDK的升级。
按照如今JDK的升级频率,每半年都会推出一个新的版本,但是Lombok作为一个第三方工具,并且是由开源团队维护的,那么他的迭代速度是无法保证的。
那如果我们需要升级到某个新版本的JDK的时候,若其中的特性在Lombok中不支持的话就会受到影响。
还有一个可能带来的问题,就是Lombok自身的升级也会受到限制。
因为一个应用可能依赖了多个jar包,而每个jar包可能又要依赖不同版本的Lombok,这就导致在应用中需要做版本仲裁,而我们知道,jar包版本仲裁是没那么容易的,而且发生问题的概率也很高。
失去了封装的意义
以上的几个问题其实都是有办法可以避免的。但是有的人排斥使用Lombok还有一个重要的原因,那就是他会破坏封装性。
众所周知,Java的三大特性包括封装性、继承性和多态性。
如果我们在代码中直接使用Lombok,那么他会自动帮我们生成getter、setter 等方法,这就意味着,一个类中的所有参数都自动提供了设置和读取方法。
举个简单的例子,我们定义一个订单类:
我们知道,全部订单的订单数量、订单明细and总价格间前其实是有关联关系,如果要改的话是要一起改的。
但是,我们用了Lombok的@Data注解,对于totalOrderAmt 和 orderNumber这两个属性。虽然我们将它们定义成 private私有类型,但是提供了 public 的 getter、setter 方法。
外部可以通过 setter 方法随意地修改这两个属性的值。我们可以随意调用 setter 方法,来重新设置 totalOrderAmt、orderNumber 属性的值,这也会导致其跟 orderDetails 属性的值不一致。
而面向对象封装的定义是:通过访问权限控制,隐藏内部数据,外部仅能通过类提供的有限的接口访问、修改内部数据。所以,暴露不应该暴露的 setter 方法,明显违反了面向对象的封装特性。
好的做法应该是不提供getter/setter,而是只提供一个public的put方法,同时去修改totalOrderAmt, orderNumber 和orderDetails三个属性。
总结
综上,所以如果公司没有要求,想引用Lombok的时候一定要慎重
阅读 30
赞在看