[IntelliJ IDEA] 中Lombok插件的介绍和常见使用情景

介绍

在编写项目时，尤其是在类进行类内部成员字段封装时，需要编写大量的get/set方法，不仅写的麻烦，如果字段名发生改变就要进行修改，因此非常麻烦；因此使用Lombok就能解决这样的问题

Lombok是一种插件化注解API，是通过添加注解来实现的，然后在javac进行编译的时候，进行处理。

Java的编译过程可以分成三个阶段：

1. 所有源文件会被解析成语法树。
2. 调用注解处理器。如果注解处理器产生了新的源文件，新文件也要进行编译。
3. 最后，语法树会被分析并转化成类文件。

实际上在上述的第二阶段，会执行*lombok.core.AnnotationProcessor*，它所做的工作就是我们上面所说的，修改语法树

下载jar包，之后导入，转换为库，重启

@Getter
@Setter
@AllArgsConstructor
public class Student {
    private Integer sid;
    private String name;
    private String sex;
}

这个时候看到他的图标，就知道哪个是Lombok给他生成的

使用Lombok

由于知识有限，下文只列出本人经常用的；

• 通过添加@Getter和@Setter来为当前类的所有字段生成get/set方法，他们可以添加到类或是字段上，注意静态字段不会生成（会有，但是就是给生成个静态方法），final字段无法生成set方法

  我们还可以使用@Accessors来控制生成Getter和Setter的样式

  例

  @Accessors(fluent = true)
  

  之后会发现test.class变成这样；而不是直接get/set

  

• 通过添加@ToString来为当前类生成预设的toString方法

直接调用

System.out.println(t);test t = new test(1,"234567");
System.out.println(t);

输出

test(id=1, password=234567)

也可以选择性打印

@ToString(exclude = "id") //不包括id
@ToString(of = "id") //只包括id

也可排序打印

@ToString.Include(rank = 0, name = "account") //rank越大，排的越前；name为重命名
Integer id;
@ToString.Include(rank = 1)
String password;

• 通过添加@EqualsAndHashCode来快速生成比较和哈希值方法
• 通过添加@AllArgsConstructor和@NoArgsConstructor来快速生成全参构造和无参构造；如图所示

• 添加@RequiredArgsConstructor来快速生成参数只包含final或被标记为@NonNull的成员字段

• 使用@Data能代表@Setter、@Getter、@RequiredArgsConstructor、@ToString、@EqualsAndHashCode全部注解
  • 一旦使用@Data就不建议此类有继承关系，因为equal方法可能不符合预期结果（尤其是仅比较子类属性）
• 使用@Value与@Data类似，但是并不会生成setter并且成员属性都是final的
• 使用@SneakyThrows来自动生成try-catch代码块

代码

public class Main {
    @SneakyThrows(Exception.class)
    public static void main(String[] args) {
        test t = new test();
        System.out.println(t);
    }
}

• 使用@Cleanup作用与局部变量，在最后自动调用其close()方法（可以自由更换）

• 使用@Builder来快速生成建造者模式

  • 通过使用@Builder.Default来指定默认值
  • 通过使用@Builder.ObtainVia来指定默认值的获取方式

  看test.class

public class test {
    Integer id;
    String password;

    test(Integer id, String password) {
        this.id = id;
        this.password = password;
    }

    public static testBuilder builder() {
        return new testBuilder();
    }

    public testBuilder toBuilder() {
        return (new testBuilder()).id(this.id).password(this.password);
    }

    public String toString() {
        return "test(id=" + this.id + ", password=" + this.password + ")";
    }

    public static class testBuilder {
        private Integer id;
        private String password;

        testBuilder() {
        }

        public testBuilder id(Integer id) {
            this.id = id;
            return this;
        }

        public testBuilder password(String password) {
            this.password = password;
            return this;
        }

        public test build() {
            return new test(this.id, this.password);
        }

        public String toString() {
            return "test.testBuilder(id=" + this.id + ", password=" + this.password + ")";
        }
    }
}

ord);
}

    public String toString() {
        return "test.testBuilder(id=" + this.id + ", password=" + this.password + ")";
    }
}

}