Lombok概述

已于 2022-06-02 14:39:45 修改
阅读量2.1k 收藏 4
点赞数 2
分类专栏： 编程技巧 文章标签： Lombok
于 2020-02-08 01:23:13 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_30342639/article/details/104216853
版权

        Lombok版本：1.18.10。

        Lombok是一个能自动插入IDE并进行构建的Java库工具，通过注解的方式来简化我们的编程，提高效率。它是通过修改底层AST语法树的方式来实现的，相对于反射技术在运行期进行修改，Lombok是在编译期进行修改源码，性能损耗较小。

        在我们平时写Java Model的时候都是要写getter/setter方法的，Lombok可以通过@Getter和@Setter注解来完成这一步操作，节省了大量时间。Lombok还有一个@Slf4j注解，可以提供快速打印日志的功能。Lombok提供的功能还有很多。下面举一些常用的注解来进行说明。

        有些人不建议使用Lombok，说它会污染项目。拿idea来举例，如果一个人使用了Lombok，别的人都得去下载idea的Lombok插件（即使引入了Lombok依赖也不行）。在我看来，这完全取决于项目经理的决定，如果最终决定要用，那所有人都用也没什么不好的，而且idea下载插件也是很方便的。还有就是有些人会在getter/setter方法里面加上业务代码，使用Lombok注解就不能自定义实现了。首先这就不是推荐的做法，当前在getter/setter方法里面加上的业务代码只满足于当前的需求，假如说后期需要更改需求变动这里的话，还需要再更改getter/setter里面的代码，这样会使得Java Model变得越来越重，Model应该要保持它的纯粹性才对。

        正如上面所说，使用Lombok不仅需要引入依赖：

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

        还需要在IDE中下载Lombok插件才行，如下所示：

1 @Getter / @Setter

        顾名思义，这两个注解就是用来生成getter / setter方法的，在类上加上这两个注解即可。使用如下：

import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
public class Person {

    private Long id;

    private String name;

    private String address;
}

        最终生成的class文件如下所示：

public class Person {
    private Long id;
    private String name;
    private String address;

    public Person() {
    }

    public Long getId() {
        return this.id;
    }

    public String getName() {
        return this.name;
    }

    public String getAddress() {
        return this.address;
    }

    public void setId(final Long id) {
        this.id = id;
    }

    public void setName(final String name) {
        this.name = name;
    }

    public void setAddress(final String address) {
        this.address = address;
    }
}

        在像一些idea或Eclipse的IDE中可以快捷键生成getter / setter代码，也很方便。但是如果在开发中后期需要变动Java Model的属性类型或者名字的时候（这种情况说实话还是不少的），就需要将原来的getter / setter代码删掉，再重新快捷键生成，相对来说还是麻烦一些。而如果使用Lombok的@Getter / @Setter注解的话，就只需要修改属性本身即可。

2 @ToString

        该注解是用来生成toString方法的，使用如下：

import lombok.ToString;

@ToString
public class Person {

    private Long id;

    private String name;

    private String address;
}

        最终生成的class文件如下所示：

public class Person {
    private Long id;
    private String name;
    private String address;

    public Person() {
    }

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

        跟上面一样，IDE中也可以使用快捷键生成toString方法，但是使用Lombok的@ToString注解会更方便一些。

3 @EqualsAndHashCode

        该注解是用来生成equals和hashCode方法的，使用如下：

import lombok.EqualsAndHashCode;

@EqualsAndHashCode
public class Person {

    private Long id;

    private String name;

    private String address;
}

        最终生成的class文件如下所示：

public class Person {
    private Long id;
    private String name;
    private String address;

    public Person() {
    }

    public boolean equals(final Object o) {
        if (o == this) {
            return true;
        } else if (!(o instanceof Person)) {
            return false;
        } else {
            Person other = (Person)o;
            if (!other.canEqual(this)) {
                return false;
            } else {
                label47: {
                    Object this$id = this.id;
                    Object other$id = other.id;
                    if (this$id == null) {
                        if (other$id == null) {
                            break label47;
                        }
                    } else if (this$id.equals(other$id)) {
                        break label47;
                    }

                    return false;
                }

                Object this$name = this.name;
                Object other$name = other.name;
                if (this$name == null) {
                    if (other$name != null) {
                        return false;
                    }
                } else if (!this$name.equals(other$name)) {
                    return false;
                }

                Object this$address = this.address;
                Object other$address = other.address;
                if (this$address == null) {
                    if (other$address != null) {
                        return false;
                    }
                } else if (!this$address.equals(other$address)) {
                    return false;
                }

                return true;
            }
        }
    }

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

