Lombok简单使用

Lombok简介

Lombok是一个可以通过简单的注解形式来帮助我们简化消除一些必须有但显得很臃肿的Java代码的工具,通过使用对应的注解,可以在编译源码的时候生成对应的方法。

简单来说,我们平时开发过程中总是要花很多时间为Java Bean 去创建gettersetter方法,当类里面的属性很多时则创建的gettersetter就很多,代码就很长。而lombok就可以为我们省去创建gettersetter方法的麻烦,代码也会更加简洁。

Lombok官方地址: https://projectlombok.org/

使用方法

一、安装插件

操作步骤:File -> Settings... -> Plugins -> Browse repositories... -> 输入Lombok搜索并安装,安装完成后重启IntelliJ IDEA。

Idea设置页面
查找Lombok

二、引用jar包

如果是使用Maven构建项目,则添加以下依赖:

<dependencies>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.16.18</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

否则直接下载jar包并引入到项目中,下载地址为:下载Lombok

三、lombok使用

lombok的使用主要是通过注解方式,官网文档lombok注解 有很详细的说明。

@@NonNull

@NonNull为方法或构造函数的参数生成null检查语句,相当于if (param == null) throw new NullPointerException("param");;生成的null检查语句会插入到方法的最前端,如果是构造函数,则在this()super()调用之后插入null检查。

使用lombok,我们可以这样写:

import lombok.NonNull;

public class User extends BaseEntity {
  private String name;
  private String password;
  
  public User(@NonNull Person person) {
    super("Hello");
    this.name = person.getName();
    this.password = person.getPassword();
  }
}

而不使用lombok则是这样写:

import lombok.NonNull;

public class User extends BaseEntity {
  private String name;
  private String password;
  
  public User(@NonNull Person person) {
    super("Hello");
    if (person == null) {
      throw new NullPointerException("person");
    }
    this.name = person.getName();
    this.password = person.getPassword();
  }
}

@Getter/@Setter

使用@Getter/@Setter给字段注解,lombok会自动生成默认的getter/setter方法,在Intellij IDEA的Structure栏中可查看这个类的概要,就可以看到gettersetter方法已被添加到User类中:

getter和setter方法

在未指定字段修饰符情况下,lombok生成的getter/setter方法是public的,若要修改其修饰符可设置AccessLevel的值,如:

import lombok.AccessLevel;
import lombok.Getter;
import lombok.Setter;

public class User {

    private @Getter(AccessLevel.PRIVATE) @Setter String name;

    private @Getter @Setter String password;

}

此时能看到User类中的getName方法的图标变成了一个锁,说明getName方法已经是private的,将不会被公开:

getter方法设置AccessLevel

@ToString

使用@ToString会生成toString()方法,它会按顺序依次打印类名、字段;若想忽略输出字段,则可以用exclude设置参数;如果有继承父类,可以设置callSupertrue让其调用父类toString()方法:

@ToString(exclude = "password", callSuper = true)
public class User extends BaseEntity {

    private @Getter @Setter String name;

    private @Getter @Setter String password;

}

@EqualsAndHashCode

使用@EqualsAndHashCode会生成hashCode()equals()方法,默认会使用所有非静态、非transient字段;
如果想排除某些字段可设置exclude参数;
如果有继承父类,可以设置callSupertrue让其调用父类生成的equals()hashCode方法,但是当没有继承父类并设置callSupertrue时会在编译时报错:

import lombok.*;

@EqualsAndHashCode(exclude = "password")
public class User {

    private @Getter @Setter String name;

    private @Getter @Setter String password;

    @EqualsAndHashCode(callSuper = true)
    public static class Department extends BaseEntity {
        private @Getter @Setter String departmentName;
    }
}

在Intellij IDEA的Structure栏中可查看到有equals()hashCode()方法:

@EqualsAndHashCode

@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor

@NoArgsConstructor

生成一个无参数构造函数:

@NoArgsConstructor
@RequiredArgsConstructor

生成构造函数;如果带有参数,则该参数必须是以final修饰并未初始化的字段或@NonNull注解的并未初始化的字段,参数的顺序和字段在类中的声明顺序一致。

@NonNull注解并未初始化的:

@RequiredArgsConstructor

final修饰并未初始化的:

@RequiredArgsConstructor

正确和错误示例:

@RequiredArgsConstructor
@AllArgsConstructor

生成全参数构造函数,将类中的每个字段生成带有1个参数的构造函数,例如有3个字段,则构造函数的参数为3个:

@AllArgsConstructor

@Data

@Data包含了@ToString, @EqualsAndHashCode, @Getter, @Setter, @RequiredArgsConstructor的功能:

@Data

@Builder

@Builder为类、构造器、方法上生成复杂的构建器API;构造实例时,其属性不再需要单独set,可以通过以下方式进行实例化:
Person.builder().name("Adam Savage").city("San Francisco").job("Mythbusters").job("Unchained Reaction").build();

其他注解

val@Cleanup@SneakyThrows@Synchronized@Getter(lazy=true)@Logexperimental等就不再做介绍,用法和说明可查看官网文档https://projectlombok.org/features/all

总结

使用lombok能够为我们省去手动创建gettersetter方法的麻烦,lombok 有助于代码的整洁、效率的提高以及冗余的减少,但也同时降低了源代码文件的可读性和完整性。

不可过度依赖lombok。

参考

以简单的方式消除 Java 的冗长

Lombok features

lombok

原文地址:https://www.lwhweb.com/2017/11/08/lombok-use/

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

推荐阅读更多精彩内容