Java效率工具Lombok使用及原理-优快云博客

本文介绍Lombok库如何简化Java开发，去除模板代码，提高效率。通过使用Lombok注解，如@Getter、@Setter、@ToString等，自动生成getter、setter、toString等方法，减少冗余代码。同时，讲解Lombok的原理及其在IDEA中的配置。

2019独角兽企业重金招聘Python工程师标准>>>

一、前言效率的提升

java效率的提升，一种方式就是去除模板代码。

1.1 去除pojo中的模板代码

pojo 的 getter/setter/tostring，异常处理，io流的关闭操作。等重复代码的出现。

解决方案：Lombok的使用。

二、lombok的使用

2.1 maven包

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

Lombok的scope=provided，说明它只在编译阶段生效，不需要打入包中。事实正是如此，Lombok在编译期将带Lombok注解的Java文件正确编译为完整的Class文件。

2.2 ide 工具对lombok的支持

idea 对 lombok的支持

https://mmbiz.qpic.cn/mmbiz_png/8yRv8Dibia2spfAUHyKgfqaAyP6mQxsicn1HmIsbvcrrliaRxcXwGmkWYQNdqtGtqia2xwM7oPSVibDgvv4gmI0SAshQ/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1

点击File-- Settings设置界面，开启Annocation Processors：

https://mmbiz.qpic.cn/mmbiz_png/8yRv8Dibia2spfAUHyKgfqaAyP6mQxsicn1MCjibH9fzFcsrtqvNRuXx7XF1iauzMic0tr8R0GkE6VtXRHLY0pk60xicQ/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1

三、Lombok实现原理

自从Java 6起，javac就支持“JSR 269 Pluggable Annotation Processing API”规范，只要程序实现了该API，就能在javac运行的时候得到调用。

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

1.javac对源代码进行分析，生成一棵抽象语法树(AST)

2.javac编译过程中调用实现了JSR 269的Lombok程序

3.此时Lombok就对第一步骤得到的AST进行处理，找到Lombok注解所在类对应的语法树(AST)，然后修改该语法树(AST)，增加Lombok注解定义的相应树节点

4.javac使用修改后的抽象语法树(AST)生成字节码文件

四、Lombok的使用

POJO类常用注解：

@Getter/@Setter: 作用类上，生成所有成员变量的getter/setter方法；作用于成员变量上，生成该成员变量的getter/setter方法。可以设定访问权限及是否懒加载等。

package com.trace;
import lombok.AccessLevel;import lombok.Getter;import lombok.Setter;
/** * Created by Trace on 2018/5/19.<br/> * DESC: 测试类 */@SuppressWarnings("unused")public class TestClass {
    public static void main(String[] args) {
    }

    
	@Getter(value = AccessLevel.PUBLIC)    
	@Setter(value = AccessLevel.PUBLIC)    
	public static class Person {        
	private String name;        
	private int age;        
	private boolean friendly;    
	}    
	
	public static class Animal {        
	private String name;        
	private int age;        
	@Getter @Setter private boolean funny;    
	}
}

在Structure视图中，可以看到已经生成了getter/setter等方法：

https://mmbiz.qpic.cn/mmbiz_png/8yRv8Dibia2spfAUHyKgfqaAyP6mQxsicn1sjPoKLwwwd3icuAlRJPBohzJuCFcuKbsXBkLtjlT8sW0ptIFHpYF26A/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1

编译后的代码如下：[这也是传统Java编程需要编写的样板代码]


//// Source code recreated from a .class file by IntelliJ IDEA// (powered by Fernflower decompiler)//
package com.trace;
public class TestClass {    public TestClass() {    }
    public static void main(String[] args) {    }
    public static class Animal {        private String name;        private int age;        private boolean funny;
        public Animal() {        }
        public boolean isFunny() {            return this.funny;        }
        public void setFunny(boolean funny) {            this.funny = funny;        }    }
    public static class Person {        private String name;        private int age;        private boolean friendly;
        public Person() {        }
        public String getName() {            return this.name;        }
        public int getAge() {            return this.age;        }
        public boolean isFriendly() {            return this.friendly;        }
        public void setName(String name) {            this.name = name;        }
        public void setAge(int age) {            this.age = age;        }
        public void setFriendly(boolean friendly) {            this.friendly = friendly;        }    }}

@ToString：作用于类，覆盖默认的toString()方法，可以通过of属性限定显示某些字段，通过exclude属性排除某些字段。

https://mmbiz.qpic.cn/mmbiz_png/8yRv8Dibia2spfAUHyKgfqaAyP6mQxsicn1ZgPNh2ia7FpI73IpEs7RExObvPFmB6L7SjGHpYlVuEzibciaQGBicKHaFg/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1

@EqualsAndHashCode：作用于类，覆盖默认的equals和hashCode

@NonNull：主要作用于成员变量和参数中，标识不能为空，否则抛出空指针异常。

https://mmbiz.qpic.cn/mmbiz_png/8yRv8Dibia2spfAUHyKgfqaAyP6mQxsicn1xw0W3LiazGvffcuiaBvtGSmEpIM49bvlItIUojunQJt9MF2kvE4S1THg/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1

@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor：作用于类上，用于生成构造函数。有staticName、access等属性。

staticName属性一旦设定，将采用静态方法的方式生成实例，access属性可以限定访问权限。

@NoArgsConstructor：生成无参构造器；

@RequiredArgsConstructor：生成包含final和@NonNull注解的成员变量的构造器；

@AllArgsConstructor：生成全参构造器。

https://mmbiz.qpic.cn/mmbiz_png/8yRv8Dibia2spfAUHyKgfqaAyP6mQxsicn14brDJrIRbocqfXmb5zVcuAvuv4syHO07kWGSENEYXmiaVDGETubYTPA/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1

编译后结果：

public static class Person {    @NonNull    private String name;    private int age;    private boolean friendly;
    public String toString() {        return "TestClass.Person(name=" + this.getName() + ", age=" + this.getAge() + ")";    }
    @NonNull    public String getName() {        return this.name;    }
    public int getAge() {        return this.age;    }
    public boolean isFriendly() {        return this.friendly;    }
    public void setName(@NonNull String name) {        if(name == null) {            throw new NullPointerException("name");        } else {            this.name = name;        }    }
    public void setAge(int age) {        this.age = age;    }
    public void setFriendly(boolean friendly) {        this.friendly = friendly;    }
    private Person() {    }
    private static TestClass.Person of() {        return new TestClass.Person();    }
    @ConstructorProperties({"name"})    Person(@NonNull String name) {        if(name == null) {            throw new NullPointerException("name");        } else {            this.name = name;        }    }
    @ConstructorProperties({"name", "age", "friendly"})    public Person(@NonNull String name, int age, boolean friendly) {        if(name == null) {            throw new NullPointerException("name");        } else {            this.name = name;            this.age = age;            this.friendly = friendly;        }    }}

@Data：作用于类上，是以下注解的集合：@ToString @EqualsAndHashCode @Getter @Setter @RequiredArgsConstructor

@Builder：作用于类上，将类转变为建造者模式

@Log：作用于类上，生成日志变量。针对不同的日志实现产品，有不同的注解：

https://mmbiz.qpic.cn/mmbiz_png/8yRv8Dibia2spfAUHyKgfqaAyP6mQxsicn1v2AGjhq4XZkKdnzvQ1sz28d2KkKUbzsg2MDYA8jFhfQdKTOex0BvVA/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1