Lombok 介绍和使用详情

最新推荐文章于 2024-04-25 14:49:37 发布
最新推荐文章于 2024-04-25 14:49:37 发布
阅读量400 收藏
点赞数
分类专栏： √ 项目功能总结 文章标签： lombok
原文链接：www.java1000.com
版权

介绍

在项目中使用Lombok可以减少很多重复代码的书写。比如说getter/setter/toString等方法的编写。

IDEA中的安装

打开IDEA的Setting –> 选择Plugins选项 –> 选择Browse repositories –> 搜索lombok –> 点击安装 –> 安装完成重启IDEA –> 安装成功
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-8Wxu6puV-1626182323785)(http://1.file.leanote.top/5a54370fab644126e2000c44/1515465239279_2.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:ECrRjWgXnbUD3XO3DQfOybg-xPc)]

引入依赖

在项目中添加Lombok依赖jar，在pom文件中添加如下部分。(不清楚版本可以在Maven仓库中搜索)

<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.16.18</version>
    <scope>provided</scope>
</dependency>

使用

在对应的类或者方法上使用对应注解即可。

Lombok有哪些注解

  • @Setter
  • @Getter
  • @Data
  • @Log(这是一个泛型注解，具体有很多种形式)
  • @AllArgsConstructor
  • @NoArgsConstructor
  • @EqualsAndHashCode
  • @NonNull
  • @Cleanup
  • @ToString
  • @RequiredArgsConstructor
  • @Value
  • @SneakyThrows
  • @Synchronized

注解详情

log

注解在 类 上。有如下可选择可用：

//@CommonsLog
private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);
//@JBossLog
private static final org.jboss.logging.Logger log = org.jboss.logging.Logger.getLogger(LogExample.class);
//@Log
private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName());
//@Log4j
private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class);
//@Log4j2
private static final org.apache.logging.log4j.Logger log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);
//@Slf4j
private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class);
//@XSlf4j
private static final org.slf4j.ext.XLogger log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);

默认情况下，记录器的主题（或名称）将是使用注释进行@Log注释的类的类名称。这可以通过指定topic参数来定制。例如：@XSlf4j(topic="reporting")。

该类型注解可以满足不同的日志系统的日志使用，Lombok提供了一些自定义配置项可以参看官方说明文档。

Log官方介绍

@Getter和@Setter

该注解使用在类或者属性上，该注解可以使用在类上也可以使用在属性上。生成的getter遵循布尔属性的约定。例如：boolean类型的sex,getter方法为isSex而不是getSex

