Lombok是一种Java插件,利用它可以在编译时自动生成POJO对象所需的getter、setter、equals和构造器等方法,免去开发人员手动实现这些简单且繁琐的代码。

引入

自从Java 6起,javac就支持“JSR 269 Pluggable Annotation Processing API”规范,只要程序实现了该API,就能在javac运行的时候得到调用。Lombok就是一个实现了"JSR 269 API"的程序,具体流程如下:

  1. javac对源代码进行分析,生成一棵抽象语法树(AST)
  2. javac编译过程中调用实现了JSR 269的Lombok程序
  3. 对AST进行处理,找到Lombok注解对应的语法树节点,将自动生成的相应方法注入到树节点中
  4. javac使用修改后的抽象语法树(AST)生成字节码文件

通过maven引入lombok依赖,其中作用域scope为provided,因为Lombok作用于编译阶段,不需要打入包中

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

可以在IDEA中添加Lombok相关插件(IDEA在2020.3版本之后已经内置Lombok)
在这里插入图片描述
并开启选项使其在编译阶段生效
在这里插入图片描述

使用注解

Lombok常用的注解如下

  1. @Getter@Setter自动为类的所有成员变量在编译时生成相应的getter、setter方法,还可以通过AccessLevel控制方法作用域,特别地,如果为AccessLevel.NONE则Lombok不会为该变量自动生成getter、setter,我们可以手动重写该方法。如果只为某个变量添加,则只会生成该变量的getter、setter。
  2. @ToString作用于类,覆盖默认的toString()方法,属性of指定要显示的某些字段,通过exclude属性排除某些字段,通过callSuper = true调用父类的toString()方法
  3. @EqualsAndHashCode生成类的hashCode()equals()方法,默认使用所有非静态、非transient字段。可以通过属性of来指定希望使用的字段,或者通过exclude来排除不需要的字段。
  4. @NoArgsConstructor生成一个无参构造方法。当类中有final字段没有被初始化时,编译器会报错,此时可用@NoArgsConstructor(force = true),然后就会为没有初始化的final字段设置默认值 0 / false / null。
  5. @RequiredArgsConstructor生成带有必要参数的构造方法,例如类中所有带有 @NonNull 注解的或 final 修饰的成员变量
  6. @AllArgsConstructor生成一个包含所有参数的构造方法
  7. @Data包含 @ToString、@EqualsAndHashCode、@Getter / @Setter和@RequiredArgsConstructor的功能
  8. @Synchronized 给方法加上同步锁
  9. @Slf4j可以自动帮你创建日志对象log,然后可以在类的方法中直接使用log进行日志操作。使用之前需要确保项目中已经引入了相关日志工具的依赖,例如我这里使用的是logback作为日志工具

如下所示为使用Lombok注解的Java代码

import lombok.*;
import lombok.extern.slf4j.Slf4j;

@Getter(AccessLevel.PUBLIC)                     //为Person类所有成员变量生成getter、setter方法
@Setter
@ToString(of = {"name", "age"})                 //生成包含name、age字段的toString方法
@EqualsAndHashCode(exclude = {"email"})         //生成不比较email字段的equals和hashCode方法
@RequiredArgsConstructor                        //生成包含必要参数的构造方法
@Slf4j                                          //为类注入日志对象
public class Person {
    private final int id;
    @Getter(AccessLevel.NONE)                   //不为name字段自动生成getter方法
    private String name;
    private int age;
    private String email;

    public String getName() {                   //手动实现getter方法
        log.info("------log output------");     //直接使用log对象打印日志
        return "我是" + name;
    }
}

如下所示为Lombok生成的字节码文件反编译的结果,可以看到通过注解自动生成了所需的代码

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Person {
    private static final Logger log = LoggerFactory.getLogger(Person.class);	//自动创建log对象
    private final int id;
    private String name;
    private int age;
    private String email;

    public String getName() {	//手动重写的getter方法
        log.info("------log output------");
        return "我是" + this.name;
    }

    public int getId() {		//自动生成的getter
        return this.id;
    }

    public int getAge() {
        return this.age;
    }

    public String getEmail() {
        return this.email;
    }

    public void setName(String name) {	//自动生成的setter
        this.name = name;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public String toString() {		//自动生成的toString,包含name、age字段
        return "Person(name=" + this.getName() + ", age=" + this.getAge() + ")";
    }

    public boolean equals(Object o) {	//自动生成的equals方法
        if (o == this) {
            return true;
        } else if (!(o instanceof Person)) {
            return false;
        } else {
            Person other = (Person)o;
            if (!other.canEqual(this)) {
                return false;
            } else if (this.getId() != other.getId()) {
                return false;
            } else if (this.getAge() != other.getAge()) {
                return false;
            } else {
                Object this$name = this.getName();
                Object other$name = other.getName();
                if (this$name == null) {
                    if (other$name == null) {
                        return true;
                    }
                } else if (this$name.equals(other$name)) {
                    return true;
                }

                return false;
            }
        }
    }

    protected boolean canEqual(Object other) {
        return other instanceof Person;
    }

    public int hashCode() {	//自动生成的hashCode方法
        int PRIME = true;
        int result = 1;
        int result = result * 59 + this.getId();
        result = result * 59 + this.getAge();
        Object $name = this.getName();
        result = result * 59 + ($name == null ? 43 : $name.hashCode());
        return result;
    }

    public Person(int id) {		//自动生成包含被final修饰id字段的构造函数
        this.id = id;
    }
}

还可以使用@Builder注解将类自动生成建造者模式,如下所示为Person类添加注解

@Builder
public class Person {
    private final int id;
    private String name;
    private int age;
}

在创建对象时就可以通过建造者模式,使用链式调用直接对参数进行设置

Person person=Person.builder().id(1001).age(18).name("Tory").build();

可以看到反编译之后Lombok生成的Perosn建造者模式的实现类,可以看到其通过内部类PersonBuilder对参数进行设置并最后返回Person对象

import java.beans.ConstructorProperties;

public class Person {
    private final int id;
    private String name;
    private int age;

    @ConstructorProperties({"id", "name", "age"})
    Person(final int id, final String name, final int age) {
        this.id = id;
        this.name = name;
        this.age = age;
    }

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

    public static class PersonBuilder {
        private int id;
        private String name;
        private int age;

        PersonBuilder() {
        }

        public PersonBuilder id(final int id) {
            this.id = id;
            return this;
        }

        public PersonBuilder name(final String name) {
            this.name = name;
            return this;
        }

        public PersonBuilder age(final int age) {
            this.age = age;
            return this;
        }

        public Person build() {
            return new Person(this.id, this.name, this.age);
        }

        public String toString() {
            return "Person.PersonBuilder(id=" + this.id + ", name=" + this.name + ", age=" + this.age + ")";
        }
    }
}
Logo

开放原子开发者工作坊旨在鼓励更多人参与开源活动,与志同道合的开发者们相互交流开发经验、分享开发心得、获取前沿技术趋势。工作坊有多种形式的开发者活动,如meetup、训练营等,主打技术交流,干货满满,真诚地邀请各位开发者共同参与!

更多推荐