Lombok的使用

原创 已于 2024-05-26 00:04:56 修改 · 554 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#eclipse #java

于 2020-02-06 23:04:35 首次发布
本文详细介绍Lombok注解在Java开发中的应用，包括@Slf4j、@Getter、@Setter、@EqualsAndHashCode、@ToString、@Data、@AllArgsConstructor、@NoArgsConstructor、@Value、@Accessors、@Builder、@SneakyThrows、@Synchronized、@Cleanup和@FieldNameConstants等注解的使用方法及注意事项。

lombok的使用（一）

eclipse安装lombok插件

lombok下载地址
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

出现以下画面eclipse 中的lombok安装成功，重启eclipse

在这里插入图片描述

在maven项目中使用lombok

1、在maven中添加jar包依赖

在这里插入图片描述

在IDEA中使用lombok

在IDEA中安装插件lombok
在这里插入图片描述

快速入门lombok

在这里插入图片描述

@Slf4j

打印日志，把该注解标记在需要打印日志的java类名上

package com.demo;

import lombok.extern.slf4j.Slf4j;


/**
 * Lombok的使用
 *
 * @author 16837
 */
@Slf4j
public class LombokDemo {
    public static void main(String[] args) {
        log.debug("debug模式");
        log.info("info模式");
        log.warn("warn模式");
        log.error("error模式");
        log.trace("trace模式");
    }
}

程序运行之后的执行结果
在这里插入图片描述
其他的像@XSlf4j、@Log、@Log4j2、@CommonsLog、@JBossLog也都是lombok集成的日志框架

@Getter

相当于java中属性的getter方法

package com.demo;

import lombok.Getter;
import lombok.extern.slf4j.Slf4j;

/**
 * Lombok的使用
 *
 * @author 16837
 */
@Slf4j
public class LombokDemo {

    @Getter
    private static class User{
        private String name;
        private Integer age;
        private Byte sex;
    }
}

添加该注解之后，在IDEA中可以看到获取属性的get方法，如getName()、getAge()、getSex等
在这里插入图片描述

@Setter

相当于java中属性的setter方法

package com.demo;

import lombok.Getter;
import lombok.Setter;
import lombok.extern.slf4j.Slf4j;

/**
 * Lombok的使用
 *
 * @author 16837
 */
@Slf4j
public class LombokDemo {

    @Getter
    @Setter
    private static class User{
        private String name;
        private Integer age;
        private Byte sex;
    }
}

添加该注解之后，在IDEA中可以看到获取属性的get方法，如setName()、setAge()、setSex等
在这里插入图片描述

@EqualsAndHashCode

java中的equals和hashCode的

package com.demo;

import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
import lombok.extern.slf4j.Slf4j;

/**
 * Lombok的使用
 *
 * @author 16837
 */
@Slf4j
public class LombokDemo {

    @Getter
    @Setter
    // of 指定哪些字段是参与equals和hashCode的
    @EqualsAndHashCode(of = {"name", "age"})
    private static class User{
        private String name;
        private Integer age;
        private Byte sex;
    }
}

添加注解后，可以在IDEA中看到equals()和hashCode()方法在这里插入图片描述

@ToString

相当于java中原来实体类的toString()方法

package com.demo;

import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
import lombok.extern.slf4j.Slf4j;

/**
 * Lombok的使用
 *
 * @author 16837
 */
@Slf4j
public class LombokDemo {

    @Getter
    @Setter
    // of 指定哪些字段是参与equals和hashCode的
    @EqualsAndHashCode(of = {"name", "age"})
    // of 指定哪些字段是可以配置在toString中
    @ToString(of = {"name", "age"})
    private static class User{
        private String name;
        private Integer age;
        private Byte sex;
    }
}

添加注解后，可以在IDEA中看到toString()方法
在这里插入图片描述

@Data

package com.demo;

import lombok.*;
import lombok.extern.slf4j.Slf4j;

