lombok相关

一、简述

lombok是一款在Java开发中简洁化代码的插件工具。使用lombok注解,目的就在于不用再去写一些反复的代码(如Getter,Setter,Constructor等)。

首先,用到的几个注解:

  • @Setter@Getter
  • @Data
  • @Log(这是一个泛型注解,具体有很多种形式)
  • @AllArgsConstructor
  • @NoArgsConstructor
  • @EqualsAndHashCode
  • @NonNull
  • @Cleanup
  • @ToString
  • @RequiredArgsConstructor
  • @Value
  • @SneakyThrows
  • @Synchronized

丑话说前头Lombok的五大弊端

Lombok的目的是减少代码的重复编写,并提供比较好的解决方案。当然也存在一些争议性的注解,可以根据实际场景选择使用。

1️⃣协同性要求较高,侵入性高
因为Lombok的使用要求开发者一定要在IDE中安装对应的插件。如果未安装插件的话,使用IDE打开一个基于Lombok的项目的话会提示找不到方法等错误。导致项目编译失败。也就是说,如果项目组中有一个人使用了Lombok,那么其他人就必须也要安装IDE插件。否则就没办法协同开发。更重要的是,如果定义的一个jar包中使用了Lombok,那么就要求所有依赖这个jar包的所有应用都必须安装插件,这种侵入性是很高的。

2️⃣代码可读性差,可调试性低。

在代码中使用了Lombok,确实可以帮忙减少很多代码,因为Lombok会帮忙自动生成很多代码。但是这些代码是要在编译阶段才会生成的,所以在开发的过程中,其实很多代码其实是缺失的。在代码中大量使用Lombok,就导致代码的可读性会低很多,而且也会给代码调试带来一定的问题。比如,想要知道某个类中的某个属性的getter方法都被哪些类引用的话,就没那么简单了。

3️⃣有坑

因为Lombok使代码开发非常简便,这就使得部分开发者对其产生过度依赖。在使用Lombok过程中,如果对于各种注解的底层原理不理解的话,很容易产生意想不到的结果。举一个简单的例子,当使用@Data定义一个类的时候,会自动生成equals()方法 。但是如果只使用了@Data,而不使用@EqualsAndHashCode(callSuper=true)的话,会默认是@EqualsAndHashCode(callSuper=false),这时候生成的equals()方法只会比较子类的属性,不会考虑从父类继承的属性,无论父类属性访问权限是否开放。这就可能得到意想不到的结果。

4️⃣影响升级

因为Lombok对于代码有很强的侵入性,就可能带来一个比较大的问题,那就是会影响对JDK的升级。按照如今JDK的升级频率,每半年都会推出一个新的版本,但是Lombok作为一个第三方工具,并且是由开源团队维护的,那么迭代速度是无法保证的。所以,如果需要升级到某个新版本的JDK的时候,若其中的特性在Lombok中不支持的话就会受到影响。还有一个可能带来的问题,就是Lombok自身的升级也会受到限制。因为一个应用可能依赖了多个jar包,而每个jar包可能又要依赖不同版本的Lombok,这就导致在应用中需要做版本仲裁,而jar包版本仲裁是没那么容易的,而且发生问题的概率也很高。

5️⃣破坏封装性

以上几个问题,我认为都是有办法可以避免的。但是有些人排斥使用Lombok还有一个重要的原因,那就是他会破坏封装性。众所周知,Java的三大特性包括封装性、继承性和多态性。如果在代码中直接使用Lombok,那么会自动生成getter、setter 等方法,这就意味着,一个类中的所有参数都自动提供了设置和读取方法。

面向对象封装的定义是:通过访问权限控制,隐藏内部数据,外部仅能通过类提供的有限的接口访问、修改内部数据。所以,暴露不应该暴露的 setter 方法,明显违反了面向对象的封装特性。

二、@Getter@Setter

该注解使用在类或者属性上。生成的getter遵循布尔属性的约定。例如:boolean类型的flag,getter方法为 isFlag() 而不是 getFlag()。在使用该注解时,会默认生成一个无参构造,和对应的 getter 和 setter 方法 。

三、@NonNull

该注解使用在属性上,该注解用于属性的非空检查,当放在setter方法的字段上,将生成一个空检查,如果为空则抛出NullPointerException。该注解会默认是生成一个无参构造。

四、@ToString

该注解使用在类上,该注解默认生成任何非静态字段以名称-值的形式输出。

  1. 如果需要可以通过注释参数includeFieldNames来控制输出中是否包含的属性名称。
  2. 可以通过exclude参数中包含字段名称,可以从生成的方法中排除特定字段。
  3. 可以通过callSuper参数控制父类的输出。

