IDEA 2022 中的Lombok 使用基础教程

Tertia ·

更新时间:2024-11-13

· 1668 次阅读

1.Lombok是什么

1.1 Lombok 是什么？

2、POM 中引入依赖

3、IDE 中安装插件

4. Lombok 使用

4.1 Lombok 使用注意

5.代码案例：

6. 常用注解

1.Lombok是什么

Lombok是使用java编写的一款开源类库。其主作用是使用注解来代替一些具有格式固定，没有过多技术含量的编码工作。使我们可以仅仅在代码中添加一个注解(annotation),就可以起到和编写一大段代码一样的作用。对于这些格式固定的的代码，IDE也提供了自动生成的功能，但是无论是自动生成还是纯手动写，这些代码在类中是实实在在的存在，有时候，看到一个类文件很长，其中却都是一些，没有任何技术含量的getter和setter方法。无疑会影响我们的代码阅读。而使用Lombok可以将这些“无用”的代码，通过相应的注解替换掉。好了，废话少说，进入主题：

1.上面说的“注解”具体是哪些注解？

2.这些注解又能代替哪些编码工作呢？

3.lombok是如何实现以上功能的呢？

1.1 Lombok 是什么？

官网：https://projectlombok.org/

Lombok 是一个 Java 库，使用 Lombok 可以通过简单的注解帮助我们消除 Java 的样板代码，使代码更加简洁清晰。

比如对于简单的 Java 对象（POJO），很多的代码里充斥着大量的 getter() 和 setter() 方法，样板代码占用比例高，影响可读性，引入 Lombok 只需一个注解就能达到相同效果，而且更简洁。

Lombok 引入

2、POM 中引入依赖

使用 Lombok 注解需要依赖它的库。

Maven 库：https://mvnrepository.com/artifact/org.projectlombok/lombok

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

系统中如果有引入无需重复引入。

3、IDE 中安装插件

为什么装插件？

因为 Lombok 的引入后，java 文件使用 javac 编译成的字节码文件中就会包含 getter 和 setter 函数，但是源代码中找不到定义，IDE 会认为这是错误，因此需要安装一个 Lombok 的插件，方便本地 IDE 的研发工作。

IDEA 中安装：

Settings->Plugins->输入框输入”lombok”

4. Lombok 使用

比如要针对以下 Java 对象提供 getter() 和 setter() 方法：

public class Mountain {
    private String name;
    private String country;
}

只需要在类上打 @Getter 和 @Setter 注解。

@Getter
@Setter
public class Mountain {
    private String name;
    private String country;
}

然后用 maven 编译一下：mvn clean compile。

使用的时候就可以正常拿到像 getCountry() 和 setCountry() 这样的方法。通过 IDE 找方法调用处也可以直接锁定到字段上，以前要点两下才能看到字段明细信息，使用 Lombok 点一下就能达到效果。

4.1 Lombok 使用注意

不建议直接使用 @Data 这种大而全的方式覆盖太多的简化场景。

toString 场景不建议使用 Lombok 的，建议使用系统自定义 ToString 里的方法。

对外包考虑到接入方也需要引入依赖，如果担心副作用，可以不引入。

其他注解酌情使用。

5.代码案例：

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

package com.libin;
import lombok.AccessLevel;
import lombok.Getter;
import lombok.Setter;
/**
 * Created by  libin
 * 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等方法。

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

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//
package com.libin;
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属性排除某些字段。

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

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

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

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

@NoArgsConstructor：生成无参构造器；

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

@AllArgsConstructor：生成全参构造器。

编译后结果：

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：作用于类上，生成日志变量。针对不同的日志实现产品，有不同的注解：