lombok基础

已于 2024-04-02 08:43:07 修改
阅读量61 收藏
点赞数
文章标签： intellij-idea java intellij idea
于 2022-05-18 16:51:48 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/sooooof/article/details/124846043
版权

强大的lombok插件

原文：https://blog.csdn.net/love_caicai/article/details/82356438
参考：https://projectlombok.org/features/Data

最近做一个项目,发现实体类中仅仅只是定义了变量,没有任何setter,getter,方法,也没有构造函数,但是却可以正常的调用,仔细查看后发现类上比之前所见的类多了一些注解,@Data,@EqualsAndHashCode.经过多方查找,终于大概弄明白了,现在写出来一方面巩固自己所学,顺便供大家参考,有说的不好的地方,欢迎大家指出,共同进步…

一、Lombok是什么

现在看一下Lombok官方对其进行的解释：Lombok官网：https://projectlombok.org

Lombok项目是一种自动接通你的编辑器和构建工具的一个Java库。不用再一次写额外的getter或者equals方法。由此可以看出，lombok会帮我们自动生成getter和euqals方法,但是更有意思的是,当我们的变量发生改变时,我们不再需要修改对的getter、setter方法,lombok帮我们在运行的过程中自动生成上述方法,编码更灵活.

所以,使用lombok的优点:
1、简化long冗余的javabean代码;
2、提高执行效率

二、如何使用Lombok

1.lombok插件的安装

1.1 首先我们需要安装IntelliJ IDEA中的lombok插件，打开IntelliJ IDEA后点击菜单栏中的File–>Settings，或者使用快捷键Ctrl+Alt+S进入到设置页面。

在这里插入图片描述

1.2 我们点击设置中的Plugins进行插件的安装，在右侧选择Browse repositories…，然后在搜索页面输入lombok变可以查询到下方的Lombok Plugin，鼠标点击Lombok Plugin可在右侧看到Install按钮，点击该按钮便可安装。

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

1.3我们在安装页面可以看到lombok具体支持的所有注解，在安装过程中有Downloading Plugins的提示，安装过程中进度条会变化。需要提醒的是，在安装过程中一定要保证网络连接可用且良好，否则可能会安装失败。安装成功后我们可以看到右侧的Restart按钮，此时可先不操作，因为我们还有后续的配置工作。安装完成后我们再回到Plugins，此时在右侧可以搜索到lombok，而安装前是不行的。

在这里插入图片描述

2. 引入依赖：（版本自行选择）

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

3.创建实体类

package com.Day5;

import cn.afterturn.easypoi.excel.annotation.Excel;
import cn.afterturn.easypoi.excel.annotation.ExcelTarget;
import lombok.Data;

import java.io.Serializable;

@Data//这个是lombok插件(推荐)添加此注解相当于是get,set,toString等一次性全部自动生成
@ExcelTarget("studentEntity")
public class Student implements Serializable
{
    private static final long serialVersionUID = 1L;
    @Excel(name = "序号",isImportField = "true",orderNum = "1")
    private Integer serialNum;
    @Excel(name = "学校",isImportField = "true",orderNum = "2")
    private String schoolName;
    @Excel(name = "姓名",isImportField = "true",orderNum = "3")
    private String studentName;
    @Excel(name = "右眼",isImportField = "true",orderNum = "4")
    private String odVision;
    @Excel(name = "左眼",isImportField = "true",orderNum = "5")
    private String osVision;
}

4.测试

package com.Day5;

/**
 * @author 
 * @create 2020-07-07 18:13
 */
public class Test
{
    public static void main(String[] args)
    {
        Student student = new Student();
        student.setStudentName("张三");
        student.setSchoolName("清华大学");
        student.setSerialNum(1);
        student.setOdVision("5.0");
        student.setOsVision("5.0");
        System.out.println(student);
    }
}

5.打印结果：


Student(serialNum=1, schoolName=清华大学, studentName=张三, odVision=5.0, osVision=5.0)

