Lombok 简单说明

刺骨的言语ヽ痛彻心扉 2022-06-10 04:44 249阅读 0赞

Lombok 注解在线帮助文档：[http://projectlombok.org/features/index][http_projectlombok.org_features_index].

## 常用的 Lombok 注解 ##

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Data</td> 
   <td>注解在类上；提供类所有属性的 getting 和 setting 方法，此外还提供了equals、canEqual、hashCode、toString 方法</td> 
  </tr> 
  <tr> 
   <td>@Value</td> 
   <td>用在类上，是@Data的不可变形式，相当于为属性添加final声明，只提供getter方法，而不提供setter方法</td> 
  </tr> 
  <tr> 
   <td>@Setter</td> 
   <td>注解在类上和属性上；为属性提供 setting 方法</td> 
  </tr> 
  <tr> 
   <td>@Getter</td> 
   <td>注解在类上和属性上；为属性提供 getting 方法</td> 
  </tr> 
  <tr> 
   <td>@NoArgsConstructor</td> 
   <td>注解在类上；为类提供一个无参的构造方法</td> 
  </tr> 
  <tr> 
   <td>@AllArgsConstructor</td> 
   <td>注解在类上；为类提供一个全参的构造方法</td> 
  </tr> 
  <tr> 
   <td>@ToString</td> 
   <td>生成 toString 方法</td> 
  </tr> 
  <tr> 
   <td>@Builder</td> 
   <td>用在类、构造器、方法上，为你提供复杂的builder APIs</td> 
  </tr> 
  <tr> 
   <td>@SneakyThrows</td> 
   <td>自动抛受检异常，而无需显式在方法上使用throws语句</td> 
  </tr> 
 </tbody> 
</table>

## 日志注解 ##

@Log：根据不同的注解生成不同类型的log对象，但是实例名称都是log，有六种可选实现类。

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@CommonsLog</td> 
   <td>log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);</td> 
  </tr> 
  <tr> 
   <td>@Log</td> 
   <td>log = java.util.logging.Logger.getLogger(LogExample.class.getName());</td> 
  </tr> 
  <tr> 
   <td>@Log4j</td> 
   <td>log = org.apache.log4j.Logger.getLogger(LogExample.class);</td> 
  </tr> 
  <tr> 
   <td>@Log4j2</td> 
   <td>log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);</td> 
  </tr> 
  <tr> 
   <td>@Slf4j</td> 
   <td>log = org.slf4j.LoggerFactory.getLogger(LogExample.class);</td> 
  </tr> 
  <tr> 
   <td>@XSlf4j</td> 
   <td>log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);</td> 
  </tr> 
 </tbody> 
</table>

## Lombok原理 ##

了解了简单的使用之后，现在应该比较好奇它是如何实现的。整个使用的过程中，只需要使用注解而已，不需要做其它额外的工作，那玄妙之处应该是在注解的解析上。  
    
JDK5引入了注解的同时，也提供了两种解析方式。

### 运行时解析 ###

运行时能够解析的注解，必须将 @Retention 设置为 RUNTIME ，这样可以通过反射拿到该注解。

### 编译时解析(Lombok使用) ###

编译时解析有两种机制:

1.Annotation Processing Tool

apt自JDK5产生，JDK7已标记为过期，不推荐使用，JDK8中已彻底删除，自JDK6开始，可以使用Pluggable Annotation Processing API来替换它，apt被替换主要有2点原因：

*  api都在com.sun.mirror非标准包下
 *  没有集成到javac中，需要额外运行

2.Pluggable Annotation Processing API

JSR 269，自JDK6加入，作为apt的替代方案，它解决了apt的两个问题，javac在执行的时候会调用实现了该API的程序，这样我们就可以对编译器做一些增强，这时javac执行的过程如下：

![这里写图片描述][SouthEast]