    public int hashCode() {
        int PRIME = true;
        int result = 1;
        Object $id = this.id;
        int result = result * 59 + ($id == null ? 43 : $id.hashCode());
        Object $name = this.name;
        result = result * 59 + ($name == null ? 43 : $name.hashCode());
        Object $address = this.address;
        result = result * 59 + ($address == null ? 43 : $address.hashCode());
        return result;
    }
}

        如果使用HashMap或者HashSet的时候，一定要留意key是Java Model的情况。需不需要根据当前属性来自定义hashCode和equals方法的实现，需要自定义的话就不能使用该注解。

        使用该注解还有一点需要留意的是Model继承的情况。如下述的代码所示：

public class Person extends Human {

    private Long id;

    private String name;

    private String address;
}

class Human {

    private Integer height;

    private Integer weight;
}

        Person继承Human，如果我们在比对两个Person对象的时候，需要比对父类的属性值的时候，则必须在@EqualsAndHashCode注解里加上callSuper = true（默认为false，也就是不比较父类的属性值），如下所示：

import lombok.EqualsAndHashCode;

@EqualsAndHashCode(callSuper = true)
public class Person extends Human {

    private Long id;

    private String name;

    private String address;
}

class Human {

    private Integer height;

    private Integer weight;
}

        最终生成的class文件如下所示：

public class Person extends Human {
    private Long id;
    private String name;
    private String address;

    public Person() {
    }

    public boolean equals(final Object o) {
        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 (!super.equals(o)) {
                return false;
            } else {
                label49: {
                    Object this$id = this.id;
                    Object other$id = other.id;
                    if (this$id == null) {
                        if (other$id == null) {
                            break label49;
                        }
                    } else if (this$id.equals(other$id)) {
                        break label49;
                    }

                    return false;
                }

                Object this$name = this.name;
                Object other$name = other.name;
                if (this$name == null) {
                    if (other$name != null) {
                        return false;
                    }
                } else if (!this$name.equals(other$name)) {
                    return false;
                }

                Object this$address = this.address;
                Object other$address = other.address;
                if (this$address == null) {
                    if (other$address != null) {
                        return false;
                    }
                } else if (!this$address.equals(other$address)) {
                    return false;
                }

                return true;
            }
        }
    }

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

    public int hashCode() {
        int PRIME = true;
        int result = super.hashCode();
        Object $id = this.id;
        result = result * 59 + ($id == null ? 43 : $id.hashCode());
        Object $name = this.name;
        result = result * 59 + ($name == null ? 43 : $name.hashCode());
        Object $address = this.address;
        result = result * 59 + ($address == null ? 43 : $address.hashCode());
        return result;
    }
}

        可以看到在第18行和第66行对父类进行了比较。

4 @AllArgsConstructor / @RequiredArgsConstructor / @NoArgsConstructor

        这三个注解都是用来生成构造器的，分别是全参构造器、特定参数的构造器和无参构造器。@AllArgsConstructor和@NoArgsConstructor的使用如下：

import lombok.AllArgsConstructor;
import lombok.NoArgsConstructor;

@AllArgsConstructor
@NoArgsConstructor
public class Person {

    private Long id;

    private String name;

    private String address;
}

        最终生成的class文件如下所示：

public class Person {
    private Long id;
    private String name;
    private String address;

    public Person(final Long id, final String name, final String address) {
        this.id = id;
        this.name = name;
        this.address = address;
    }

    public Person() {
    }
}

        而@RequiredArgsConstructor注解则会为所有未初始化的final属性和@NonNull注解的属性添加构造器，构造器只会生成一个，包含这些参数：

import lombok.NonNull;
import lombok.RequiredArgsConstructor;

@RequiredArgsConstructor
public class Person {

    @NonNull
    private Long id;

    private final String name;

    private String address;
}

        最终生成的class文件如下所示：

import lombok.NonNull;

public class Person {
    @NonNull
    private Long id;
    private final String name;
    private String address;

    public Person(@NonNull final Long id, final String name) {
        if (id == null) {
            throw new NullPointerException("id is marked non-null but is null");
        } else {
            this.id = id;
            this.name = name;
        }
    }
}

5 @Data

        该注解整合了@Getter / @Setter、@ToString、@EqualsAndHashCode和@RequiredArgsConstructor这五个注解，在大部分情况下我们都会使用该注解以代替上面的那些注解，除非像上面所说的继承父类需要比较父类的属性的情况下需要显式调用@EqualsAndHashCode(callSuper = true)注解，还有使用includeFieldNames和exclude的情况等等。@Data的使用如下所示：