Process finished with exit code 0

是不是感觉lombok很强大，事实也是如此

三、lombok中的常用注解

  • @Setter ：在JavaBean或类JavaBean中使用，使用此注解会生成对应的setter方法；
  • @Getter：在JavaBean或类JavaBean中使用，使用此注解会生成对应的getter方法；
  • @ToString：在JavaBean或类JavaBean中使用，使用此注解会自动重写对应的toStirng方法；
  • @NoArgsConstructor：在JavaBean或类JavaBean中使用，使用此注解会生成对应的无参构造方法；
  • @HashCode：
  • @Equals：
  • @CanEqual：
  • @Data：在JavaBean或类JavaBean中使用，这个注解包含范围最广，它包含上述注解，即当使用当前注解时，会自动生成包含的所有方法；
  • @AllArgsConstructor：在JavaBean或类JavaBean中使用，使用此注解会生成对应的有参构造方法；
  • @Log(这是一个泛型注解，具体有很多种形式)
  • @EqualsAndHashCode：在JavaBean或类JavaBean中使用，使用此注解会自动重写对应的equals方法和hashCode方法；

  1. 此注解会生成equals(Object other) 和 hashCode()方法。

  2. 它默认使用非静态，非瞬态的属性

  3. 可通过参数exclude排除一些属性

  4. 可通过参数of指定仅使用哪些属性

  5. 它默认仅使用该类中定义的属性且不调用父类的方法

  6. 可通过callSuper=true解决上一点问题。让其生成的方法中调用父类的方法。

  • @Slf4j：在需要打印日志的类中使用，当项目中使用了slf4j打印日志框架时使用该注解，会简化日志的打印流程，只需调用info方法即可；
  • @Log4j：在需要打印日志的类中使用，当项目中使用了log4j打印日志框架时使用该注解，会简化日志的打印流程，只需调用info方法即可；

在使用以上注解需要处理参数时，处理方法如下（以@ToString注解为例，其他注解同@ToString注解）
@ToString(exclude=“column”)

意义：排除column列所对应的元素，即在生成toString方法时不包含column参数；

@ToString(exclude={“column1”,“column2”})

意义：排除多个column列所对应的元素，其中间用英文状态下的逗号进行分割，即在生成toString方法时不包含多个column参数；

@ToString(of=“column”)

意义：只生成包含column列所对应的元素的参数的toString方法，即在生成toString方法时只包含column参数；；

@ToString(of={“column1”,“column2”})

意义：只生成包含多个column列所对应的元素的参数的toString方法，其中间用英文状态下的逗号进行分割，即在生成toString方法时只包含多个column参数；

@Data 一般和@EqualsAndHashCode同时使用，因为：

通过官方文档，可以得知，当使用@Data注解时，则有了@EqualsAndHashCode注解，那么就会在此类中存在equals(Object other) 和 hashCode()方法，且不会使用父类的属性，这就导致了可能的问题。

比如，有多个类有相同的部分属性，把它们定义到父类中，恰好id（数据库主键）也在父类中，那么就会存在部分对象在比较时，它们并不相等，却因为lombok自动生成的equals(Object other) 和 hashCode()方法判定为相等，从而导致出错。

  1. 使用@Getter @Setter @ToString代替@Data并且自定义equals(Object other) 和 hashCode()方法，比如有些类只需要判断主键id是否相等即足矣。

  2. 或者使用在使用@Data时同时加上@EqualsAndHashCode(callSuper=true)注解。