注意:父类也要有toString方法,不然打印的是对象内存地址

五、@EqualsAndHashCode

该注解使用在类上,会同时生成equalshashCode。注意继承关系的时候该注解的使用。存在继承关系需要设置callSuper参数为true。

六、@Data

该注解使用在类上,该注解会提供Getter、Setter、equals、canEqual、hasCode和toString等方法,注解后在编译时会自动加进去。该注解是最常用的注解,本质上使用@Data注解,类默认@ToString@EqualsAndHashCode以及每个字段都有@Setter@Getter。该注解也会生成一个公共构造函数,可以将任何@NonNull和final字段作为参数。

虽然@Data注解非常有用,但是它没有与其他注解相同的控制粒度。@Data提供了一个可以生成静态工厂的单一参数,将staticConstructor参数设置为所需要的名称,Lombok自动生成的构造函数设置为私有,并提供公开的给定名称的静态工厂方法。

七、@AllArgsConstructor

该注解使用在类上。该注解提供一个全参数的构造方法,默认不提供无参构造。

八、@NoArgsConstructor

该注解使用在类上。使用后创建一个无参构造函数。

九、@RequiredArgsConstructor

该注解使用在类上。使用类中所有带有@NonNull注解的或者带有 final 修饰的成员变量生成对应的构造方法。

十、 @Value

这个注解用在类上。会生成含所有参数的构造方法,get 方法。此外还提供了equals、hashCode、toString 方法。

注意:没有setter

十一、@Cleanup

该注解使用在属性前。该注解是用来保证分配的资源被释放。在本地变量上使用该注解,任何后续代码都将封装在try/finally中,确保当前作用于中的资源被释放。默认@Cleanup清理的方法为close,可以使用value指定不同的方法名称。

十二、@Synchronized

该注解使用在类或者实例方法上。Synchronized在一个方法上,使用关键字可能会导致结果和想要的结果不同,因为多线程情况下会出现异常情况。Synchronized
关键字将在this示例方法情况下锁定当前对象,或者class讲台方法的对象上多锁定。这可能会导致死锁现象。一般情况下建议锁定一个专门用于此目的的独立锁,而不是允许公共对象进行锁定。该注解也是为了达到该目的。

十三、@SneakyThrows

该注解使用在方法上。该注解可以将方法中的代码用 try-catch 语句包裹起来,捕获异常并在 catch 中用 Lombok.sneakyThrow(e)把异常抛出,可以使用 @SneakyThrows(Exception.class)的形式指定抛出哪种异常。该注解需要谨慎使用。

十四、Log(这是一个泛型注解,具体有很多种形式)

注解在类上。有如下选择可用:

//@CommonsLog
private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);
//@JBossLog
private static final org.jboss.logging.Logger log = org.jboss.logging.Logger.getLogger(LogExample.class);
//@Log
private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName());
//@Log4j
private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class);
//@Log4j2
private static final org.apache.logging.log4j.Logger log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);
//@Slf4j
private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class);
//@XSlf4j
private static final org.slf4j.ext.XLogger log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);

默认情况下,记录器的主题(或名称)将是使用注释进行@Log注释的类的类名称。这可以通过指定topic参数来定制。例如:@XSlf4j(topic="reporting")。该类型注解可以满足不同的日志系统的日志使用,Lombok提供了一些自定义配置项可以参看官方说明文档。

十五、@Builder Builder Pattern

关于Builder较为复杂一些,Builder的作用之一是为了解决在某个类有很多构造函数的情况,也省去写很多构造函数的麻烦,在设计模式Design Pattern中的思想是:用一个内部类去实例化一个对象,避免一个类出现过多构造函数。

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

推荐阅读更多精彩内容

  • Contents 介绍 安装idea 安装lombokeclipse安装lombok Lombok 注解@Gett...
    雨中星辰0阅读 3,293评论 0 2
  • 和其他语言相比, Java经常因为不必要的冗长被批评。 Lombok提供了一系列注解用以在后台生成模板代码,将其从...
    Java_Explorer阅读 7,974评论 0 3
  • 前言: 逛开源社区的时候无意发现的,用了一段时间,觉得还可以,特此推荐一下。 lombok 提供了简单的注解的形式...
    OzanShareing阅读 4,188评论 0 7
  • Lombok is one of the tools I literally always drop into m...
    jiangmo阅读 1,433评论 0 0
  • 背起了行囊 青年一路选择西行 他放下了亲人 别离了友人 毅然决然走向西北之北 荒芜的并非是边疆 而且无处安放的内心
    静默是余生阅读 123评论 0 1