“小辣椒”,Lombok

news/2024/10/31 1:35:15/

注:该文是本博主记录学习之用,没有太多详细的讲解,敬请谅解!

在Java项目里,每个JaveBean中我们都需要创建get/set方法,虽然idea中提供了快速构建get/set方法,但是每次增删改属性都需要维护它的get/set方法,特别麻烦。所以今天介绍Lombok插件,使我们平常在开发过程中提高效率,使JavaBean的代码可以至少省一半。

一、什么是Lombok

官网地址:https://www.projectlombok.org/

打开官网,首页上有它的简介,如下:

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.

翻译:Lombok是一个java库,可以自动插入编辑器并构建工具,为您的java增添色彩。
永远不要再写另一个getter或equals方法,使用一个注释,您的类具有一个功能齐全的构建器,自动化您的日志记录变量等等。

二、如何使用Lombok

1、安装插件和配置依赖

在这里插入图片描述
如上图所示,Lombok支持所有主流的 IDE 开发工具及编译构建工具,上图Bulid tool就是集成编译构建工具,IDEs就是各个ide开发工具的插件介绍。

因为本人使用的是Intellij IDEA,所以接下来介绍在IDEA中安装Lombok插件,使编译的时候不会报错。
点击上图的Intellij IDEA,跳转到官网的教程。

在这里插入图片描述
下面配上Intellij IDEA安装Lombok插件的教程…,因为我已经安装过Lombok插件,所以图下红色箭头之中的地方显示的是update按钮,如果未安装,这个按钮是绿色Install字样。
在这里插入图片描述
下面是 Maven 的依赖配置,在用 Maven 打包的时候也能自动生成需要的代码,在官网上点击
install–>maven。
在这里插入图片描述

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

如果你使用了 Spring Boot,可以不用带版本号,在 Spring Boot spring-boot-dependencies.pom 这个配置文件里面定义了 Lombok 依赖。
所以,你只需要继承版本号即可,当然,有必要的话,你也可以自定义版本号。

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

2、使用注解简化代码

在Lombok的包中我们可以看到所有支持的注解。
在这里插入图片描述
1、@Getter和@Setter

添加 @Getter 和 @Setter 注解用在 Java Bean 类上面,无需生成 get/ set 方法,会自动生成所有的 get/ set 方法及一个默认的构造方法。

在这里插入图片描述
2、@ToString

使用在类上,默认生成所有非静态字段以下面的格式输出。

public String toString(){return "User(userName=" + getUserName() + ", id=" + getId() + ", age=" + getAge() + ", address=" + getAddress() + ", memo=" + getMemo() + ")";
}

3、@NoArgsConstructor

使用在类上,默认生成一个无参的构造方法。

4、@RequiredArgsConstructor

使用在类上,使用类中所有带有 @NonNull 注解和 final 类型的字段生成对应的构造方法。

5、@AllArgsConstructor

用在类上,生成一个所有参数的构造方法,默认不提供无参构造方法。

6、@Data

用在类上,等同于下面这几个注解合集。

  • @Getter
  • @Setter
  • @RequiredArgsConstructor
  • @ToString
  • @EqualsAndHashCode

7、@Value

用在类上,等同于下面这几个注解合集。

  • @Getter
  • @FieldDefaults(makeFinal=true, level=AccessLevel.PRIVATE)
  • @AllArgsConstructor
  • @ToString
  • @EqualsAndHashCode

8、@NonNull

用在属性上,用于字段的非空检查,如果传入到 set 方法中的值为空,则抛出空指针异常,该注解也会生成一个默认的构造方法。

9、@Log4j
用在类上,为类提供一个 属性名为log 的 log4j 日志对像

等同于:private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(User.class);

10、@EqualsAndHashCode

用在类上,自动生成equals方法和hashCode方法

11、@Slf4j

@Slf4j跟Log4j一样,为类提供一个 属性名为log 的 Slf4j日志对像
等同于: private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(User.class);

=============================================
以上主要是讲解日常使用频繁的注解,还有更多注解,有兴趣的同学自行学习,谢谢!

附上Lombok api文档地址:https://projectlombok.org/api/overview-summary.html


http://www.ppmy.cn/news/520312.html

相关文章

eclipse安装lombok插件(小辣椒)

1、下载lombok.jar&#xff0c;lombok.jar官方下载地址&#xff1a;https://projectlombok.org/download 2、双击下载好的lombak.jar&#xff0c;安装步骤如下&#xff1a; 2-1.关闭弹出的警告窗口&#xff0c;点击 Specify location… 2-2.选择eclipse的安装目录 2-3.点击…

Lombok小辣椒的安装以及使用

说在前面&#xff1a; lombokk使得javabean变得方便&#xff0c;添加注解的方式就可以实现自动配置全参构造&#xff0c;无参构造&#xff0c;tostring方法&#xff0c;还有get和set方法。以及链式表达式。 以往的javaBean配置连点鼠标四下&#xff0c;当开发的表变多的时候配置…

如何安装lombok(小辣椒)

方法1: 第一步添加如下依赖 <dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId></dependency>依赖添加成功后找到下载的lombok-xxx.jar依赖所在的位置 右键找到Copy Qualified Name复制它的全限定名 使用…

SpringBoot 整合小辣椒 Lombok

一、下载 lombok.jar 文件 下载lombok.jar 二、运行下载的lombok.jar文件 打开cmd,使用java -jar (lombok.jar文件的目录) 三、打开安装窗口后,选择自己的 Eclipse 或者 STS 所在的根目录安装 四、添加依赖 <dependency><groupId>org.projectlombok</groupId…

IDEA中使用Lombok(小辣椒)

IDEA中使用Lombok目录 第一步&#xff0c;安装Lombok插件第二步&#xff0c;导入依赖第三步&#xff0c;使用方式常用注解使用实例&#xff1a; 第一步&#xff0c;安装Lombok插件 工作栏找到File>settings>Plugins 找到如图所示插件&#xff0c;并下载,之后按照提示重…

代码生成(小辣椒)

一、入门案例 1、开发环境 IDE:idea 2021.3.3 JDK:JDK8 构建工具:maven 3.5.4 MySQL版本:MySQL 8.13 Spring Boot:2.6.3 MyBatis-Plus:3.5.1 2、创建数据库及表 2.1、创建表 3、创建Spring Boot工程 3.1、使用 Spring Initializr 快速初始化一个 Spring Boot 工程 3.…

lombok (小辣椒)使用

1、安装 lombok安装就用maven下载的jar包, 用java -jar lombok1.16.18.jar或者直接双击打开如下&#xff1a; 然后选择IDE安装目录即可安装. 安装好之后再ide 的outline 中才能有对应的方法 API文档: https://projectlombok.org/api/lombok/ToString.html NoArgsConstructo…

小辣椒2019_小辣椒视频最新版

软件介绍 小辣椒视频最新版是一款最新的视频播放软件&#xff0c;该软件提供的视频内容非常的新颖&#xff0c;小辣椒视频最新版能够满足大部分用户的使用需求&#xff0c;还有多个非常有趣的模块内容等你前来发现&#xff0c;喜欢的小伙伴快来下载体验一番吧! 软件特色 1.该软…