三、基本注解的使用（注解属性非必选）
@AllArgsConstructor：作用于类，生成参数为所有实例变量的构造函数
@Builder：作用于类，将其变成建造者模式
@Cleanup：作用于变量，自动关闭资源，针对实现了 java.io.Closeable 接口的对象有效
@CustomLog：自定义日志类，生成 log 对象
@Data：作用于类，是以下注解的集合：@ToString @EqualsAndHashCode @Getter @Setter @RequiredArgsConstructor
@EqualsAndHashCode：作用于类，覆盖默认的 equals 和 hashCode1
@Generated：用于标记类、变量、方法是自动生成的，没什么大用
@Getter：作用于类，生成该类所有的实例变量的 getter 方法。作用于变量，生成变量的 getter 方法
@NoArgsConstructor：作用于类，生成无参构造方法
@NonNull：作用于成员变量和参数中，标识不能为空，否则抛出空指针异常
@RequiredArgsConstructor：作用于类，生成包含 final 和 @NonNull 注解的成员变量的构造方法
@Setter：作用于类，生成该类所有的实例变量的 setter 方法。作用于变量，生成该变量的 setter 方法
@Singular：作用于集合字段，需要配合 @Builder 使用2
@SneakyThrows：作用于方法，对异常进行捕捉并抛出
@Synchronized：作用于方法，可以替换 synchronized 关键字或 lock 锁
@ToString：作用于类，覆盖默认的 toString() 方法
@val：作用于类、变量，主要用于声明变量的类型，注解将从初始化程序表达式中推断类型，生成的变量是 final 不可以变
@Value：作用于类，是以下注解的集合：@ToString @EqualsAndHashCode @Getter @RequiredArgsConstructor
@var：和 @val 一样，两者区别在于 var 不加 final
@With：作用于类、变量，生成 with + 变量名的方法，返回当前对象
四、外部注解的使用
@CommonsLog，@Log，@JBossLog，@Log4j，@Log4j2，@Slf4j，@XSlf4j：日志注解，作用于类
五、实验性注解的使用
@Accessors：类似于 @Builder 支持链式调用，需要配合 @Setter、@Getter 等注解使用，作用于类、变量
@Delegate：作用于容器变量，为该变量生成一堆常用的方法，这些方法都是容器中的方法
@ExtensionMethod：作用于类，向类添加方法，无需创建新的子类
@FieldDefaults：作用于类，定义变量的访问修饰符以及是否加 final
@FieldNameConstants：作用于类，生成一个包含所有成员变量的内部类或者内部枚举，内部类中每个字段值即为字段名并且值不可变
@Helper：作用于方法内部类，使内部类中的方法暴露在外面可以被直接调用，不建议使用
@NonFinal：作用于类、变量，表示变量不加 final
@PackagePrivate：作用于类和变量，相当于访问修饰符的 default，没什么用
@SuperBuilder：支持对于基类成员变量赋值，算是 @Builder 的升级版
@Tolerate：实现对冲突的兼容，作用于方法上，没什么大用，可以配合 @Builder 使用
@UtilityClass：作用于类，将类标记为 final，并且类、内部类中的方法、字段都标记为 static
@WithBy3
六、基于 v1.18.22 版本的实验性注解
@StandardException：自定义异常类
七、Lombok 的优缺点
优点：
能通过注解的形式自动生成构造器、getter / setter、equals、hashcode、toString 等方法，提高了一定的开发效率
让代码变得简洁，不用过多的去关注相应的方法
属性做修改时，也简化了维护为这些属性所生成的 getter / setter 方法等

缺点：
不支持多种参数构造器的重载
虽然省去了手动创建一系列方法的麻烦，但大大降低了源代码的可读性和完整性，降低了阅读源代码的舒适度

八、待完善的
@EqualsAndHashCode.Include(replaces = “”) ↩︎

@Singular 中的 ignoreNullCollections 属性待完善 ↩︎

@WithBy ↩︎