/**
 * Lombok的使用
 *
 * @author 16837
 */
@Slf4j
public class LombokDemo {

    @Data
    private static class User{
        private String name;
        private Integer age;
    }
}

@Data 注解会为类的所有属性自动生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。
相当于 @Getter @Setter @RequiredArgsConstructor @ToString @EqualsAndHashCode这几个注解合在一起的效果

在这里插入图片描述

@AllArgsConstructor

全参构造函数

package com.demo;

import lombok.*;
import lombok.extern.slf4j.Slf4j;

/**
 * Lombok的使用
 *
 * @author 16837
 */
@Slf4j
public class LombokDemo {

    /**
     * @AllArgsConstructor 全参构造函数
     */
    @AllArgsConstructor
    private static class User{
        private String name;
        private Integer age;
    }
}

添加注解后，可以在IDEA中可以看到User类的有参构造方法
在这里插入图片描述

@NoArgsConstructor

无参构造方法

package com.demo;

import lombok.*;
import lombok.extern.slf4j.Slf4j;

/**
 * Lombok的使用
 *
 * @author 16837
 */
@Slf4j
public class LombokDemo {

    /**
     * @NoArgsConstructor 无参构造函数
     * access 指定访问的级别
     * AccessLevel.PRIVATE 属性私有，不被外界使用
     */
    @NoArgsConstructor(access = AccessLevel.PRIVATE)
    private static class User{
        private String name;
        private Integer age;
    }
}

添加注解后，可以在IDEA中可以看到User类的无参构造方法User()方法
在这里插入图片描述

@Value

用于创建一个不可变的类。当应用于类时，它有以下效果：

  1. 字段默认为private和final：所有直接在类中声明的字段都会被隐式地声明为private和final，这意味着一旦赋值后，就不能再更改
  2. 无setter方法：Lombok不会生成setter方法，因为final字段不能通过方法进行修改
  3. 带参数的构造器：Lombok会生成一个构造器，该构造器接受所有字段作为参数，用于初始化对象
  4. getter方法：为所有字段生成getter方法，以便于访问这些不可变的属性
  5. 自动实现equals()和hashCode()：如果未指定，Lombok会基于类的字段生成equals()和hashCode()方法。这两个方法会根据类的字段内容判断两个对象是否相等，并计算哈希码
  6. 默认的toString()：如果没有其他@ToString注解，也会生成toString()方法，显示类的字段值
  7. 不可继承：如果可能，类会被隐式地声明为final，以防止子类继承并改变其行为
package com.demo;

import lombok.Value;
import lombok.extern.slf4j.Slf4j;

/**
 * Lombok的使用
 *
 * @author 16837
 */
@Slf4j
public class LombokDemo {

    @Value
    private static class User{
        private String name;
        private Integer age;
    }
}

在这里插入图片描述

@Accessors

它需要与其他注解（如@Setter或@Data）一起使用

package com.demo;

import lombok.Data;
import lombok.experimental.Accessors;
import lombok.extern.slf4j.Slf4j;

/**
 * Lombok的使用
 *
 * @author 16837
 */
@Slf4j
public class LombokDemo {

    /**
     * chain =true,表示设置值的时候，在给一个对象的多个属性赋值的时候不需要通过对象名称.setXxx()的形式，
     * 而是直接使用setXxx()的形式,设置值的时候，可以不用换行
     * setter和getter方法都是setXxx()和getXxx(),fluent = true,表示以属性名称作为方法名
     * 如原来的setName(String name)方法名，变成name(String name),getName()方法名，变成name()
     */
    @Data
    @Accessors(chain = true, fluent = true)
    private static class User {
        private String name;
        private Integer age;
    }

    public static void main(String[] args) {
        User user = new User();
        user.age(10).name("lisi");
        System.out.println(user);
    }
}

在IDEA中可以查看到如下的对象属性的赋值方式
在这里插入图片描述

@Builder