import lombok.Data;

@Data
public class Person {

    private Long id;

    private String name;

    private String address;
}

        最终生成的class文件如下所示：

public class Person {
    private Long id;
    private String name;
    private String address;

    public Person() {
    }

    public Long getId() {
        return this.id;
    }

    public String getName() {
        return this.name;
    }

    public String getAddress() {
        return this.address;
    }

    public void setId(final Long id) {
        this.id = id;
    }

    public void setName(final String name) {
        this.name = name;
    }

    public void setAddress(final String address) {
        this.address = address;
    }

    public boolean equals(final Object o) {
        if (o == this) {
            return true;
        } else if (!(o instanceof Person)) {
            return false;
        } else {
            Person other = (Person)o;
            if (!other.canEqual(this)) {
                return false;
            } else {
                label47: {
                    Object this$id = this.getId();
                    Object other$id = other.getId();
                    if (this$id == null) {
                        if (other$id == null) {
                            break label47;
                        }
                    } else if (this$id.equals(other$id)) {
                        break label47;
                    }

                    return false;
                }

                Object this$name = this.getName();
                Object other$name = other.getName();
                if (this$name == null) {
                    if (other$name != null) {
                        return false;
                    }
                } else if (!this$name.equals(other$name)) {
                    return false;
                }

                Object this$address = this.getAddress();
                Object other$address = other.getAddress();
                if (this$address == null) {
                    if (other$address != null) {
                        return false;
                    }
                } else if (!this$address.equals(other$address)) {
                    return false;
                }

                return true;
            }
        }
    }

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

    public int hashCode() {
        int PRIME = true;
        int result = 1;
        Object $id = this.getId();
        int result = result * 59 + ($id == null ? 43 : $id.hashCode());
        Object $name = this.getName();
        result = result * 59 + ($name == null ? 43 : $name.hashCode());
        Object $address = this.getAddress();
        result = result * 59 + ($address == null ? 43 : $address.hashCode());
        return result;
    }

    public String toString() {
        return "Person(id=" + this.getId() + ", name=" + this.getName() + ", address=" + this.getAddress() + ")";
    }
}

6 @Slf4j

        该注解是用来快捷生成日志的，使用如下所示：

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class Test {

    public static void main(String[] args) {
        if (log.isDebugEnabled()) {
            log.debug("log test");
        }
    }
}

        运行结果如下：

01:05:29.719 [main] DEBUG com.hys.test.Test - log test

        如果不使用该注解，idea的话也可以配置Live Templates，用快捷键也能生成logger。

7 @Builder

        该注解可以使用像建造者模式一样的代码来给Java Model的属性来赋值。比如说我们用setter代码的方式来赋值如下所示：

Person person = new Person();
person.setId(1L);
person.setName("Robert Hou");
person.setAddress("Beijing");

        相对来说还是比较繁琐的，尤其是需要全属性赋值的时候尤为明显。使用带参构造器方式的代码如下所示：

Person person = new Person(1L, "Robert Hou", "Beijing");

        使用带参构造器赋值的弊端在于我们并不知道赋值的属性是哪个，还是得跳到构造器方法中进行查看。idea中可以显示赋值参数的参数名，算是一种优化：

        但这也仅限于使用idea，使用别的编译器就没有这种效果，这种时候就可以考虑使用@Builder这个注解来进行参数赋值：

import lombok.Builder;

@Builder
public class Person {

    private Long id;

    private String name;

    private String address;
}

        参数赋值代码如下所示：

Person.builder().id(1L).name("Robert Hou").address("Beijing").build();

        可以看到赋值的过程很方便：调用一次方法就完成了一次赋值，通过一行代码，不断链式地调用来完成整个赋值过程。而且一眼就能看清楚赋值的内容是什么，便于维护。

8 @NonNull

        该注解会对参数做非空检查，如果为空则会抛出一个空指针异常：

public static void main(String[] args) {
    test(null);
}

private static void test(@NonNull String str) {
    System.out.println(str.length());
}

        生成的class代码如下：

private static void test(@NonNull String str) {
    if (str == null) {
        throw new NullPointerException("str is marked non-null but is null");
    } else {
        System.out.println(str.length());
    }
}

9 @Cleanup

        该注解用在变量前面，会自动调用资源的close方法，例如输入流输出流等等。如果有其他关闭的方法，也可以进行指定：

import lombok.Cleanup;

import java.io.*;

public class Test {

    public static void main(String[] args) throws IOException {
        File file = new File("d:\\read.txt");
        @Cleanup InputStream inputStream = new FileInputStream(file);
        byte[] b = new byte[65536];
        while (true) {
            int r = inputStream.read(b);
            if (r == -1) {
                break;
            }
        }
    }
}

        生成的class代码如下：

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.Collections;

