Lombok

发表于 更新于 分类于 阅读次数： 本文字数： 6.4k 阅读时长 ≈ 6 分钟

在实际开发过程中，不管是服务端（Java），还是客户端（Android）都需要创建对应的实例bean对象，用来实例化对象，在对需要实例化的对象中，通常需要写 set，get 方法，字段少的时候，还能忍受，尤其当客户端字段多的时候，而且字段类型或者字段名称来回改动时，稍不注意，就很大机率修改不全面，就会造成一些隐藏bug，有没有不需要手动取写（快捷键生成）这些方法，当然有，本片文章，我们就来学习 Lombok

Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java.
Never write another getter or equals method again, with one annotation your class has a fully featured builder, Automate your logging variables, and much more（Project Lombok是一个java库，可以自动插入编辑器并构建工具，为您的java增添色彩。 永远不要再写另一个getter或equals方法，使用一个注释，你的类有一个功能齐全的构建器，自动化你的日志记录变量等等），这是官方对Lombok的介绍，简单来讲就是通过注解的方式，代替一些重复性的代码，让代码更加简洁

安装集成

  • 编辑器（IDEA or Android Studio）安装 Lombok 插件，File -> Settings... -> Plugins -> 搜索 Lombok 并安装
  • 开启编辑器 Annotation Processors
  • 项目集成Lombok依赖，项目按照不同的包管理， 按照对应方式添加包依赖 
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    <!-- gradle 集成 -->
    <!-- https://projectlombok.org/setup/gradle -->
    repositories {
        mavenCentral()
    }

    dependencies {
        implementationOnly 'org.projectlombok:lombok:1.18.8'
        annotationProcessor 'org.projectlombok:lombok:1.18.8'
    }

    <!-- maven集成 -->
    <!-- https://projectlombok.org/setup/maven -->
    <dependencies>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.8</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>

稳定注解

Lombok提供稳定的注解，可以直接在生成环境使用，org.projectlombok.lombok包lombok路径下

val

val 作为任何局部变量声明类型（包含 for语句声明），并且该类型会推断初始化表达式的类型，同时也是final的。

  • 0.10版本加入该功能
  • 使用场景：局部变量声明
1
2
3
4
5
6
// x 将被推断为 double 类型，并且是final
val x = 10.0;
// y 将被推断为 ArrayList<String> 类型，并且是final
val y = new ArrayList<String>();
// z 将被转换为 final int z = 10;
val z = 10;

官方示例val

var

var 作为任何局部变量声明类型（包含 for语句声明），并且该类型会推断初始化表达式的类型。

  • 1.16.20版本加入该功能
  • 使用场景：局部变量声明
1
2
// x 将被推断为double，转换为 double x = 10.0d;
var x = 10.0;

官方示例var

@NonNull

注解在 属性 上，会自动产生一个关于此参数的非空检查，如果参数为空，则抛出一个空指针异常，也会有一个默认的无参构造方法

  • 0.11.10版本加入该功能
  • 支持字段，方法，参数，局部变量，枚举

官方示例@NonNull

@Cleanup

自动资源管理，安全地调用close（）方法，确保通过调用 close() 方法清除你注释的变量声明，无论发生声明情况

  • 支持局部变量
1
2
3
4
5
6
7
8
9
10
public void copyFile(String in, String out) throws IOException {
    @Cleanup FileInputStream inStream = new FileInputStream(in);
    @Cleanup FileOutputStream outStream = new FileOutputStream(out);
    byte[] b = new byte[65536];
    while (true) {
        int r = inStream.read(b);
        if (r == -1) break;
        outStream.write(b, 0, r);
    }
}

官方示例@Cleanup

@Getter/@Setter

  • 注解在 属性 上；为单个属性提供 set/get 方法;
  • 注解在 类 上，为该类所有的属性提供 set/get 方法， 都提供默认构造方法
  • 等级可自己更改 PUBLIC, MODULE, PROTECTED, PACKAGE, PRIVATE，默认Public
1
2
3
// 可手动设置字段的set方法为你需要的修饰类型
@Setter(AccessLevel.PROTECTED) 
private String name;

官方示例@Getter/@Setter

@ToString

任何 类 定义都可以用 @ToString 注释，让lombok生成 toString() 方法的实现。默认情况下，它会按顺序打印您的类名以及每个字段，并以逗号分隔

  • includeFieldNames，默认true：打印时包括每个字段的名称
  • callSuper，默认false：在输出中包含超类的实现的结果
  • doNotUseGetters，默认false：通常情况下，如果有可用的getter，那么就会调用它们。要禁止此操作并让生成的代码直接使用这些字段，请将其设置为true
  • onlyExplicitlyIncluded，默认false：仅包含用明确标记的字段和方法。通常，默认情况下包含所有（非静态）字段
1
2
3
4
5
6
7
8
// 排除该字段一同生成在 toString()方法中
@ToString.Exclude 
private int id;
// 配置在toString中呈现此成员的行为；如果在方法上，请在输出中包含方法的返回值
// rank(默认为0)：首先打印更高的等级。相同级别的成员按照它们在源文件中出现的顺序打印
// name(默认为"")：默认为带注释的成员的 字段/方法 名称。如果名称等于默认包含字段的名称，则此成员将取代它
@ToString.Include(rank = 0, name = "")
private int id;

