Lombok 的使用

推荐博客

Lombok 看这篇就够了 - 知乎

安装插件

打开配置

如何使用

maven方式

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

gradle方式

dependencies {
    compile 'org.projectlombok:lombok:1.18.6'
}

注解说明

注解	注解位置	功能
@Data	类	提供类所有属性的 get 和 set 方法，此外还提供了equals、canEqual、hashCode、toString 方法。
@Setter	属性	为单个属性提供 set 方法; 注解在 类 上，为该类所有的属性提供 set 方法， 都提供默认构造方法。
@Getter	属性	为单个属性提供 get 方法; 注解在 类 上，为该类所有的属性提供 get 方法，都提供默认构造方法。
@Log4j	类	为类提供一个 属性名为 log 的 log4j 日志对象，提供默认构造方法。
@AllArgsConstructor	类	为类提供一个全参的构造方法，加了这个注解后，类中不提供默认构造方法了。
@NoArgsConstructor	类	为类提供一个无参的构造方法。
@EqualsAndHashCode	类	可以生成 equals、canEqual、hashCode 方法。
@NonNull	属性	自动产生一个关于此参数的非空检查，如果参数为空，则抛出一个空指针异常，也会有一个默认的无参构造方法。
@Cleanup	变量	可以保证此变量代表的资源会被自动关闭，默认是调用资源的 close() 方法，如果该资源有其它关闭方法，可使用 @Cleanup(“methodName”) 来指定要调用的方法，也会生成默认的构造方法
@ToString	类	可以生成所有参数的 toString 方法，还会生成默认的构造方法。
@RequiredArgsConstructor	类	使用类中所有带有 @NonNull 注解的或者带有 final 修饰的成员变量生成对应的构造方法。
@Value	类	生成含所有参数的构造方法，get 方法，此外还提供了equals、hashCode、toString 方法。
@SneakyThrows	方法	可以将方法中的代码用 try-catch 语句包裹起来，捕获异常并在 catch 中用 Lombok.sneakyThrow(e) 把异常抛出，可以使用 @SneakyThrows(Exception.class) 的形式指定抛出哪种异常，也会生成默认的构造方法。
@Synchronized	类/ 方法	效果和 synchronized 关键字相同，区别在于锁对象不同，对于类方法和实例方法，synchronized 关键字的锁对象分别是类的 class 对象和 this 对象，而 @Synchronized 的锁对象分别是 私有静态 final 对象 lock 和 私有 final 对象 lock，当然，也可以自己指定锁对象，此外也提供默认的构造方法。

常用操作

构造函数，自动构造 final 对象

@Slf4j
@RestController
@RequiredArgsConstructor(onConstructor = @__(@Autowired))
public class HelloController {
    private final Person person;

    @GetMapping("/test")
    public Person getPerson(){
       return this.person;
    }
}