public class Test {
    public Test() {
    }

    public static void main(String[] args) throws IOException {
        File file = new File("d:\\read.txt");
        FileInputStream inputStream = new FileInputStream(file);

        try {
            byte[] b = new byte[65536];

            int r;
            do {
                r = inputStream.read(b);
            } while(r != -1);
        } finally {
            if (Collections.singletonList(inputStream).get(0) != null) {
                inputStream.close();
            }

        }

    }
}

10 @SneakyThrows

        该注解注释在方法上，可以将方法中的代码try-catch住，默认是抛出Throwable，也可以自己指定异常：

@SneakyThrows
public String utf8ToString(byte[] bytes) {
    return new String(bytes, "UTF-8");
}

        生成的class代码如下：

public String utf8ToString(byte[] bytes) {
    try {
        return new String(bytes, "UTF-8");
    } catch (Throwable var3) {
        throw var3;
    }
}

11 @Synchronized

        这个注解和synchronized关键字的效果相同，但是Lombok可以给静态方法和实例方法自动加上锁资源：

import lombok.Synchronized;

public class Test {

    public static void main(String[] args) {
    }

    @Synchronized
    public static void test1() {
        System.out.println();
    }

    @Synchronized
    public int test2() {
        return 3;
    }
}

        生成的class代码如下：

public class Test {
    private static final Object $LOCK = new Object[0];
    private final Object $lock = new Object[0];

    public Test() {
    }

    public static void main(String[] args) {
    }

    public static void test1() {
        synchronized($LOCK) {
            System.out.println();
        }
    }

