首页 > 其他分享 >Project Lombok (即 Lombok)学习记录

Project Lombok (即 Lombok)学习记录

时间:2022-10-03 15:35:05浏览次数:85  
标签:return name 记录 private Project Lombok null public String

目录

参考文档

什么是 Project Lombok ?

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 class has a fully featured builder, Automate your logging variables, and much more.

Project Lombok是一个java库,它可以自动插入编辑器和构建工具,增加java的趣味性。
永远不要再写另一个 getter 或 equals 方法,只需一个注释,你的类就有了一个功能齐全的构建器,自动化你的日志变量,等等。

总结:使用注解即可替换 getter setter equals 等方法,在编译期自动生成生成getter setter equals 等方法代码。

下载 Project Lombok

支持的安装方式

image

安装 Project Lombok

lombok.jar 安装

依赖:必须保证安装JDK并配置环境变量

windos 打开 CMD命令窗口,执行下面命令执行安装:

java -jar lombok.jar

lombok 会自动扫描已安装的 IDE 开发工具:
image

如果IDE 不是 exe 安装的,则lombok会找不到已安装的IDE:
image

这时,点击 【Specify location ...】按钮,自行选择 IDE 开发工具的程序(我本地是 eclipse):
image
image

继续点击 【Install / Update】按钮进行安装。
安装完成后,:
image

至此,安装完成。后续步骤:

之后需要 将 lombok.jar 添加到你的项目中。

eclipse 安装 lombok 插件

两种方式:

  1. 使用 lombok.jar 安装,选择本机的 eclipse
  2. 使用 eclipse 市场安装插件 https://projectlombok.org/p2

IntelliJ 安装 lombok 插件

步骤:

  1. 选择 File > Settings > Plugins
  2. 点击 Browse repositories...
  3. 查找 Lombok 插件
  4. 点击 Install plugin
  5. 重启 IntelliJ IDEA

使用 Project Lombok

  1. 新建 maven 项目
  2. 引入 lombok.jar
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.24</version>
    <scope>provided</scope>
</dependency>
  1. 编写标注 lombok注解的 Response.java 类
import java.io.Serializable;

import lombok.Builder;
import lombok.Data;

@Data
@Builder
public class Response implements Serializable {

    private static final long serialVersionUID = 5001615840097014470L;

    private String code;

    private boolean success;

    private String message;
}
  1. eclipse 中 使用 “Ctrl + o” 快捷键查看类结构:
    image

注意:@Builder 会把无参构造方法私有化!

Lombok 提供的注解

@GETTER AND @SETTER

@GETTER 和 @SETTER 注解依次生成get,set方法。
例子:

@Getter @Setter private boolean employed = true;
@Setter(AccessLevel.PROTECTED) private String name;

等同于

private boolean employed = true;
private String name;
 
public boolean isEmployed() {
    return employed;
}
 
public void setEmployed(final boolean employed) {
    this.employed = employed;
}
 
protected void setName(final String name) {
    this.name = name;
}

@NONNULL

@NONNULL 表明为类的成员添加空指针校验。

例子:

@Getter @Setter @NonNull
private List<Person> members;

等同于

@NonNull
private List<Person> members;
 
public Family(@NonNull final List<Person> members) {
    if (members == null) throw new java.lang.NullPointerException("members");
    this.members = members;
}
 
@NonNull
public List<Person> getMembers() {
    return members;
}
 
public void setMembers(@NonNull final List<Person> members) {
    if (members == null) throw new java.lang.NullPointerException("members");
    this.members = members;
}

@TOSTRING

@TOSTRING 注解生成 toString方法的实现。
例子:

@ToString(callSuper=true,exclude="someExcludedField")
public class Foo extends Bar {
    private boolean someBoolean = true;
    private String someStringField;
    private float someExcludedField;
}

等同于

public class Foo extends Bar {
    private boolean someBoolean = true;
    private String someStringField;
    private float someExcludedField;
 
    @java.lang.Override
    public java.lang.String toString() {
        return "Foo(super=" + super.toString() +
            ", someBoolean=" + someBoolean +
            ", someStringField=" + someStringField + ")";
    }
}

@EQUALSANDHASHCODE