官方示例@ToString

@EqualsAndHashCode

注解在 类 上, 可以生成 equals、canEqual、hashCode 方法，与 @Data 相比，少了 toString() 方法，部分属性和 @ToString 注解相同

官方示例@EqualsAndHashCode

Constructor

按照定制生成构造函数

  • @NoArgsConstructor：生成不带参数的构造函数
  • @RequiredArgsConstructor：生成带有必需参数的构造函数。参数是final字段和字段是具有约束的，例如@NonNull
  • @AllArgsConstructor：生成一个全参构造函数

官方示例Constructor

@Data

生成所有字段的 getter，一个有用的 toString 方法，以及检查所有 non-transient 字段的 hashCode 和 equals 实现。还将为所有 non-final 字段以及构造函数生成setter

官方示例@Data

@Value

@Value 是 @Data 的变体版，默认情况下，所有字段都是 private 和 final 的，并且不会生成setter，默认情况下，class 本身也是 final 的，因为不可变性不是可以强制进入子类的东西

  • 0.12.0版本加入稳定的该功能

官方示例@Value

@Builder

  • 对成员注解，则它必须是构造函数或方法
  • 对类（class）注解，那么将生成一个私有构造函数，所有字段都作为参数(就好像类上有@AllArgsConstructor(access = AccessLevel.PRIVATE))，并且这个构造函数已经被@Builder注释了

注意，只有当您没有编写任何构造函数，也没有添加任何显式的@XArgsConstructor注释时，才会生成这个构造函数。在这些情况下，lombok将假定存在一个all-args构造函数，并生成使用它的代码;这意味着如果没有这个构造函数，就会出现编译器错误。

官方示例@Builder

@SneakyThrows

  • 捕获或抛出方法主体中语句声明它们生成的任何已检查异常
  • SneakyThrows不会下沉，封装到RuntimeException中，或者以其他方式修改列出的已检查异常类型的任何异常
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// lombok 写法
@SneakyThrows(UnsupportedEncodingException.class)
public void utf8ToString(byte[] bytes) {
    return new String(bytes, "UTF-8");
}

// 等价于下面写法
public void utf8ToString(byte[] bytes) {
    try {
           return new String(bytes, "UTF-8");
       } catch (UnsupportedEncodingException $uniqueName) {
           throw useMagicTrickeryToHideThisFromTheCompiler($uniqueName);
           // This trickery involves a bytecode transformer run automatically during the final stages of compilation;
           // there is no runtime dependency on lombok.
       }
}

官方示例@SneakyThrows

@Synchronized

@Synchronized几乎与将“synchronized”关键字放在方法上完全一样，只不过它将同步到一个私有内部对象上，这样其他不在您控制之下的代码就不会通过锁定自己的实例来干扰线程管理

  • 对于 非静态 方法，使用一个名为 $lock 的字段
  • 对于 静态 方法，则注释会锁定名为 $LOCK 的静态字段

官方示例@Synchronized

@Getter(lazy=true)

适用于那些计算占用大量 CPU，或者占用较大内存时，该注解很有用

官方示例@GetterLazy

@Log

注解路径lombok.extern.java路径下，相关的 Log 有已下几种

  • @CommonsLog 
    1
    private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);
  • @Flogger 
    1
    private static final com.google.common.flogger.FluentLogger log = com.google.common.flogger.FluentLogger.forEnclosingClass();
  • @JBossLog 
    1
    private static final org.jboss.logging.Logger log = org.jboss.logging.Logger.getLogger(LogExample.class);
  • @Log 
    1
    private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName());
  • @Log4j 
    1
    private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class);
  • @Log4j2 
    1
    private static final org.apache.logging.log4j.Logger log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);
  • @Slf4j 
    1
    private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class);
  • @XSlf4j 
    1
    private static final org.slf4j.ext.XLogger log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);

官方示例@log

实验注解

Lombok提供实验性注解，请根据实际情况取舍，org.projectlombok.lombok包 lombok.experimental路径下

@Accessors

@ExtensionMethod

@FieldDefaults

@Delegate

@Wither

onX

  • onMethod
  • onConstructor
  • onParam

UtilityClass

Helper

FieldNameConstants

SuperBuilder

进阶配置

Configuration system

其他

如果在对Android项目进行升级使用 Lombok 代替原来的写法，在很大程度上还是会遇到如下截图问题
lombok-error
根据提示项目已经开启了 Annotation Processors，但是在每次打开项目都会提示错误信息

解决方法

Setting for all projects

  1. File -> Other Settings -> Settings for new projects -> Build, Execution, Deployment -> Compiler ->Annotation Processors
  2. Enable Annotation Processing
  3. Click Apply
  4. Restart Your Android studio

一些旧项目还需要额外的一些操作

  1. 删除项目根路径下的 yourProject.iml 文件以及 .idea 目录 或者你可以 File -> Invalidate Caches / Restart… 操作
  2. 重新打开项目

参考issues264