Springboot学习：lombok 使用

一. lombok 简介

lombok 是一款开源的 java 组件，它可以简化我们实体类的代码，通过使用注解 @Get、@Set 或 @Data等属性，自动帮我们实现 set/get 方法。其主要的优点有：
1.通过在实体类添加注解 @Get、@Set ，自动帮我们实现bean 字段的 get/set 方法；
2.通过 @EqualsAndHashCode，实现 hashCode和 equal 的模板代码；
3.通过 @ToString 生成 toString() 的模板方法

二.idea 下安装 lombok

1. maven 依赖

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

2. idea lombok 插件安装
   setting–>plugin–>marketplace 搜索 lombok 插件进行安装
   
3. 启用 anntation 注解
   setting–>build–>anntationPro,勾选 anntationPro 选项
   

三.使用举例

新建 实体类 Grxx.java

@Entity
@Data
@NoArgsConstructor
@Table(name = "JC")
public class YcqJc {
	
    @Id
	@GeneratedValue
	private String jcLsh; 
	private String grJbxxId;
	private String xm;      
	private String zjlxdm;  
	private String zjhm;    
	private String csrq;    
	
}

在 实体类名上 使用 @Data 属性，编译后将自动产生 get/set 等 方法

四. lombok 注解说明

有哪些注解？
@Data
@Setter
@Getter
@Log4j
@AllArgsConstructor
@NoArgsConstructor
@EqualsAndHashCode
@NonNull
@Cleanup
@ToString
@RequiredArgsConstructor
@Value
@SneakyThrows
@Synchronized
注解详解
@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，当然，也可以自己指定锁对象，此外也提供默认的构造方法。

五.参考文档

参考：https://zhuanlan.zhihu.com/p/32779910