@EQUALSANDHASHCODE 注解会指示 Lombok 生成 equalshashCode 方法。

例子:

@EqualsAndHashCode(callSuper=true,exclude={"address","city","state","zip"})
public class Person extends SentientBeing {
    enum Gender { Male, Female }
 
    @NonNull private String name;
    @NonNull private Gender gender;
 
    private String ssn;
    private String address;
    private String city;
    private String state;
    private String zip;
}

等同于

public class Person extends SentientBeing {
 
    enum Gender {
        /*public static final*/ Male /* = new Gender() */,
        /*public static final*/ Female /* = new Gender() */;
    }
    @NonNull
    private String name;
    @NonNull
    private Gender gender;
    private String ssn;
    private String address;
    private String city;
    private String state;
    private String zip;
 
    @java.lang.Override
    public boolean equals(final java.lang.Object o) {
        if (o == this) return true;
        if (o == null) return false;
        if (o.getClass() != this.getClass()) return false;
        if (!super.equals(o)) return false;
        final Person other = (Person)o;
        if (this.name == null ? other.name != null : !this.name.equals(other.name)) return false;
        if (this.gender == null ? other.gender != null : !this.gender.equals(other.gender)) return false;
        if (this.ssn == null ? other.ssn != null : !this.ssn.equals(other.ssn)) return false;
        return true;
    }
 
    @java.lang.Override
    public int hashCode() {
        final int PRIME = 31;
        int result = 1;
        result = result * PRIME + super.hashCode();
        result = result * PRIME + (this.name == null ? 0 : this.name.hashCode());
        result = result * PRIME + (this.gender == null ? 0 : this.gender.hashCode());
        result = result * PRIME + (this.ssn == null ? 0 : this.ssn.hashCode());
        return result;
    }
}

@DATA

@Data 注解相当于 @ToString, @EqualsAndHashCode, @Getter 和 @Setter 注解的集合。

例子:

@Data(staticConstructor="of")
public class Company {
    private final Person founder;
    private String name;
    private List<Person> employees;
}

等同于

public class Company {
    private final Person founder;
    private String name;
    private List<Person> employees;
 
    private Company(final Person founder) {
        this.founder = founder;
    }
 
    public static Company of(final Person founder) {
        return new Company(founder);
    }
 
    public Person getFounder() {
        return founder;
    }
 
    public String getName() {
        return name;
    }
 
    public void setName(final String name) {
        this.name = name;
    }
 
    public List<Person> getEmployees() {
        return employees;
    }
 
    public void setEmployees(final List<Person> employees) {
        this.employees = employees;
    }
 
    @java.lang.Override
    public boolean equals(final java.lang.Object o) {
        if (o == this) return true;
        if (o == null) return false;
        if (o.getClass() != this.getClass()) return false;
        final Company other = (Company)o;
        if (this.founder == null ? other.founder != null : !this.founder.equals(other.founder)) return false;
        if (this.name == null ? other.name != null : !this.name.equals(other.name)) return false;
        if (this.employees == null ? other.employees != null : !this.employees.equals(other.employees)) return false;
        return true;
    }
 
    @java.lang.Override
    public int hashCode() {
        final int PRIME = 31;
        int result = 1;
        result = result * PRIME + (this.founder == null ? 0 : this.founder.hashCode());
        result = result * PRIME + (this.name == null ? 0 : this.name.hashCode());
        result = result * PRIME + (this.employees == null ? 0 : this.employees.hashCode());
        return result;
    }
 
    @java.lang.Override
    public java.lang.String toString() {
        return "Company(founder=" + founder + ", name=" + name + ", employees=" + employees + ")";
    }
}

@CLEANUP

@Cleanup 注解用于确保分配的资源能够释放掉。如果本地变量标记了 @Cleanup 注解,则子代码将会被 try/finally 块包围住。

例子:

public void testCleanUp() {
    try {
        @Cleanup ByteArrayOutputStream baos = new ByteArrayOutputStream();
        baos.write(new byte[] {'Y','e','s'});
        System.out.println(baos.toString());
    } catch (IOException e) {
        e.printStackTrace();
    }
}

等同于

