Lombok插件的安装与使用

Lombok插件的安装与使用

下载插件

Lombok 插件提供了一些注解，可以让我们不用再去手动实现 get、set、toString 等方法，十分方便快捷。

在 IDEA 中下载这个插件非常的简单，一共是三步：

1. 在菜单栏点击 “File”->“Setting”
2. 在设置中侧边栏点击 “plugin”，在其搜索框中搜索“Lombok”
3. 第一个就是要安装的“Lombok”插件，点击安装即可

常用注解

Lombok 中常用的四个注解：

• @Data：作用于类上，是以下注解的集合：@ToString @EqualsAndHashCode @Getter @Setter @RequiredArgsConstructor
• @NoArgsConstructor：生成无参构造器
• @AllArgsConstructor：生成全参构造器
• @NonNull：作用于成员变量和参数中，标识不能为空

一般我们都是使用的 @Data 注解，这样 get、set、tostring、构造函数就都有了，这样可以满足大部分实体类的需要。

简单使用

Lombok的使用需要在项目的 pom.xml 中添加依赖（目前的最新版是2020年2月更新的1.18.12版本）

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

然后我们新建一个 Java 实体类，在类上标注 @Data 注解，就不用再去实现 Get and Set 等等方法了。

import lombok.Data;

@Data
public class User {
    private int id;
    private String name;
    private String pwd;
}

以下的 Java 类编写在实际使用中基本上与之等价，从中可以看出 Lombok 插件的方便好用。

public class User {
    private int id;
    private String name;
    private String pwd;

    public User() {
    }

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

    public int getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getPwd() {
        return pwd;
    }

    public void setPwd(String pwd) {
        this.pwd = pwd;
    }
}

这里需要注意一个要点，虽然 @Data 注解会自动添加无参构造方法，但是如果我们添加了 @AllArgsConstructor 生成全参构造器后，无参构造方法会被覆盖。为了方便我们之后使用无参构造方法，我们还需要添加 @NoArgsConstructor 注解生成无参构造器。

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private int id;
    private String name;
    private String pwd;
}