12. Lombok插件的安装以及使用

LomboK介绍和配置(能用就用如果使用出问题就不要用)

1.目标

掌握LomboK的配置

2.路径

什么是LomboK
LomboK的作用
LomboK的配置

3.讲解

3.1什么是LomboK

Lombok是一个Java库，能自动插入编辑器并构建工具，简化Java开发。

官网: https://www.projectlombok.org/

3.2Lombok的作用

通过添加注解的方式，Lombok能以简单的注解形式来简化java代码，提高开发人员的开发效率。

例如开发中经常需要写的javabean，都需要花时间去添加相应的getter/setter，也许还要去写构造器、equals等方法，而且需要维护，当属性多时会出现大量的getter/setter方法，这些显得很冗长也没有太多技术含量，一旦修改属性，就容易出现忘记修改对应方法的失误。

而使用 Lombok 插件后，就不需要在代码里面写getter/setter/toString/HashCode等等方法，将会在编译后的class文件中自动添加，使代码看起来更简洁些。

3.3 Lombok的配置

3.3.1 添加maven依赖

Lombok插件的安装以及使用 — image-20201213235926585

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

3.3.2 安装插件

使用Lombok还需要插件的配合，我使用开发工具为idea. 打开idea的设置，点击Plugins，点击Browse repositories，在弹出的窗口中搜索lombok，然后安装即可.

另外，新版本的安装界面如下：

安装完了插件之后，基本就完成了。

可以开启服务，测试能否正常启动编译如下：

不过也有些时候会碰到编译时出错的情况，可以按照下面进行解决。

3.3.3 解决编译时出错问题

编译时出错，可能是没有enable注解处理器。Annotation Processors > Enable annotation processing。设置完成之后程序正常运行。

4.小结

Lombox: 就是一个工具, 简化java代码开发
Lombok环境

添加坐标
添加插件

Lombok的常用注解

1.目标

掌握Lombox的常用注解

2.路径

@Data
@Getter/@Setter
@ToString
@NoArgsConstructor, @AllArgsConstructor

3.讲解

3.1@Data

@Data注解在类上，会为类的所有属性自动生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。

3.1.1 在项目中创建 JavaBean，创建一个User类，并使用 @Data 注解

package com.bean;

import lombok.Data;

/**
 *
 * Data注解:
 * 可以添加get、set、toString、equals、hashcode等等方法
 * 
 * @author Aron.li
 * @date 2020/12/14 0:19
 */
@Data
public class User {
    private Integer id;
    private String username;
    private String password;
    private String address;
    private String nickname;
    private String gender;
    private String email;
    private String status;
}

3.1.2 创建一个单元测试，测试能否执行 get、set、toString、equals、hashcode等等方法

public class UserTest {

    @Test
    public void test01(){
        User user = new User();
        user.setUsername("肥子白");
        user.setNickname("fat boy");
        user.setEmail("381789@qq.com");

        System.out.println(user.getUsername());
        System.out.println(user);
    }

}

3.1.3 查看编译后生成的 class 文件，可以看到 Lombok 自动生成的代码

如果想要确认自动生成了什么，可以看编译后的 class 文件更加直观。

3.2@Getter/@Setter

如果觉得@Data太过粗暴不够精细，可以使用@Getter/@Setter注解，此注解在属性上，可以为相应的属性自动生成Getter/Setter方法.

3.2.1 针对某个属性进行 @Getter/@Setter注解

public class User implements Serializable {
    @Setter
    @Getter
    private Integer id;
    private String username;
    private String password;
    private String address;
    private String nickname;
    private String gender;
    private String email;
    private String status;
}

3.2.2 查看再次执行编译后的 class 文件

可以看到只生成了空参构造器，以及 id 的 getter/setter

3.3@ToString

类使用@ToString注解，Lombok会生成一个toString()方法，默认情况下，会输出类名、所有属性（会按照属性定义顺序），用逗号来分割。通过exclude属性指定忽略字段不输出,

3.3.1 @ToString 使用 exclude 指定忽略 id 字段不输出

@ToString(exclude = {"id"})
public class User implements Serializable {
    private Integer id;
    private String username;
    private String password;
    private String address;
    private String nickname;
    private String gender;
    private String email;
    private String status;
}

3.3.2 查看再次执行编译后的 class 文件

3.4@xxxConstructor

@NoArgsConstructor: 无参构造器

@NoArgsConstructor
public class User implements Serializable{
    private Integer id;
    private String username;
    private String password;
    private String address;
    private String nickname;
    private String gender;
    private String email;
    private String status;
}

@AllArgsConstructor: 全参构造器

@AllArgsConstructor
public class User implements Serializable{
    private Integer id;
    private String username;
    private String password;
    private String address;
    private String nickname;
    private String gender;
    private String email;
    private String status;
}

3.4.1 设置自动生成无参构造器以及全参构造器

@AllArgsConstructor
@NoArgsConstructor
@ToString(exclude = {"id"})
public class User implements Serializable {
    private Integer id;
    private String username;
    private String password;
    private String address;
    private String nickname;
    private String gender;
    private String email;
    private String status;
}