S妖O风F
关注
lombok 基础注解之 @Singular
用善良的眼光看世界
11-01 5391
最全的 lombok 注解详情（随着版本不定时更新） 一、注解介绍 作用于集合字段，需要配合 @Builder 使用 使用 @Singular 注解一个集合字段（如果没有指定 value 属性值，那么集合字段名需要是复数形式），会生成两个添加元素方法 一个向集合添加单个元素（方法名：集合字段名的单数形式 / value 属性值） 一个将另一个集合的所有元素添加到集合中（方法名：集合字段名） 还生成了 clear 方法（方法名：clear + 集合字段名，驼峰命名）。 这些 singular 构建器相对而言
lombok 基础注解之 @Builder
用善良的眼光看世界
10-24 9万+
最全的 lombok 注解详情（随着版本不定时更新） @Builder 注解为类生成相对略微复杂的构建器 API。可以以下面形式调用代码，初始化实例对象生成的对象是不可以变的，如果需要在原来的基础上修改可以加 set 方法 final 字段可以不需要初始化，可以在创建对象的时候进行赋值。它会生成一个全参的构造函数 一、属性介绍 @Builder.Default：非 final 的字段可以有默认值 builderMethodName：指定创建内部静态类的方法名，默认值为 builder build
Lombok @Builder，如何使用泛型
guangyingposuo的博客
06-16 7019
最近需要项目中使用@Builder，创建对象就不能直接new了，使用泛型时遇到问题。 @Data @Builder public class Page<T> { /** * 总数 */ @Builder.Default private Integer total = 0; /** * 详细行数据 */ private List<T> rows; } 创建Page对象时编译报错，那如何使用
java之lombok的构建者模式Builder中的泛型写法
热门推荐
Good Luck
12-24 12万+
引入Lombok改造统一返回值模板的时候,打算放弃new对象的模式,采用了Lombok的Builder的构建者模式,但是构建时候无法带上泛型,百度后没有相关写法。看了一下源码写法如下: 目录 第一步：编码 第二步：使用: 第三步：测试 第一步：编码 public static <T>AjaxResult<T> success(T data) { ...
JAVA&Lombok Builder模式 泛型＜T＞使用
大西瓜的博客
03-30 6396
JAVA&Lombok Builder模式 泛型 <T> 使用 @Data @Builder public class ResponseResultVO<T> { private long code; private String msg; private T data; } 1、Lombok Builder 使用 ResponseResultVO<SysUsers> vo = ResponseResultVO.<SysUs
Lombok使用
最新发布
勇往直前，向死而生
12-30 122
lombok
泛型你真的了解吗
chengyunyi的专栏
01-04 1418
你需要掌握的：基本用法 泛型擦除 泛型类/泛型方法/泛型接口 泛型关键字 反射泛型 和泛型的初次见面泛型是JDK1.5以后才有的， 可以在编译时期进行类型检查，且可以避免频繁类型转化。很明显，使用Java泛型，我们可以省掉强制类型转换。编译器会保留参数的类型信息，执行类型检查，执行类型转换操作。因此开发人员不需要自己确保类型转换的安全性，而把这个交给编译器去做。基本使用 public void
lombok 基础注解之 @With
用善良的眼光看世界
11-12 2593
最全的 lombok 注解详情（随着版本不定时更新） 一、注解介绍 作用于类，生成多个 with + 变量名的方法（个数为所有成员变量，不包含 @NonNull），作用于变量，生成 with + 变量名的方法 返回当前对象，需要提供全参（不包含静态变量）构造方法 二、属性介绍 value：设置 with 方法的访问修饰符 共有 PUBLIC、MODULE、PROTECTED、PACKAGE、PRIVATE、NONE MODULE 是 Java 9 的新特性，NONE 表示不生成 with 方法，即停用注解
lombok 基础注解之 @Builder.ObtainVia
用善良的眼光看世界
01-18 2774
最全的 lombok 注解详情（随着版本不定时更新），lombok 基础注解之 @Builder 一、注解介绍 表示变量从什么地方获取值，只有当 toBuilder = true 时才生效 二、属性介绍 field：表示字段赋值时从某个字段上取值，对应的字段必须存在 method：表示字段赋值时从某个方法上取值，对应的方法必须存在 isStatic：表示 method 是否静态 三、实战演练 @Builder(toBuilder = true) public class 吴宣仪 { private S
Lombok基础组件整合与应用指南
4. **项目优化整合Lombok基础组件**: 在实际项目中，将Lombok的基础组件整合到微博项目中可以显著提升开发效率。这涉及到将Lombok的注解应用到项目中的各个类，确保IDE能够理解和利用这些注解带来的便利性。 5. **...
lombok 基础注解之 @AllArgsConstructor
用善良的眼光看世界
10-24 3万+
最全的 lombok 注解详情（随着版本不定时更新） 一、属性介绍 staticName：生成的构造函数是私有的，并且生成一个返回实体类且方法名为 staticName 值的参数为所有实例变量的静态工厂方法 onConstructor：列出的所有注解都放在生成的构造函数上 JDK 7 之前的写法 onConstructor = @__({@AnnotationsGoHere})，JDK 8 之后的写法 onConstructor_ = {@AnnotationsGohere} access：设置构造函数的
eclipse,idea安装lombok,以及lombok的使用
CNZYYH的博客
12-29 3143
Lombok是一种Java实用工具，可以帮助开发人员消除Java的冗长，具体看lombok的官网：http://projectlombok.org/ 安装步骤： 　　1.下载lombok.jar包 　　2.将lombok.jar包复制到myeclipse.ini/eclipse.ini所在文件目录 　　3.打开myeclipse.ini/eclipse.ini，在最后添加以下代码并保存： ...
工作中的思考，如何优雅的创建对象
方圆 Blog
11-10 799
这篇博客儿主要是关于`建造者模式在创建对象时的应用`，这已经成了我现在写代码的习惯，它在灵活性和代码整洁程度上，都让我十分满意。以下的内容非常的长，也是博主费尽心力去完成的一篇博客儿，从初次应用建造者模式，到发现Lombok方便的注解，最后深挖Lombok的源码，大家既`可以简单的学会它的应用`，也`可以从源码的角度来弄清楚它为什么是这样儿`，就看你有什么需求了！
lombok与java Build模式结合
青蛙的博客
01-03 2713
build模式可以解决构造器多个参数不易阅读 传统的手写build方式 public class User { private String name; private Integer id; private Integer sex; public static class Builder{ private String name; ...
lombok @EqualsAndHashCode 注解的影响
飞上云端看彩虹
02-26 495
通过查询官方文档得知如下信息： 1. 此注解会生成equals(Object other) 和 hashCode()方法。  2. 它默认使用非静态，非瞬态的属性  3. 可通过参数exclude排除一些属性  4. 可通过参数of指定仅使用哪些属性  5. 它默认仅使用该类中定义的属性且不调用父类的方法  6. 可通过callSuper=true解决上一点问题。让其生成的方法中调用父类的方法。...
lombok 不兼容的类型: Data无法转换为Annotation
qdqht2009的专栏
04-15 2903
项目中泛型类中使用了@Data导致lombok失败 lombok 不兼容的类型: Data无法转换为Annotation 去掉后换成自己生成后，其他部分也变正常了 public class ExportEvent<Data> extends ApplicationEvent { /** * Create a new ApplicationEvent. ...
lombok中的坑之一
wocaishiryr的博客
11-16 4053
今天在和前端调试接口时发现用lombok@Data,或@Getter/@Setter标注的对象的属性字母大小写有问题 这个看起来也没毛病 但是前端传tAreaId就是封装不上, 用swagger看了一下,swagger是可以正常调用的,但是鸡贼的swagger是用的 tareaId而不是用的tAreaId  ...
发现神奇的lombok
sd6733531的专栏
02-09 8051
项目主页:http://projectlombok.org/index.html 源码github主页:https://github.com/rzwitserloot/lombok/tree/master/src lombok这个名字很大名鼎鼎的j2ee插件lomboz十分相像。lombok貌似也是一个插件,但是它的功能强大得有些让人难以置信。 我们先来看看为什么需要lombok?
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值