Java奇淫巧技之Lombok

奇淫巧技之Lombok

---

一、Lombok介绍

Lombok是一个可以通过简单的注解形式来帮助我们简化消除一些必须有但显得很臃肿的Java代码的工具，通过使用对应的注解，可以在编译源码的时候生成对应的方法。

二、开胃菜

这里演示Data annotation：

定义Result类，在Result在引用Data注解

import lombok.Data;

import java.io.Serializable;

@Data
public class Result implements Serializable {
    /**
     * 是否查询成功
     */
    private boolean success;
    /**
     * 回馈信息
     */
    private String message;
    /**
     * 响应结果代码
     */
    private String code;

}

从idea显示的类结构我们可以看出，Result编译后自动添加了get/set等方法

三、插件安装

在ide中使用Lombok需要安装插件，不然ide无法解析Lombok注解。

这里简单介绍两种idea的安装方式（如果已经打开ide，需要重启才能生效，idea需要把所有窗口关了重启）：

Eclipse：

下载lombok.jar，可以去官网下载也可以去maven repository下载（我这里使用的是maven项目下载下来的lombok.jar）

安装方式一（这种方式需要你的ide是安装的，不然可能找不到ide）：

java -jar lombok.jar

安装方式二（手动安装）：

打开Eclipse安装目录，找到eclipse.ini并打开，在文件末尾加上两句配置：

-Xbootclasspath/a:D:\DEVTOOLS\ApacheMavenRepositoryNew\org\projectlombok\lombok\1.16.18\lombok-1.16.18.jar
-javaagent:lombok-1.16.18.jar

配置描述：

-Xbootclasspath/a:lombok.jar的路径

-javaagent:lombok.jar的文件名

InterlliJ IDEA：

在File中找到Setting并打开

选中Plugins，点击Browse repositories

搜索Lombok

选中Lombok Plugin，点击右侧Install安装，然后重启idea就可以了（我这里已经安装过了，所有显示的是Update）

四、注解介绍

构造方法：

AllArgsConstructor

生成一个全参数的构造方法；

属性作用：

access：构造方法访问级别

NoArgsConstructor

生成一个无参构造方法，即默认构造方法

属性作用：

staticName：如果设置了这个属性，那么生成的构造方法访问级别将变成private，并提供一个方法名为staticName值的静态方法调用private构造方法

设置staticName

RequiredArgsConstructor:

生成一个包含常量和NonNull标识的字段的构造方法；

校验类

NonNull

非空校验，如果是给属性加上这个注解，那么，在使用RequiredArgsConstructor注解时，这个标注了NonNull注解的参数将被作为构造方法初始化，并且初始化参数不能为null（为null是抛出NullPointException）；

如果是给参数加上这个注解，那么将校验这个参数是否为null，为null则抛出Exception

日志类

JBossLog、Log4j、Slf4j等

生成一个当前类的日志对象

属性操作类

Getter/Setter

生成get/set方法，默认public，可以通过access属性控制方法访问级别

Accessors

主要用于控制如何生成Getter/Setter

属性作用：

fluent：控制生成的Getter/Setter方法是否带get/set，默认false

chain：是否支持链式调用，默认false，值为true时Setter方法返回当前对象，方便链式调用

其他

Builder

创建一个静态内部类，使用该类可以使用链式调用创建对象

ToString

生成toString方法，打印类名和每个字段

属性作用：

exclude：排除哪些字段

callSupper：是否调用父类的toString方法，默认false不调用

EqualsAndHashCode

生成equals和hashCode方法，默认情况下使用所有非静态非transisent字段

属性作用：

exclude：排除哪些字段

callSupper：是否调用父类的equals/hashCode方法，默认false不调用

Data

Data是一个“组合”类注解，包含ToString、EqualsAndHashCode、Getter、SetterRequiredArgsConstructor的功能

Synchronized

给方法加上同步锁，只能用于方法上

Delegate

注释在属性上时，会把这个属性对象的所有非静态的public方法合到当前类

更多注解内容