一、简介

　　lombok是一个可以通过简单的注解的形式来帮助我们简化消除一些必须有但显得很臃肿的 Java 代码的工具，简单来说，比如我们新建了一个类，然后在其中写了几个字段，然后通常情况下我们需要手动去建立getter和setter方法啊，构造函数啊之类的，lombok的作用就是为了省去我们手动创建这些代码的麻烦，它能够在我们编译源码的时候自动帮我们生成这些方法。

　　在项目中使用Lombok可以减少很多重复代码的书写。比如说getter/setter/toString等方法的编写。

 

二、Eclipse（IDE）添加 lombok

　　eclipse : 

　　ide：

 

三、maven 项目使用，导入maven依赖

　　普通项目使用

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

　　Spring Boot 中已经集成了lombok的依赖，不需要指定版本

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

 

四、注解使用

　　参考博客：

　　1、log 

　　　　多种注解，可以满足不同的日志系统的日志使用，Lombok提供了一些自定义配置项可以参看官方说明文档。

//@CommonsLog
private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);
//@JBossLog
private static final org.jboss.logging.Logger log = org.jboss.logging.Logger.getLogger(LogExample.class);
//@Log
private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName());
//@Log4j
private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class);
//@Log4j2
private static final org.apache.logging.log4j.Logger log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);
//@Slf4j
private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class);
//@XSlf4j
private static final org.slf4j.ext.XLogger log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);

　　2、@Getter 和 @Setter

　　　　该注解使用在类或者属性上，该注解可以使用在类上也可以使用在属性上。生成的getter遵循布尔属性的约定。例如：boolean类型的sex,getter方法为isSex而    不是getSex

　　　　在使用该注解时，会默认生成一个无参构造。和对应的getterhe setter方法 

 

　　3、@Data

　　　　该注解使用在类上，该注解会提供getter、setter、equals、canEqual、hashCode、toString方法。不带参数的构造方法　

　　　　该注解使用在类上，该注解是最常用的注解，它结合了@ToString，@EqualsAndHashCode， @Getter和@Setter。本质上使用@Data注解，类默认@ToString和@EqualsAndHashCode以及每个字段都有@Setter和@getter。该注解也会生成一个公共构造函数，可以将任何@NonNull和final字段作为参数。

　　　　虽然@Data注解非常有用，但是它没有与其他注解相同的控制粒度。@Data提供了一个可以生成静态工厂的单一参数，将staticConstructor参数设置为所需要的名称，Lombok自动生成的构造函数设置为私有，并提供公开的给定名称的静态工厂方法。

 

　　4、@NotNull

　　　　该注解使用在属性上，该注解用于属的非空检查，当放在setter方法的字段上，将生成一个空检查，如果为空，则抛出NullPointerException。 
　　　　该注解会默认是生成一个无参构造。 

 

　　5、@toString

　　　　该注解使用在类上，该注解默认生成任何非讲台字段以名称-值的形式输出。
　　　　1、如果需要可以通过注释参数includeFieldNames来控制输出中是否包含的属性名称。
　　　　2、可以通过exclude参数中包含字段名称，可以从生成的方法中排除特定字段。
　　　　3、可以通过callSuper参数控制父类的输出。

 

　　6、@EqualsAndHashCode

　　　　该注解使用在类上，该注解在类级别注释会同时生成equals和hashCode。 

 

　　7、@AllArgsConstructor

　　　　该注解使用在类上，该注解提供一个全参数的构造方法，默认不提供无参构造。 

 

　　8、@NoArgsConstructor

　　　　该注解使用在类上，该注解提供一个无参构造 

 

　　9、@RequiredArgsConstructor

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

 

　　10、@Value

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

 

　　11、@Cleanup

　　　　该注解使用在属性前，该注解是用来保证分配的资源被释放。在本地变量上使用该注解，任何后续代码都将封装在try/finally中，确保当前作用于中的资源被释放。默认@Cleanup清理的方法为close，可以使用value指定不同的方法名称。

 

　　12、@Synchronized

　　　　该注解使用在类或者实例方法上，Synchronized在一个方法上，使用关键字可能会导致结果和想要的结果不同，因为多线程情况下会出现异常情况。Synchronized
　　　　关键字将在this示例方法情况下锁定当前对象，或者class讲台方法的对象上多锁定。这可能会导致死锁现象。一般情况下建议锁定一个专门用于此目的的独立锁，而不是允许公共对象进行锁定。该注解也是为了达到该目的。

 

　　13、@SneakyThrows

　　　　该注解使用在方法上，这个注解用在 方法 上，可以将方法中的代码用 try-catch 语句包裹起来，捕获异常并在 catch 中用 Lombok.sneakyThrow(e) 把异常抛出，可以使用 @SneakyThrows(Exception.class) 的形式指定抛出哪种异常。该注解需要谨慎使用。详情参看官方介绍