Lombok学习总结

Lombok概述

Lombok(lombok官网)项目是一个Java库，它会自动插入编辑器和构建工具中，Lombok提供了一组有用的注释，用来消除Java类中的大量样板代码。仅五个字符(@Data)就可以替换数百行代码从而产生干净，简洁且易于维护的Java类。

Lombok的优点

1.提高编码系效率
2.使代码更简洁
3.消除冗余代码
4.避免修改字段名时忘记修改方法名
5.生成日志变量

Lombok原理

1.javac从java6开始支持“JSR 269 API”规范
2.只要程序实现该API，就能在javac运行的时候得到调用
3.Lombok也实现了"JSR 269 API"

在编译时,javac编译源码的具体流程如下:

1.javac对源代码分析
2.生成抽象语法树AST
3.调用实现了"JSR 269 API"规范的Lombok程序(lombok Annotation Processor)
4.lombok程序对AST进行处理
5.lombok Annotation Handler 找到lombok相应注解对应语法树
6.然后修改该语法树,拿到修改后的语法树进行解析和生成
7.得到字节码文件

Lombok的使用

项目添加Lombok

在项目中引入lombok依赖坐标

<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.12</version>
    <scope>provided</scope>
</dependency>

<scope>provided</scope> 加不加无所谓,加上表示编译时不会打进War中

IDEA/Eclipse安装Lombok插件

IDEA

file => settings=> plugins搜索lombok安装即可

Eclipse

官网有各种IDES的安装方法官网下载

下载Jar后双击安装即可，若安装失败则可能是权限不够，解决方法：

1.Windows下右键管理员打开lombok.jar

2.Mac/Linux 打开控制台进入jar目录执行 sudo java -jar lombok.jar

Lombok注解

	@Setter ：注解在类或字段，注解在类时为所有字段生成setter方法，注解在字段上时只为该字段生成setter方法。
	@Setter (AccessLevel.PRIVATE) ：生成私有方法
	
	@Getter ：使用方法同上，区别在于生成的是getter方法。
	@Getter(AccessLevel.PRIVATE) ：生成私有方法
	
	@ToString ：注解在类，添加toString方法。
	@ToString (exclude="column")： 生成toString时排除某个字段
	@ToString (exclude="{column1,column2}")： 生成toString时排除多个字段
	@ToString (of="column")： 生成toString时指定某个字段
	@ToString (of="{column1,column2}")： 生成toString时指定多个字段
	
	@EqualsAndHashCode： 注解在类，生成hashCode和equals方法。
	@EqualsAndHashCode(exclude="column") : 排除某个属性不参与equals和hashCode
	@EqualsAndHashCode(of="column") 
	@EqualsAndHashCode(exclude="{column1,column2}")
	@EqualsAndHashCode(of="{column1,column2}")

	@NoArgsConstructor： 注解在类，生成无参的构造方法。
	
	@RequiredArgsConstructor： 注解在类，为类中需要特殊处理的字段生成构造方法，比如final和被@NonNull注解的字段。
	
	@AllArgsConstructor： 注解在类，生成包含类中所有字段的构造方法。
	
	@Data： 注解在类，生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。
	@Data包含: @Getter @Setter @ToString @EqualsAndHashCode
	
	@Slf4j： 注解在类，生成log变量，严格意义来说是常量。
	@Slf4j： 使用logback日志框架时使用@slf4j
	@Log4j： 使用log4j日志框架时使用@Log4j

反编译验证Lombok生成的代码

反编译工具下载

编写类,生成getter setter 有参/无参 toString排除rcode属性:

	@Getter
	@Setter
	@NoArgsConstructor
	@AllArgsConstructor
	@ToString(exclude = "rcode")
	public class Role implements Serializable {
	    private static final long serialVersionUID = -4604675020932688771L;
	    private Integer id;
	    private String rname;
	    private String rcode;
	    private Set<User> users;
	    private Set<Permission> permissions;
	    
	}

使用反编译工具打开该字节码文件:

	public class Role implements Serializable {
	  private static final long serialVersionUID = -4604675020932688771L;
	  
	  private Integer id;
	  
	  private String rname;
	  
	  private String rcode;
	  
	  private Set<User> users;
	  
	  private Set<Permission> permissions;
	  

	  public void setId(Integer id) {
	    this.id = id;
	  }
	  
	  public void setRname(String rname) {
	    this.rname = rname;
	  }
	  
	  public void setRcode(String rcode) {
	    this.rcode = rcode;
	  }
	  
	  public void setUsers(Set<User> users) {
	    this.users = users;
	  }
	  
	  public void setPermissions(Set<Permission> permissions) {
	    this.permissions = permissions;
	  }

	   public Integer getId() {
	    return this.id;
	  }
	  
	  public String getRname() {
	    return this.rname;
	  }
	  
	  public String getRcode() {
	    return this.rcode;
	  }
	  
	  public Set<User> getUsers() {
	    return this.users;
	  }
	  
	  public Set<Permission> getPermissions() {
	    return this.permissions;
	  }
	}

	  
	  public Role() {}
	  


	  public Role(Integer id, String rname, String rcode, Set<User> users, Set<Permission> permissions) {
	    this.id = id;
	    this.rname = rname;
	    this.rcode = rcode;
	    this.users = users;
	    this.permissions = permissions;
	  }
	  
	


	  public String toString() {
	   return "Role(id=" + getId() + ", rname=" + getRname() + ",
	    users=" + getUsers() + ", permissions=" + getPermissions() + ")"; 	
	     }