@Builder注解用于简化对象构建过程，它提供了链式方法来创建一个新的实例

package com.demo;

import lombok.Builder;
import lombok.Data;

import java.io.Serializable;
import java.util.List;

@Data
@Builder
public class User implements Serializable {

    private String name;
    private Integer age;

    private List<String> hobbies;
}

在这里插入图片描述

package com.demo;

import java.util.List;

/**
 * Lombok的使用
 *
 * @author 16837
 */
public class LombokDemo {

    public static void main(String[] args) {
        User user = User.builder()
                .name("Alice")
                .age(25)
                .hobbies(List.of("Cooking", "Reading"))
                .build();
        System.out.println(user.toString());
    }
}

程序运行输出结果
在这里插入图片描述

@SneakyThrows

注解@SneakyThrows，作用是允许方法体中的语句抛出指定的检查异常，而不需要在方法签名中声明这些异常。它通过在编译期间使用字节码转换器自动运行来实现，避免了javac对检查异常系统的强制性检查。该注解可以在方法或构造函数上使用，指定要"偷偷抛出"的异常类型。使用该注解时，会将方法体中的异常捕获并使用"魔法"技巧隐藏起来，实际上还是将异常抛出。这个技巧涉及到了字节码转换，在编译的最后阶段自动运行，不会对运行时产生依赖。

package com.demo;

import lombok.SneakyThrows;

/**
 * Lombok的使用
 *
 * @author 16837
 */
public class LombokDemo {

    @SneakyThrows
    public static void shitHappens(){
        Thread.sleep(1000);
    }
    public static void main(String[] args) {
        shitHappens();
    }
}

@Synchronized

就像在方法上放synchronized关键字一样，只是会在私有的内部对象上同步

package com.demo;

import lombok.Cleanup;
import lombok.SneakyThrows;
import lombok.Synchronized;

import java.io.FileOutputStream;

/**
 * Lombok的使用
 *
 * @author 16837
 */
public class LombokDemo {
    @Synchronized
    @SneakyThrows
    public static void printInfo() {
        String path = "1.txt";
        @Cleanup FileOutputStream fileOutputStream = new FileOutputStream(path, true);
        fileOutputStream.write("hello world".getBytes());
    }


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

@Cleanup

无论发生什么情况，都可以通过调用其close方法来确保注释的变量声明得到清理。通过将局部变量声明之后的所有语句包装到作用域的末尾，将其封装到一个try块中，作为finally操作，该块将关闭资源

package com.demo;

import lombok.Cleanup;
import lombok.SneakyThrows;

import java.io.FileOutputStream;

/**
 * Lombok的使用
 *
 * @author 16837
 */
public class LombokDemo {

    @SneakyThrows
    public static void printInfo() {
        String path = "1.txt";
        @Cleanup FileOutputStream fileOutputStream = new FileOutputStream(path, true);
        fileOutputStream.write("hello world".getBytes());
    }


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

程序运行之后，生成1.txt文件，文件内容为
在这里插入图片描述

@FieldNameConstants

可以获取字段名称

package com.demo;

import lombok.Data;
import lombok.experimental.Accessors;
import lombok.experimental.FieldNameConstants;

import java.io.Serializable;

/**
 * @FieldNameConstants 可以获取字段名称，使用mybatis指定更新的字段
 */
@Data
@Accessors(chain = true)
@FieldNameConstants
public class User implements Serializable {

    private String name;
    private Integer age;
}


package com.demo;

/**
 * Lombok的使用
 *
 * @author 16837
 */
public class LombokDemo {

