Lombok注解@Getter @Setter详解

1.为什么强大

项目中经常使用bean，entity等类，绝大部分数据类类中都需要get、set、toString、equals和hashCode方法，尽管IDE工具都会帮我们生成。但自动生成这些代码后，如果bean中的属性一旦有修改、删除或增加时，需要重新生成或删除get/set等方法，给代码维护增加负担。而使用了lombok之后，就不需要编写或生成setter或getter等方法了，而使用lombok注解的方式，在编译生成的字节码文件中就会存在setter/getter等方法，这样就大大减少了代码量，方便了代码的维护。

2.安装lombok插件(如果不安装会报错，提示没有get set方法)

使用前需要安装lombok插件

IDEA插件安装地址：https://jingyan.baidu.com/article/0a52e3f4e53ca1bf63ed725c.html

Eclipse插件地址：https://jingyan.baidu.com/article/b7001fe1aaa0c30e7282dd8a.html

3.maven依赖

在使用lombok插件的时候，还要进行添加lombok的Maven依赖，代码示例：

<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<version>1.16.10</version>
</dependency>

4.常用注解

@Setter @Getter : 为相应属性添加get set方法

import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
import java.util.Date;
 
@Setter
@Getter
@ToString
public class User {
    private Integer id;
 
    private String name;
 
    private Integer age;
 
    private String sex;
 
    private Date birthday;
 
}

@NonNull:该注解在属性或者构造器上，lombok会自动生成一个非空声明，用于校验参数，避免空指针

import lombok.NonNull;
 
public class NonNullExample extends Something {
  private String name;
  
  public NonNullExample(@NonNull Person person) {
    super("Hello");
    this.name = person.getName();
  }
}

@Cleanup:该注解能帮助我们自动调用close()方法，很大程度简化代码可读性

import lombok.Cleanup;
import java.io.*;
 
public class CleanupExample {
  public static void main(String[] args) throws IOException {
    @Cleanup InputStream in = new FileInputStream(args[0]);
    @Cleanup OutputStream out = new FileOutputStream(args[1]);
    byte[] b = new byte[10000];
    while (true) {
      int r = in.read(b);
      if (r == -1) break;
      out.write(b, 0, r);
    }
  }
}

@EqualsAndHashCode:默认情况下，会使用所有非静态（non-static）和非瞬态（non-transient）属性来生成equals和hasCode，也能通过exclude注解来排除一些属性。

import lombok.EqualsAndHashCode;
 
@EqualsAndHashCode(exclude={"id", "shape"})
public class EqualsAndHashCodeExample {
  private transient int transientVar = 10;
  private String name;
  private double score;
  private Shape shape = new Square(5, 10);
  private String[] tags;
  private int id;
  
  public String getName() {
    return this.name;
  }
  
  @EqualsAndHashCode(callSuper=true)
  public static class Square extends Shape {
    private final int width, height;
    
    public Square(int width, int height) {
      this.width = width;
      this.height = height;
    }
  }
}

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

代替效果为：

@Override public String toString() {
      return "Square(
      super=" + super.toString() + ", 
      width=" + this.width + ", 
      height=" + this.height + 
      ")";
    }
}

@Data:注解在类上，会为类的所有属性自动生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。这个注解可是说是非常强大。

5.lombok工作原理

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

javac对源代码进行分析，生成了一棵抽象语法树（AST）
运行过程中调用实现了“JSR 269 API”的Lombok程序
此时Lombok就对第一步骤得到的AST进行处理，找到@Data注解所在类对应的语法树（AST），然后修改该语法树（AST），增加getter和setter方法定义的相应树节点
javac使用修改后的抽象语法树（AST）生成字节码文件，即给class增加新的节点（代码块）

6.总结

Lombok的使用通过注解的方式减少了getter，setter的手动增加减少了代码量，增加开发效率，特别是在改动属性名字时候维护起来也特别容易。但是同时它也减少了代码的可阅读性降低了源码的舒适度。