Lombok

IDEA 安装 Lombok 插件

在 pom 文件里面添加 dependency

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

常用注解

• @Data

  注在类上，提供类的 get、set、equals、hashCode、canEqual、toString 方法

• @Setter

  注在属性上，提供 set 方法

• @Getter

  注在属性上，提供 get 方法

• @ToString

  注在属性上，提供 toString 方法

• @AllArgsConstructor

  注在类上，提供类的全参构造

• @NoArgsConstructor

  注在类上，提供类的无参构造

• @EqualsAndHashCode

  注在类上，提供对应的 equals 和 hashCode 方法

• @NonNull

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

• @RequiredArgsConstructor

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

• @Value

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

• @Cleanup

  这个注解用在 变量 前面，可以保证此变量代表的资源会被自动关闭，默认是调用资源的 close() 方法，如果该资源有其它关闭方法，可使用 @Cleanup(“methodName”) 来指定要调用的方法，也会生成默认的构造方法

• @Log4j/@Slf4j

  注在类上，提供对应的 Logger 对象，变量名为 log

• @Synchronized

  这个注解用在 类方法 或者 实例方法 上，效果和 synchronized 关键字相同，区别在于锁对象不同，对于类方法和实例方法，synchronized 关键字的锁对象分别是类的 class 对象和 this 对象，而 @Synchronized 的锁对象分别是 私有静态 final 对象 lock 和 私有 final 对象 lock，当然，也可以自己指定锁对象，此外也提供默认的构造方法。

• @SneakyThrows

  这个注解用在 方法 上，可以将方法中的代码用 try-catch 语句包裹起来，捕获异常并在 catch 中用 Lombok.sneakyThrow(e) 把异常抛出，可以使用 @SneakyThrows(Exception.class) 的形式指定抛出哪种异常，也会生成默认的构造方法。

• @Builder

  lombok还可以方便的时间建造者模式。

• @Slf4j

  slf4j 是一个日志标准，使用它可以完美的桥接到具体的日志框架，必要时可以简便的更换底层的日志框架，而不需要关心具体的日志框架的实现（slf4j-simple、logback等）。

  slf4j提供了日志接口、获取具体日志对象的方法，常见用法：

  private static final Logger logger = LoggerFactory.getLogger(LoggerTest.class);
  logger.debug("debug");
  logger.info("info");
  logger.error("error");
  

  每次写新的类，就需要重新写 logger，麻烦，可以使用@Slf4j注解简化。

利与弊

利：Lombok最大的好处就在于通过注解的形式来简化Java代码。减少大量的模板代码，一定程度提高代码可读性，可以专注于查看类的属性。
弊：维护是个问题，其他人需要阅读代码时也需要安装 Lombok 插件，同时代码的可读性也不强，况且现在 IDEA 快捷键可以自动生成 getter、setter 等方法。