public void testCleanUp() {
    try {
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        try {
            baos.write(new byte[]{'Y', 'e', 's'});
            System.out.println(baos.toString());
        } finally {
            baos.close();
        }
    } catch (IOException e) {
        e.printStackTrace();
    }
}

@SYNCHRONIZED

@Synchronized 注解在方法内添加 synchronized 同步代码块。

private DateFormat format = new SimpleDateFormat("MM-dd-YYYY");
 
@Synchronized
public String synchronizedFormat(Date date) {
    return format.format(date);
}

等同于

private final java.lang.Object $lock = new java.lang.Object[0];
private DateFormat format = new SimpleDateFormat("MM-dd-YYYY");
 
public String synchronizedFormat(Date date) {
    synchronized ($lock) {
        return format.format(date);
    }
}

@SNEAKYTHROWS

@SneakyThrows 注解是为了解决抛出异常时 IDE 提示“Unhandled exception ...”:
image

@SneakyThrows 注解实际就是抛出异常包装成 RuntimeException。

@SneakyThrows 注解加在方法上:

@SneakyThrows
public void testSneakyThrows() {
    throw new IllegalAccessException();
}

等同于:

public void testSneakyThrows() {
    try {
        throw new IllegalAccessException();
    } catch (java.lang.Throwable $ex) {
        throw lombok.Lombok.sneakyThrow($ex);
    }
}


sneakyThrow 方法:

public static RuntimeException sneakyThrow(Throwable t) {
    if (t == null) throw new NullPointerException("t");
    return Lombok.<RuntimeException>sneakyThrow0(t);
}

@SuppressWarnings("unchecked")
private static <T extends Throwable> T sneakyThrow0(Throwable t) throws T {
    throw (T)t;
}

标签:return,name,记录,private,Project,Lombok,null,public,String
From: https://www.cnblogs.com/lihw-study/p/16280912.html

相关文章

  • 国庆假期一点点记录
    国庆假期已经第三天了记录下前两天都做了什么第一天白天就是呆房间里,看《大秦帝国之裂变》顺便锻炼一下,讲商鞅变法的,现在看完了,确实是个好剧。秦公对商鞅是真的信任,商鞅......
  • Spring Lombok 实体类死循环问题
    在SpringJPA1对多查询的时候出现死循环的问题。如下图所示:  所有的配置都是正确的的,就是没有办法获得数据,并且出现死循环问题和解决因为使用lombak的 @Data......
  • git命令行记录
    gitinit:在项目所在的目录输入初始化git仓库gitremoteaddoriginhttps://github.comxxxxxxx:指定要提交的远程仓库地址gitadd.:注意add与‘.’之间有一个空格,此处为......
  • Map 笔记记录
    MapMap是一个存放二元Key-Value对的数据集合接口。在其中每个元素都对应于一个唯一的key,使用key可以获得对应的value。其有如下两个常用实现类:HashMapTre......
  • 2022-09-27 计划记录
    摘要:由于最近情况突变,需要重新设定计划.严重等级设置为当前最高等级。内容计划调整:一.保证对mysql内核理解在思想上的融合化需要大段的深入思考的时间需要投入巨大的......
  • 活动 做题记录
    小清新数据结构题题意是个人能看懂思路考虑维护一颗权值线段树。在这颗线段树上,我们把满足度越高的排在越前面,即编号越小。这可以通过对于原数组排序实现。接着,我们......
  • 中缀表达式转后缀、前缀记录
    波兰表示法与逆波兰表示法它们都是对表达式的记法,因此也被称为前缀记法、后缀记法。它们之间的区别在于运算符相对与操作数的位置不同:前缀表达式的运算符位于与其相关的操......
  • 记录一次vue模块安装路由失败
      仔细思考了一下应该是版本不匹配,我的vue版本是2.9.6但是我的router版本是  命令:cnpminstallvue-router@+版本号--save-dev实例:cnpminstallvue-router@......
  • [挑战记录]AKIOI
    \(20220607~\mathcal{AK}\times7\)\(20220929~\mathcal{AK}\times13\)\(20221002~\mathcal{AK}\times20\)......
  • [挑战记录]儒略历
    两年前就差点切掉,现在终于切了没什么好说的,就是用计算器进行手算年份#include<cstdio>#include<cstring>#include<string>#defineWRWinterRain#defineintlonglo......