在使用该注解时，会默认生成一个无参构造。和对应的getterhe setter方法
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-1XlicXQE-1626182323786)(http://1.file.leanote.top/5a54370fab644126e2000c49/1515466096955_4.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:_z0z0eT_f5KIjw8coUCwgOPBiy8)]

该注解也可以使用在单个属性上，会默认生成一个无参构造：
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-T7eXqMiW-1626182323787)(http://1.file.leanote.top/5a54370fab644126e2000c48/1515466294316_5.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:vRO2cgQmWTXc6JehUN8H8foZDoM)]

@Data

该注解使用在类上，该注解会提供getter、setter、equals、canEqual、hashCode、toString方法。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-kZ3TLKRn-1626182323787)(http://1.file.leanote.top/5a54370fab644126e2000c43/1515466806437_6.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:K2BqAPlrfIj6nk1VyDkxv30ldfk)]

@NonNull

该注解使用在属性上，该注解用于属的非空检查，当放在setter方法的字段上，将生成一个空检查，如果为空，则抛出NullPointerException。
该注解会默认是生成一个无参构造。
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-KedikOaL-1626182323789)(http://1.file.leanote.top/5a54370fab644126e2000c47/1515467159376_7.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:0XIqPQzaJbSu9J-y51X_-lbXDDE)]

@toString

该注解使用在类上，该注解默认生成任何非讲台字段以名称-值的形式输出。
1、如果需要可以通过注释参数includeFieldNames来控制输出中是否包含的属性名称。
2、可以通过exclude参数中包含字段名称，可以从生成的方法中排除特定字段。
3、可以通过callSuper参数控制父类的输出。

  • includeFieldNames是否包含属性名称：
    [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-itT8rOPV-1626182323790)(http://1.file.leanote.top/5a54370fab644126e2000c42/1515467459770_8.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:KJKqvKXu0OldtrJUPekOe3S9ntI)]

  • exclude 排除指定字段
    [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-6obeCfoR-1626182323791)(http://1.file.leanote.top/5a54370fab644126e2000c45/1515468047413_9.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:zsKgxa2gTCpElZSWULvxn0aUef0)]

  • callSuper输出父类属性
    [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-OSZU4xTp-1626182323792)(http://1.file.leanote.top/5a543c1aab644126e2000d38/1515469434112_10.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:IqeKwFLMTuPPMpTtjedZLc6ddgE)]

注意：父类也要有toString方法，不然打印的是对象内存地址

//父类无toString方法
Person(super=com.motui.Person@3abfe836, firstName=motui, address=北京, dateOfBirth=Tue Jan 09 11:49:05 CST 2018, sex=true)
//父类有toString方法
Person(super=People(id=111), firstName=motui, address=北京, dateOfBirth=Tue Jan 09 11:50:11 CST 2018, sex=true)
@EqualsAndHashCode

该注解使用在类上，该注解在类级别注释会同时生成equals和hashCode。
注意继承关系的时候该注解的使用。详细介绍参照官方介绍
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-fRuCmuQ1-1626182323792)(http://1.file.leanote.top/5a543f5dab644126e2000d85/1515470235374_11.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:sjZmfKM8d3vCdzGvL5KwQeOzYP0)]

存在继承关系需要设置callSuper参数为true。

@Data

该注解使用在类上，该注解是最常用的注解，它结合了@ToString，@EqualsAndHashCode， @Getter和@Setter。本质上使用@Data注解，类默认@ToString和@EqualsAndHashCode以及每个字段都有@Setter和@getter。该注解也会生成一个公共构造函数，可以将任何@NonNull和final字段作为参数。

虽然@Data注解非常有用，但是它没有与其他注解相同的控制粒度。@Data提供了一个可以生成静态工厂的单一参数，将staticConstructor参数设置为所需要的名称，Lombok自动生成的构造函数设置为私有，并提供公开的给定名称的静态工厂方法。
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-wG4cFd7M-1626182323793)(http://1.file.leanote.top/5a546265ab644126e2001263/1515476412751_12.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:qp8aGxlfa2DcAnWco2d57bk2C-w)]

@AllArgsConstructor

该注解使用在类上，该注解提供一个全参数的构造方法，默认不提供无参构造。
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-vRhg5MFG-1626182323794)(http://1.file.leanote.top/5a546265ab644126e2001260/1515478142533_16.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:UO-4ANEldw7j5lZuR66tEWy-4io)]

@NoArgsConstructor

该注解使用在类上，该注解提供一个无参构造
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-774Dk3A0-1626182323794)(http://1.file.leanote.top/5a546266ab644126e2001264/1515478200493_17.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:ng0PugDk_lmiDlCNC1IIrrMxZ3U)]

@RequiredArgsConstructor

该注解使用在类上，使用类中所有带有 @NonNull 注解的或者带有 final 修饰的成员变量生成对应的构造方法。

@Value

这个注解用在 类 上，会生成含所有参数的构造方法，get 方法，此外还提供了equals、hashCode、toString 方法。
注意：没有setter

@Cleanup

该注解使用在属性前，该注解是用来保证分配的资源被释放。在本地变量上使用该注解，任何后续代码都将封装在try/finally中，确保当前作用于中的资源被释放。默认@Cleanup清理的方法为close，可以使用value指定不同的方法名称。
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-nZQZAVZR-1626182323795)(http://1.file.leanote.top/5a546266ab644126e2001266/1515476968925_13.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:Fvl9zn1Xyw34UHGa3aatB03-pDs)]

@Synchronized

该注解使用在类或者实例方法上，Synchronized在一个方法上，使用关键字可能会导致结果和想要的结果不同，因为多线程情况下会出现异常情况。Synchronized
关键字将在this示例方法情况下锁定当前对象，或者class讲台方法的对象上多锁定。这可能会导致死锁现象。一般情况下建议锁定一个专门用于此目的的独立锁，而不是允许公共对象进行锁定。该注解也是为了达到该目的。

@SneakyThrows

该注解使用在方法上，这个注解用在 方法 上，可以将方法中的代码用 try-catch 语句包裹起来，捕获异常并在 catch 中用 Lombok.sneakyThrow(e) 把异常抛出，可以使用 @SneakyThrows(Exception.class) 的形式指定抛出哪种异常。该注解需要谨慎使用。详情参看官方介绍

结语

Lombok的目的是减少代码的重复编写，并提供比较好的解决方案。当然也存在一些争议性的注解，可以根据实际场景进项使用。Lombok有一些实验注解可以在官网查看。

出处：https://blog.csdn.net/motui/article/details/79012846

hello-java-maker
关注
专栏目录
Lombok原理及使用
Jinghua_Guo的博客
04-29 456
前言 项目中使用到了Lombok，但对于它的实现原理以及缺点却知之甚少，而本文将会从Lombok的原理出发，手动实现一个简易版的Lombok，来理解这个热门技术背后的执行原理，以及它的优缺点。 1. 简介 Lombok 是一个非常热门的开源项目 (https://github.com/rzwitserloot/lombok)，可以通过简单的注解的形式来帮助我们简化消除一些必须有但显得很臃肿的...
lombok 基础注解之 @Builder
热门推荐
用善良的眼光看世界
10-24 9万+
最全的 lombok 注解详情（随着版本不定时更新） @Builder 注解为类生成相对略微复杂的构建器 API。可以以下面形式调用代码，初始化实例对象生成的对象是不可以变的，如果需要在原来的基础上修改可以加 set 方法 final 字段可以不需要初始化，可以在创建对象的时候进行赋值。它会生成一个全参的构造函数 一、属性介绍 @Builder.Default：非 final 的字段可以有默认值 builderMethodName：指定创建内部静态类的方法名，默认值为 builder build
@Data、@Setter、@Getter的介绍
weixin_42602241的博客
01-17 2691
@Data、@Setter、@Getter是Lombok库中的注解。 @Data注解是一个组合注解，包含了@ToString、@EqualsAndHashCode、@Getter和@Setter等注解。使用@Data注解可以省略生成getter和setter方法、toString方法、hashCode方法和equals方法的样板代码。 @Setter注解用于生成setter方法，通过使用@Sett...
并发编程笔记(上)
weixin_53060535的博客
05-21 633
并发编程笔记（上）
AQS使用解析
Xjzzon的博客
01-28 171
AbstractQueuedSynchronizer AQS是基于FIFO队列的实现，AQS使用了模板方法的设计模式,以ReentranLock为例子获取独占锁时 ReentranLock.lockReentranLock.Sync.lockAbstractQueuedSynchronizer.acquireReentranLock.Sync.tryAcquire AbstractQueuedSy...
Synchronized关键字
＊King＊的博客
12-14 363
锁：对象当中的一个标识 加锁：就是去改变这个对象的标识的值 加锁成功：让方法正常返回 加锁失败：让失败的这个线程死循环或者阻塞 对象由对象头，实例数据，对齐填充组成。（图） 一般家用笔记本都是小端模式：高字节存在高地址，低字节存在低地址 偏向锁：先判断是否可偏向，然后判断是否偏向了，拿到当前的线程id，通过cas，设置到对象头 总结 当一把锁第一次被线程持有的时候是偏向锁， 如果这个线程再次加锁还是偏向锁， 如果别的线程来加锁（交替执行）膨胀为轻量锁， 如果是资源竞争膨胀为重量锁。 CAS c
【ruoyi-vue】关于slf4j日志使用
最新发布
qq_35226176的博客
04-25 1979
系列文章目录 【ruoyi-vue】 关于slf4j日志使用 文章目录系列文章目录一、slf4j概述二、使用slf4j1.代码方式使用Slf4j2.lombok使用注解引入@Slf4j3.对关键模块单独记录日志文件三、配置slf4j1.项目配置2.改造3. 日志级别及优先级四、logback.xml配置文件解析1.定义日志文件的存储地址2.定义日志格式 一、slf4j概述 SLF4J（Simple Logging Facade for Java）是一个简单的日志门面，允许使用者在应用程序中使用不同的日志实现
Lombok快速入门及使用详情
08-03
下面我们将详细介绍 Lombok 的使用详情。 1. 安装 IDEA Lombok 插件 要使用 Lombok，首先需要安装 IDEA Lombok 插件。在 IDEA 中，点击 File -> Settings -> Plugins，然后搜索 Lombok 插件并安装。 2. 加入 ...
lombok 1.18.24
05-26
综上，Lombok 是一个强大的工具，可以显著提高 Java 项目的代码质量和开发效率，但使用时也需要注意其潜在的问题和限制。了解并熟练掌握 Lombok，可以帮助开发者更好地实现代码的简洁性和可维护性。
lombok 外部注解之日志注解
用善良的眼光看世界
11-12 1725
最全的 lombok 注解详情（随着版本不定时更新） 一、注解介绍 作用于类，生成对应的 log 对象，用于记录日志，共有七个注解： @CommonsLog：org.apache.commons.logging.Log @Log：java.util.logging.Logger @JBossLog：org.jboss.logging.Logger @Log4j：org.apache.log4j.Logger @Log4j2：org.apache.logging.log4j.Logger @Slf4j：org
Java并发编程（一）
weixin_43961117的博客
10-26 235
这里写目录标题自我基础一、进程和线程图总概念并行和并发应用同步和异步应用之提高效率（案例1）二、Java线程创建和运行进程观察多个线程同时运行线程运行原理栈与栈帧线程上下文切换（Thread Context Switch）Java线程的常用方法run和startsleep和yield 自我基础 一个核心只运行一个线程，每个核心会轮询分配时间片（windows为15ms）给任务调度器里就绪的线程，每个线程运行15ms就等待，先到下一个，如此反复。人的正常感应时间为100ms左右。 一、进程和线程 图总概念
Lombok常见用法总结——@Data,@Getter,@Setter,@NotNull,@ToString,@HashCode,@Builder等
weixin_44712778的博客
03-07 3244
lombok常用注释及用法示例
【开发经验】SpringBoot日志SLF4j+Logback日志模块化
叁滴水 的博客
09-27 1065
如果你看到我这个文章，想必肯定是受到了生产环境查日志的折磨了吧。在生产环境中没有ELK这种日志查询工具时，通过日志的模块化，区分文件，可以更加快速的定位到日志信息。例如：订单日志，请求日志、响应日志、服务间互相调用日志等等。
SpringBoot优雅地配置日志
JAVA葵花宝典
10-09 364
本文主要给大家介绍SpringBoot中如何通过sl4j日志组件优雅地记录日志。其实，我们入门 JAVA 的第一行代码就是一行日志，那你现在还在使用System.out....
eclipse,idea安装lombok,以及lombok的使用
CNZYYH的博客
12-29 3096
Lombok是一种Java实用工具，可以帮助开发人员消除Java的冗长，具体看lombok的官网：http://projectlombok.org/ 安装步骤： 　　1.下载lombok.jar包 　　2.将lombok.jar包复制到myeclipse.ini/eclipse.ini所在文件目录 　　3.打开myeclipse.ini/eclipse.ini，在最后添加以下代码并保存： ...
@Data与@Getter@Setter区别
清欢01的博客
10-08 4218
1)@Data注解相对于@Getter注解与@Setter注解编译后文件新增了equals()方法，canEqual()方法，hashCode()方法，toString()方法2)@Data注解可以作用在类上 为所有属性提供 getter()方法，setter()方法，equals()方法，canEqual()方法，hashCode()方法，toString()方法.@Getter注解与@Setter注解注解在属性上:为属性提供 getter方法与setter方法；
java 线程的常用方法
weixin_41908066的博客
09-27 251
线程的常用方法 ： 2.start 和 run @Slf4j(topic = "c.Test1") public class ThreadTest1 { public static void main(String[] args) { Thread t1 = new Thread() { @Override public void run() { log.debug("running1....").
Slf4j使用
tuhaogecb的博客
08-10 339
前言：如果不想每次都写private final Logger logger = LoggerFactory.getLogger(XXX.class);可以用注解@Slf4j 一、加入依赖 <!-- 引入@Slf4j,Data--> <dependency> <groupId>org.projectlombok</g...
Java枚举类使用Lombok
心之所往 码之所向
06-12 1万+
枚举类是一个特殊的常量类，由于其特殊的设计，具有简洁性、安全性以及便捷性，在开发中被普遍使用。本文简单介绍一下如何使用Lombok进行枚举类定义。
Lombok快速入手：安装、使用与关键注解详解
本文将详细介绍如何快速上手Lombok，包括安装、配置和使用过程中常见的注解及其功能。 首先，安装Lombok是使用的关键步骤。在你的项目中，你需要添加Lombok的依赖到你的Maven或Gradle构建工具中，例如，添加以下...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值