    public int test2() {
        synchronized(this.$lock) {
            return 3;
        }
    }
}
天瑕
关注
  • 2
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
vscode-lombok:Lombok注释Visual Studio Code的官方扩展
05-02
vscode-Lombok概述 一个轻量级扩展，可在Visual Studio Code中支持批注处理要求VS Code（1.21.0版或更高版本） 将Lombok作为依赖项添加到Java项目中（请确保您使用的是最新版本，以避免出现问题！）或安装打开VS ...
lombok-plugin-0.34.1-2018.2.zip
03-12
一、Lombok概述 Lombok是一个可以通过注解来简化JavaBean的工具，它能够自动为我们生成如getter、setter、构造函数、equals、hashCode以及toString等方法，避免了大量重复的代码，使代码更加整洁。Lombok的核心在于...
带你快速入门 Java开发神器 lombok
专注于Java领域开发 关注我 带你玩转Java
02-21 787
目录 什么是lombok 安装lombok lombok的使用 小结 参考文档 在写JavaBean对象时候 每次都要重复Alt+insert写Getter/Setter toString 有参构造 和 无参构造 特别麻烦 浪费时间 今天给大家推荐神器lombok 官方支持的神器 可以帮您省去大量时间 让代码简洁易读 什么是lombok Project Lombok 是一个 java 库，可自动插入您的编辑器和构建工具，为您的 java 增添趣味。 永远不要再编写另一个 getter 或
关于equals的那些事
manba_out的博客
07-31 299
==和equals的区别 为什么重写了equals方法就必须重写hashCode方法
Lombok的hashCode方法
最新发布
LiZhen314的博客
06-27 613
在继承关系中，父类的hashCode针对父类的所有属性进行运算，而子类的hashCode却只是针对子类才有的属性进行运算，立此贴提醒自己。callSuper = false，根据子类自身的字段值 来生成hashcode， 当两个子类对象比较时，只有子类对象的本身的字段值相同，父类字段值可以不同，callSuper = true，根据子类自身的字段值和从父类继承的字段值 来生成hashcode，当两个子。比较时，只有子类对象的本身的字段值和继承父类的字段值都相同，equals方法的返回值是true。
Java高效编程：总结分享
耶low的博客
03-25 218
参考资料：慕课网：Java高效编程收费实战课程、博客园、CSDN、菜鸟教程以及其他文档。 篇幅受限，不太想针对每个点都写篇博客，有的地方可能写的不是很详细，一笔带过了。如果你觉得那个点在项目中用得上可以另行搜索一些相关的更详细的博客或文档。 1.Lambda和函数式编程 　　函数式编程即可以把函数当作变量、参数、返回值传递。实现的方法就是定义一个函数式接口，函数式接口即只有一个抽象方法的...
Spring boot 简介
m0_52555753的博客
10-13 233
Springboot ，mysql
lombok注解@Data使用在继承类上时出现警告
热门推荐
feinifi的博客
12-27 6万+
lombok为我们提供了@Data注解，帮助我们省略了@Setter,@Getter,@ToString等注解，一般对于普通的实体类使用该注解，不会出现什么问题，但是当我们把这个注解，使用在派生类上，就出现了一个小问题。 基类： 派生类： @Data注解的地方会出现警告： 出现的警告信息： Generating equals/hashCode implementation ...
ideaIU-2020.1.3的lombok版本
05-18
Lombok概述 Lombok是由Pivotal Software开发的开源项目，其核心理念是减少Java类中冗余的样板代码。它通过提供一系列注解，如`@Data`、`@Getter`、`@Setter`等，可以在编译时自动生成对应的字段访问方法，从而提高...
Lombok笔记文档_*************************
06-09
【Lombok概述】 Lombok是一个Java库，它通过使用注解自动插入源代码，从而减少了样板代码的编写。在传统的Java开发中，我们经常需要为POJO类编写大量的getter、setter、equals()、hashCode()、toString()等方法，...
lombook的使用
01-04
#### 一、Lombok 概述 Lombok 是一款 Java 库，它通过注解的方式简化了 Java 开发中的繁琐代码编写工作，特别是那些经常重复出现的模式，如 getter 和 setter 方法、构造函数、equals 和 hashCode 方法等。这不仅...
lombok.jar(最新的1.18.2)
09-17
2018年9月17号下载的lombok 1.使用步将 lombok.jar 放在eclipse安装目录下，和 eclipse.ini 文件平级的 2.双击打开jar包 3.点specify location 按钮，选择eclipse的安装目录，选择到eclipse层即可
Lombok的使用
BubblesMusic的博客
08-27 623
Lombok项目是一个Java库，它会自动插入编辑器和构建工具中，Lombok提供了一组有用的注释，用来消除Java类中的大量样板代码。仅五个字符(@Data)就可以替换数百行代码从而产生干净，简洁且易于维护的Java类。 “Boilerplate”是一个术语，用于描述在应用程序的许多部分中很少改动就重复的代码。对Java语言最常见的批评就是在大多数项目中都可以找到这种类型的代码，由于语言本身的局限性而更加严重。龙目岛计划（Project Lombok）旨在通过用简单的注释集代替众多的代码。 Lom
Lombok 1.18.x 使用方法
weixin_45501950的博客
04-22 2418
1 背景介绍 Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java. Never write another getter or equals method again, with one annotation your cl...
eclipse的自动生成的重载hashCode()方法中prime的值为31的原因
dyc_dyc的博客
08-13 4127
eclipse为了方便我们编码，有这么一个功能，自动生成的重载hashCode()和equals()，附上一个小例子 public class Person { String name; int age; @Override public int hashCode() { final int prime = 31; int result = 1; result = pri...
bool数组 和 int数组用来记录true和false的效率比较
Tizzi的博客
11-04 1707
int数组 107 下质数筛法 #include <cstdio> const int N = 1e7 + 5; int is_prime[N], n, cnt; void f() { for (int i = 2; i <= n; i++) { if (is_prime[i]) continue; cnt++; for (int j = i + i; j &...
import lombok 报错_Lombok快速入门
weixin_39648432的博客
12-19 602
Lombok介绍：Lombok其实就是取名自龙目岛(Pulau Lombok)，龙目岛是印度尼西亚西努沙登加拉(Nusa Tenggara Barat)省岛屿，西隔龙目海峡面对巴厘岛，东隔阿拉斯(Alas)海峡面松巴哇(Sumbawa)岛，北濒爪哇海，南临印度洋。在编程上，Lombok是一个可以通过简单的注解形式来帮助我们简化消除一些必须有但显得很臃肿的Java代码的工具，通过使用对应的注解，可以...
mpls 笔记 part 1
m0_47505062的博客
06-23 408
mpls 笔记第一部分
比较两个List是否相同(利用hashCode比较)
qq_32300143的博客
06-26 2043
1.利用eclipse中自动重写hashCode和equals对象 @Override public int hashCode() { final int prime = 31; int result = 1; result = prime * result + age; result = prime * result + ...
int is_prime=1；
07-15
这段代码声明了一个名为 `is_prime` 的整型变量，并将其初始化为 1。通常情况下，我们用来表示布尔值的变量名会使用 `bool`型，而不是整型。但是，由于 C 语言没有原生的布尔类型，因此可以使用整型变量来表示布尔值，其中 0 表示假（false），非零值表示真（true）。在这种情况下，`is_prime` 的值为 1，表示它是一个素数的标志。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值