高效开发:Lombok的使用

·  阅读 130

文章目录

一、用注解代替三类样板代码

以前的Java项目中,充斥着太多不友好的代码:POJO的getter/setter/toString;异常处理;I/O流的关闭操作等等,这是三类最常见的样板代码,既没有技术含量,又影响着代码的美观,Lombok提供一种使用注解来代替这三类样板代码的处理方法。

二、Lombok的安装

2.1 引入相应的maven包

<dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.16.18</version>
      <scope>provided</scope>
</dependency>
复制代码

注意,Lombok的scope=provided,说明它只在编译阶段生效,不需要打入包中。事实正是如此,Lombok在编译期将带Lombok注解的Java文件正确编译为完整的Class文件。

2.2 添加IDE工具对Lombok的支持

IDEA中引入Lombok支持如下:

点击File-- Settings设置界面,安装Lombok插件:

在这里插入图片描述

点击File-- Settings设置界面,开启 AnnocationProcessors:

在这里插入图片描述

开启该项是为了让Lombok注解在编译阶段起到作用。

2.3 Lombok实现原理

自从Java 6起,javac就支持“JSR 269 Pluggable Annotation Processing API”规范,只要程序实现了该API,就能在javac运行的时候得到调用。

Lombok就是一个实现了"JSR 269 API"的程序。在使用javac的过程中,它产生作用的具体流程如下:

  1. javac对源代码进行分析,生成一棵抽象语法树(AST)
  2. javac编译过程中调用实现了JSR 269的Lombok程序
  3. 此时Lombok就对第一步骤得到的AST进行处理,找到Lombok注解所在类对应的语法树 (AST),然后修改该语法树(AST),增加Lombok注解定义的相应树节点
  4. javac使用修改后的抽象语法树(AST)生成字节码文件

三、Lombok注解的使用

3.1 POJO类常用注解

3.1.1 @Getter/@Setter + @ToString (最常用)

@Getter/@Setter: 作用类上,生成所有成员变量的getter/setter方法;作用于成员变量上,生成该成员变量的getter/setter方法。可以设定访问权限及是否懒加载等。

package com.kaplan.pojo;

import lombok.*;
import lombok.extern.log4j.Log4j;
@Getter
@Setter
public class TestDemo {
private String name;
private int age ; 
private String email;
private String address; 
private String password;

@Getter
@Setter
private boolean funny;
}
复制代码

@ToString:作用于类,覆盖默认的toString()方法,可以通过of属性限定显示某些字段,通过exclude属性排除某些字段。

在这里插入图片描述

3.1.2 @EqualsAndHashCode + @NonNull + @NoArgsConstructor(最常用)

@EqualsAndHashCode:作用于类,覆盖默认的equals和hashCode

@NonNull:主要作用于成员变量和参数中,标识不能为空,否则抛出空指针异常。
在这里插入图片描述

@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor:作用于类上,用于生成构造函数。有staticName、access等属性。staticName属性一旦设定,将采用静态方法的方式生成实例,access属性可以限定访问权限。

@NoArgsConstructor:生成无参构造器;

@RequiredArgsConstructor:生成包含final和@NonNull注解的成员变量的构造器;

@AllArgsConstructor:生成全参构造器

在这里插入图片描述

注意,@Data:作用于类上,是以下注解的集合:@Getter @Setter @ToString @EqualsAndHashCode @RequiredArgsConstructor

3.1.3 @Builder + @Log

@Builder:作用于类上,将类转变为建造者模式

@Log:作用于类上,生成日志变量。针对不同的日志实现产品,有不同的注解:

3.2 @Cleanup Finally块中关闭流

@Cleanup:自动关闭资源,针对实现了java.io.Closeable接口的对象有效,如:典型的IO流对象

在这里插入图片描述

编译后结果如下:

在这里插入图片描述

3.3 @SneakyThrows 异常捕获

@SneakyThrows:可以对受检异常进行捕捉并抛出,可以改写上述的main方法如下:

在这里插入图片描述

3.4 @Synchronized 同步方法

@Synchronized:作用于方法级别,可以替换synchronize关键字或lock锁,用处不大.

四、尾声

高效开发:Lombok的使用,完成了。

天天打码,天天进步。

分类:
后端
标签: