Lombok基础介绍

雨点打透心脏的1/2处 2022-03-07 01:16 276阅读 0赞

**目录**

第一章 Lombok介绍与原理

第二章 Lombok引入项目

2.1 pom.xml中引入Lombok

2.2 在IDEA中安装Lombok

第三章 Lombok使用介绍

3.1 概要讲解

3.2 细化讲解

3.3 注意事项

第四章 实例

4.1 @Data

4.2 @EqualsAndHashCode(of="id")与ToString(exclude = "updateTime")

4.3 @Slf4j

--------------------

# 第一章 Lombok介绍与原理 #

介绍:Lombok是通过简单注解来精简代码达到消除冗长代码的目的,可以避免修改字段名字时忘记修改方法名.

原理:

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3E2MTAzNzY2ODE_size_16_color_FFFFFF_t_70][]

首先通过javac将源代码分析生成一棵抽象语法树AST,然后调用Lombok Annotation Processor,处理器对刚刚生成的AST进行处理,其调用Lombok Annotation Handler,其找到我们的注解(如@data)所在的类对应的语法树,接着修改该语法树,增加get,set节点.最后Lombok Annotation Processor输出一个修改过的抽象语法树,我们将拿到语法树进行解析和生成,就变成了我们的字节码文件.

# 第二章 Lombok引入项目 #

## 2.1 pom.xml中引入Lombok ##

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

## 2.2 在IDEA中安装Lombok ##

打开File->Settings搜索Lombok点击install,安装后重启即可.

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3E2MTAzNzY2ODE_size_16_color_FFFFFF_t_70 1][]

# 第三章 Lombok使用介绍 #

## 3.1 概要讲解 ##

@Data:加在类上,为类提供读写属性, 此外还提供了 equals()、hashCode()、toString() 方法

@Getter:自动生成get方法,

@Getter(AccessLevel.PROTECTED):生成的get方法是protected

@Setter:自动生成set方法,

@Setter(AccessLevel.PROTECTED):生成的set方法是protected

@NoArgsConstructor:类的无参构造器

@AllArgsConstructor:生成所有参数的构造器

@ToString:将类的所有属性进行ToString

@ToString(exclude="column"):将类的除去column属性进行ToString

@EqualsAndHashCode:类的Equals与HashCode方法将被自动重写.

@EqualsAndHashCode(exclude="column"):排除某几个属性其它的被自动重写

@Slf4j:logback日志框架:可以直接通过log调用Logger

@Log4j:当项目使用log4j日志框架时使用.

## 3.2 细化讲解 ##

这里面只是举了ToString的例子,EqualsAndHashCode同理.exclude上面讲了是排除,写两个就是排除两个,of是只要指定字段.

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3E2MTAzNzY2ODE_size_16_color_FFFFFF_t_70 2][]

@Data其实包含@Getter,@Setter,@ToString,@EqualsAndHashCode,不包含全参与无参构造.并且默认是所有字段,并且在使用@EqualsAndHashCode会显式增加一个protected权限的canEqual方法,里面通过instance of进行返回判断,返回值是一个布尔.

## 3.3 注意事项 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3E2MTAzNzY2ODE_size_16_color_FFFFFF_t_70 3][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3E2MTAzNzY2ODE_size_16_color_FFFFFF_t_70 4][]

# 第四章 实例 #

下面将注解后增加的代码进行展示(通过反编译来的)

## 4.1 @Data ##

get,set进行省略

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3E2MTAzNzY2ODE_size_16_color_FFFFFF_t_70 5][]

![20190316094112777.png][]

## 4.2 @EqualsAndHashCode(of="id")与ToString(exclude = "updateTime") ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3E2MTAzNzY2ODE_size_16_color_FFFFFF_t_70 6][]

equals中只用了id:

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3E2MTAzNzY2ODE_size_16_color_FFFFFF_t_70 7][]

toString中也没有updateTime

## 4.3 @Slf4j ##

![20190316094805612.png][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3E2MTAzNzY2ODE_size_16_color_FFFFFF_t_70]: /images/20220307/9230a74269514dd98d8962977222dd70.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3E2MTAzNzY2ODE_size_16_color_FFFFFF_t_70 1]: /images/20220307/41eabab8ac514fd8bfde5b91b9225aae.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3E2MTAzNzY2ODE_size_16_color_FFFFFF_t_70 2]: /images/20220307/afb0659188f6424bad238c217f2fcd7f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3E2MTAzNzY2ODE_size_16_color_FFFFFF_t_70 3]: /images/20220307/455b26ea6e4e44158dbbd462105d53df.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3E2MTAzNzY2ODE_size_16_color_FFFFFF_t_70 4]: /images/20220307/329e70ea3b0345f4a8408b185eeaf64b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3E2MTAzNzY2ODE_size_16_color_FFFFFF_t_70 5]: /images/20220307/5956af6390364b71b02397ee29d2b1c2.png
[20190316094112777.png]: /images/20220307/e97364b50cee4b5bb1587dbe1de3f844.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3E2MTAzNzY2ODE_size_16_color_FFFFFF_t_70 6]: /images/20220307/7063cefc5c5f4d2a833531afe796c9ec.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3E2MTAzNzY2ODE_size_16_color_FFFFFF_t_70 7]: /images/20220307/47fe5e8c044248a68d4af64d6611b7a6.png
[20190316094805612.png]: /images/20220307/dcc46cf313074d61b252931b49403441.png