    public static void main(String[] args) {
        System.out.println(User.Fields.age);
        System.out.println(User.Fields.name);
    }
}

运行程序之后的输出结果如下
在这里插入图片描述

其他注解

https://projectlombok.org/features/all

Eclipse中Springboot项目使用Lombok教程
jackiendsc的博客
09-04 1846
Eclipse中Springboot项目使用Lombok教程，包含了lombok常见的注解使用方法，包括@Getter、@Setter、@NoArgsConstructor、@AllArgsConstructor、@RequiredArgsConstructor、@Builder、@Data、@Value、@Slf4j、@Cleanup等注解，可以大大减少代码的书写，使代码的可读性及可维护性更好
Lombok 使用教程-@Log | 如何优雅的进行日志记录
smart_an的专栏
08-12 1510
在中添加了各种@Log的变体。中的新内容：你可以用log注解来注解任何类，让lombok生成一个logger字段。该logger被命名为log，字段的类型取决于你选择了哪一个logger。中的新内容：增加了谷歌的（通过@Flogger中的新功能：增加了@CustomLog，让你可以通过配置如何用配置键来创建任何日志记录器。您将@Log的变体放在类中（以适用于您使用的日志系统的为准）；然后，您有一个静态的final log字段，按照您使用的日志框架通常规定的方式进行初始化，然后您可以使用它来编写日志语句。
为Eclipse安装lombok插件
shencomd的专栏
05-20 1万+
Eclipse引入lombok依赖之后无法直接使用，代码直接报错，本文介绍如何手动为Eclipse安装lombok插件。
Eclipse插件Lombok开发详解与实战
最新发布
weixin_35364187的博客
09-15 1137
Lombok 是一款专为 Java 开发者设计的开源工具库，其核心目标是通过注解（Annotation）的方式，自动生成重复性的样板代码。常见的如gettersettertoStringequals和hashCode等方法，使用 Lombok 后只需添加一行注解即可完成定义，极大提升了开发效率与代码整洁度。它的工作原理基于 Java 的注解处理器（Annotation Processor），在编译阶段自动插入生成的代码，开发者无需手动编写或维护这些冗余逻辑。
eclipse如何引入lombok插件
小诸葛的博客
09-24 2299
在弹窗内选择eclipse的启动程序eclipse.exe，注意！必须是eclipse.exe，如果该过名字必须改回eclipse.exe，否则识别不到的。
在eclipse中使用Lombok
热门推荐
左手吐司 · 右手花卷
12-20 1万+
在eclipse中使用Lombok 1、下载Lombok.jar http://projectlombok.googlecode.com/files/lombok.jar  2、运行Lombok.jar: java -jar  D:\001_software\work\Java\libs\lombok.jar          数秒后将弹出一框，以确认eclipse的安装路径  3
Eclipse中装入lombok
weixin_44513087的博客
10-24 329
1.下载lombok的jar包 jar包下载路径：https://projectlombok.org/download 2.把下载的jar包复制到要装入的Eclipse的安装目录下 3.双击lombok.jar 4.会出现一个红辣椒 点击确定 5.选择Specify location… 选择你Eclipse的安装目录 点击select 6.点击insert/update 7.打开Eclips...
Lombok使用
07-04
在 Java 项目中使用 Lombok 库可以显著减少样板代码的编写，提高开发效率。Lombok 通过注解处理器在编译时自动生成代码，使开发者能够专注于业务逻辑而不是冗余的 getter、setter 等方法。 ### 添加 Lombok 依赖 ...
Lombok 使用教程-onX | 为Lombok注解添加自定义注解
smart_an的专栏
08-14 1206
这个功能被认为是 “变通状态”–它的存在是为了让那些没有这个功能就无法工作的lombok用户无论如何都能使用这个功能。如果我们找到一个更好的方法来实现这个功能，或者未来的某个java版本引入了一个替代策略，这个功能可以在没有一个合理的废弃期的情况下消失。另外，这个功能可能在未来的javac版本中无法使用。使用时请自行斟酌。大多数使lombok生成方法或构造函数的注解可以被配置为使lombok在生成的代码中的元素上添加自定义注解。@Getter@Setter和@Wither支持onMethod。
Lombok 使用教程-@Synchronized | 如何优雅的添加Synchronized锁
smart_an的专栏
08-12 911
是方法修饰语的一个更安全的变体。和一样，该注解只能用于静态和实例方法。它的操作与关键字类似，但它锁定的对象不同。关键字锁定了这个对象，但注解锁定了一个名为$lock的字段，它是私有的。如果你愿意，你可以自己创建这些锁。如果你已经自己创建了$lock和$LOCK字段，当然就不会再生成它们。你也可以选择锁定另一个字段，通过指定它作为注释的参数。在这种用法的变体中，字段不会被自动创建，你必须自己明确地创建它们，否则会发出一个错误。
Lombok 使用教程-@Getter(lazy=true) | Getter 懒加载
smart_an的专栏
08-12 1044
是在中引入的。你可以让lombok生成一个getter，它将在第一次调用这个getter时计算一个值，并从那时起缓存它。如果计算数值需要大量的CPU，或者数值需要大量的内存，这就很有用。要使用这个功能，创建一个变量，用运行成本高的表达式来初始化它，并用来注释你的字段。这个字段将从你的代码的其余部分隐藏起来，并且表达式的评估不会超过一次，即在第一次调用getter的时候。没有神奇的标记值（也就是说，即使你昂贵的计算结果是空的，结果也会被缓存），你昂贵的计算不需要是线程安全的，因为lombok负责锁。
eclipse下载安装、配置tomcat、Maven、lombok
bluelotos893的博客
03-20 2532
eclipse安装tomcat、maven、lombok
Eclipse中Maven集成lombok
小波的博客
09-22 954
系统软件环境： Elispe：neon，Maven，lombok：1.18.6 由于Eclipse集成需要做一点前期准备工作，所以请在未启动Eclipse前提下执行下列操作。 1.找到本地maven仓库中的lombok的jar文件，如果没有也可以去这个地址下载，手动拷贝到本地maven仓库 lombok 1.18.6下载地址 2.右键--打开方式--选在Java TM 3.弹出...
Eclipse中整合并使用lombok
weixin_54685622的博客
03-09 825
【代码】Eclipse中整合并使用lombok。
eclipse下maven项目使用lombok插件的简单安装使用
Explosive_seabear的博客
09-10 3752
lombok作用 消除模板代码，如getter、setter、构造器、toString()、equals()等等 便捷的生成比较复杂的代码，例如一个POJO要转化成构建器模式的形式，只需要一个注解。   lombok的引入 普通的maven项目在pom.xml添加依赖为 &lt;dependency&gt; &lt;groupId&gt;org.projectlombok&lt;...
在eclipse中安装lombok插件（全网最简单教程）
沐雨橙风ιε的博客
02-28 1239
在eclipse中安装lombok插件（全网最简单教程）
lombook在Eclipse中安装使用
qq_59135465的博客
05-29 2001
很多人在eclipse中创建bean后，需要给bean中的属性提供set、get、tostring、以及有参无参构造器方法。虽然看着很方便，但是如果我们继续在bean中继续添加属性，我们就需要重新如上步骤，使得代码不好维护。下载好后直接将jar包放到项目中的WebContent/WEB-INF/lib中。再把eclipse路径下的lombok包导入lib目录下面，重启就可以使用了。看看能不能正常使用，如果不能使用就执行下面操作；把项目中的loombook.jar删了；然后会跳出成功的页面，关了就行；
eclipse 配置 lombok
qq_74417143的博客
05-11 1622
2.找到eclipse安装目录，将jar包放入与eclipose.ini文件相同的文件夹下，由于下载的jar包带着版本号，我们将文件重命名为lombok.jar。3.修改eclipse文件，加入下面两行代码，重启eclipse。1.下载lombok的jar包。
Eclipse安装 lombok步骤，含泪整理面经
m0_60452134的博客
04-17 2700
前端CSS面试题文档，JavaScript面试题文档，Vue面试题文档，大厂面试题文档网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。需要这份系统化的资料的朋友，可以添加V获取：vip1024c （备注前端）一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值