Lombok 初体验

背景

在阅读 sharding-sphere 源代码时，看到其中使用了 Lombok 库。同时，在别的两三个源码中，也看到了这个库的身影。

Lombok 库最大的优点是使用注解来减少重复代码，再也不用写 getter, equals 等代码了。

Lombok 库的官方网站为 projectlombok，其源代码托管在 github 上。

本文来记录一下 Lambok 库的使用。

安装

eclipse

1. 下载 lombok.jar 包
2. 双击 jar 包：会自动找到 eclipse，然后自动安装
3. 重启 eclipse
4. 在 eclipse 的 about 页面可以看到 Lombok v1.18.0 "Envious Ferret" is installed. https://projectlombok.org/，说明安装成功

Jetbrains IntelliJ IDEA

1. Preferences > Plugins
2. Browse repositories...
3. 搜索 Lombok Plugin
4. 点击 Install plugin
5. 重启 IntelliJ IDEA

第一个例子

pom 依赖

目前，最新稳定为 1.8，引入依赖：

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.0</version>
        </dependency>

类 Getter/Setter

字段 Getter/Setter
Lombok 的特征
常用的

@Getter: 可用在类上，或者单个类字段上。
@Setter: 可用在类上，或者单个类字段上。
@ToString
@EqualsAndHashCode

ToString

includeFieldNames: 是否包含字段名称
exclude: 排除字段
callSuper: 输出父类字段，默认为 false

构造函数

@AllArgsConstructor: 包含所有字段的构造函数，参数顺序与字段定义顺序一致。如果和 NotNull 注解联用，则会检验是否为空。
@NoArgsConstructor: 无参构造函数
@RequiredArgsConstructor: 生成包含 final 和 @NotNull 字段的构造方法。

@Data
组合注解: @Getter @Setter @RequiredArgsConstructor @ToString @EqualsAndHashCode
日志

@Log
@Log4j
@Log4j2
@Slf4j
@CommonsLog
@JBossLog
@Flogger: A Fluent Logging API for Java @Google, Google 内部的日志系统。
@XSlf4j: 适用于追踪应用执行路径, 详情点链接进去看。

示例如下：
//@Log
private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(Book.class.getName());

//@Log4j
private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(Book.class);

//@Log4j2
private static final org.apache.logging.log4j.Logger log = org.apache.logging.log4j.LogManager.getLogger(Book.class);

//@Slf4j
private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(Book.class);

//@CommonsLog
private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(Book.class);

//@JBossLog
private static final org.jboss.logging.Logger log = org.jboss.logging.Logger.getLogger(Book.class);

//@Flogger
private static final com.google.common.flogger.FluentLogger log = com.google.common.flogger.FluentLogger.forEnclosingClass();

//@XSlf4j
private static final org.slf4j.ext.XLogger log = org.slf4j.ext.XLoggerFactory.getXLogger(Book.class);

Builder
bulder 模式构建对象。如上面的示例，可为：
@Cleanup
自动化关闭流，相当于 jdk1.7 种的 try with resource
示例
@Cleanup 
InputStream in = new FileInputStream(args[0]);
@Cleanup 
OutputStream out = new FileOutputStream(args[1]);

默认的清理方法为 close，可以通过 value 来指定不同的清理方法。
类型推导

var: 可变变量，相当于普通的变量.
val: 只读变量，相当于 final.

@NonNull
变量不能为 null，否则报空指针异常。如
public NonNullExample(@NonNull Person person) {
    this.name = person.getName();
}

对应的为：
public NonNullExample(@NonNull Person person) {
    if (person == null) {
        throw new NullPointerException("person");
    }
    this.name = person.getName();
}

@Value
用在类上，生成含所有参数的构造方法，get 方法，此外还提供了 equals、hashCode、toString 方法。
但是不生成 set 方法。
@SneakyThrows
将异常包装为 RuntimeException，在运行时抛出。如：
    @SneakyThrows(UnsupportedEncodingException.class)
    public String byte2String(byte[] bytes) {
        return new String(bytes, "UTF-8");
    }

@Synchronized
同步执行，基本相当于在方法前加了 synchronized 关键字的效果，实际上是使用的内部对象做的同步。
对于非静态方法，使用 $lock 字段；对于静态方法，使用 $LOCK 字段。
@Getter(lazy=true)
在实际使用到 cached 的时候生成 cached，同时，Lombok 会自动去管理线程安全的问题，不会存在重复赋值的问题。
示例：
    @Getter(lazy = true)
    private final double[] cached = expensive();

    private double[] expensive() {
        double[] result = new double[1000000];
        for (int i = 0; i < result.length; i++) {
            result[i] = Math.asin(i);
        }
        return result;
    }

experimental
@FieldNameConstants
FieldNameConstants 官方文档
从
import lombok.experimental.FieldNameConstants;
import lombok.AccessLevel;

@FieldNameConstants
public class FieldNameConstantsExample {
    private final String iAmAField;
    @FieldNameConstants(level = AccessLevel.PACKAGE)
    private final int andSoAmI;
}

到
public class FieldNameConstantsExample {
    public static final String FIELD_I_AM_A_FIELD = "iAmAField";
    static final String FIELD_AND_SO_AM_I = "andSoAmI";

    private final String iAmAField;
    private final int andSoAmI;
}

@Singular
Singular 官方文档
@Delegate
Delegate 官方文档
@Accessors
Accessors 官方文档
@Wither
Wither 官方文档
参考

Lombok experimental features
学习 Spring Boot：（十五）使用 Lombok 来优雅的编码
Lombok 介绍
Lombok 之 @Getter(lazy=true)
IntelliJ IDEA Lombok Plugin