Lombok简介、使用、工做原理、优缺点

1.Lombok简介
官方介绍

Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java.Never write another getter or equals method again, with one annotation your class has a fully featured builder, Automate your logging variables, and much more.

大概的意思：Lombok是一个Java库，能自动插入编辑器并构建工具，简化Java开发。经过添加注解的方式，不须要为类编写getter或eques方法，同时能够自动化日志变量。

简而言之：Lombok能以简单的注解形式来简化java代码，提升开发人员的开发效率。

2.Lombok使用
使用Lombok须要的开发环境Java+Maven+IntelliJ IDEA或者Eclipse(安装Lombok Plugin)

2.1添加maven依赖

springboot官网生成的依赖

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

　通常工程依赖

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

　

2.2安装插件
使用Lombok还须要插件的配合，我使用开发工具为idea，这里只讲解idea中安装lombok插件，使用eclipse和myeclipse的小伙伴和自行google安装方法。
打开idea的设置，点击Plugins，点击Browse repositories，在弹出的窗口中搜索lombok，而后安装便可。

 

 

 

2.3解决编译时出错问题
编译时出错，多是没有enable注解处理器。Annotation Processors > Enable annotation processing。设置完成以后程序正常运行。

 

 

 

2.4示例
下面举两个栗子，看看使用lombok和不使用的区别。

建立一个用户类

不使用Lombok

public class User implements Serializable {

    private static final long serialVersionUID = -8054600833969507380L;

    private Integer id;

    private String username;

    private Integer age;

    public User() {
    }

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", username='" + username + '\'' +
                ", age=" + age +
                '}';
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        User user = (User) o;
        return Objects.equals(id, user.id) &&
                Objects.equals(username, user.username) &&
                Objects.equals(age, user.age);
    }

    @Override
    public int hashCode() {
        return Objects.hash(id, username, age);
    }

}

使用Lombok

@Data
public class User implements Serializable {

    private static final long serialVersionUID = -8054600833969507380L;

    private Integer id;

    private String username;

    private Integer age;

}

　

编译源文件，而后反编译class文件，反编译结果以下图。说明@Data注解在类上，会为类的全部属性自动生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。

 

自动化日志变量

@Slf4j
@RestController
@RequestMapping(("/user"))
public class UserController {

    @GetMapping("/getUserById/{id}")
    public User getUserById(@PathVariable Integer id) {
        User user = new User();
        user.setUsername("风清扬");
        user.setAge(21);
        user.setId(id);

        if (log.isInfoEnabled()) {
            log.info("用户 {}", user);
        }

        return user;
    }

}

经过反编译能够看到@Slf4j注解生成了log日志变量（严格意义来讲是常量），无需去声明一个log就能够在类中使用log记录日志。

 

2.5经常使用注解
下面介绍一下经常使用的几个注解：

@Setter 注解在类或字段，注解在类时为全部字段生成setter方法，注解在字段上时只为该字段生成setter方法。
@Getter 使用方法同上，区别在于生成的是getter方法。
@ToString 注解在类，添加toString方法。
@EqualsAndHashCode 注解在类，生成hashCode和equals方法。
@NoArgsConstructor 注解在类，生成无参的构造方法。
@RequiredArgsConstructor 注解在类，为类中须要特殊处理的字段生成构造方法，好比final和被@NonNull注解的字段。
@AllArgsConstructor 注解在类，生成包含类中全部字段的构造方法。
@Data 注解在类，生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。
@Slf4j 注解在类，生成log变量，严格意义来讲是常量。private static final Logger log = LoggerFactory.getLogger(UserController.class);

3.Lombok工做原理
在Lombok使用的过程当中，只须要添加相应的注解，无需再为此写任何代码。自动生成的代码究竟是如何产生的呢？

核心之处就是对于注解的解析上。JDK5引入了注解的同时，也提供了两种解析方式。

运行时解析
运行时可以解析的注解，必须将@Retention设置为RUNTIME，这样就能够经过反射拿到该注解。java.lang.reflect反射包中提供了一个接口AnnotatedElement，该接口定义了获取注解信息的几个方法，Class、Constructor、Field、Method、Package等都实现了该接口，对反射熟悉的朋友应该都会很熟悉这种解析方式。

编译时解析
编译时解析有两种机制，分别简单描述下：

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执行的过程以下：

 

Lombok本质上就是一个实现了“JSR 269 API”的程序。在使用javac的过程当中，它产生做用的具体流程以下：

javac对源代码进行分析，生成了一棵抽象语法树（AST）
运行过程当中调用实现了“JSR 269 API”的Lombok程序
此时Lombok就对第一步骤获得的AST进行处理，找到@Data注解所在类对应的语法树（AST），而后修改该语法树（AST），增长getter和setter方法定义的相应树节点
javac使用修改后的抽象语法树（AST）生成字节码文件，即给class增长新的节点（代码块）
经过读Lombok源码，发现对应注解的实现都在HandleXXX中，好比@Getter注解的实如今HandleGetter.handle()。还有一些其它类库使用这种方式实现，好比Google Auto、Dagger等等。

4.Lombok的优缺点
优势：

能经过注解的形式自动生成构造器、getter/setter、equals、hashcode、toString等方法，提升了必定的开发效率
让代码变得简洁，不用过多的去关注相应的方法
属性作修改时，也简化了维护为这些属性所生成的getter/setter方法等
缺点：

不支持多种参数构造器的重载虽然省去了手动建立getter/setter方法的麻烦，但大大下降了源代码的可读性和完整性，下降了阅读源代码的温馨度————————————————版权声明：本文为CSDN博主「ThinkWon」的原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处连接及本声明。原文连接：https://blog.csdn.net/ThinkWon/article/details/101392808