Java Lombok的介绍和使用方法

最新推荐文章于 2024-06-26 15:11:18 发布
最新推荐文章于 2024-06-26 15:11:18 发布
阅读量542 收藏 3
点赞数 2
分类专栏： java 文章标签： java lombok
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yaorongke/article/details/114129752
版权

文章目录

一、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.

Lombok是一个Java类库，它提供了很多注解可以帮我们大大简化冗余代码，提升开发人员的开发效率。比如我们在写JavaBean时要给每个属性添加对应的 getter/setter、toString方法、构造器等一大堆代码，这些代码很冗长也没有什么技术含量，而且修改属性时还要去改对应的方法，浪费时间还容易出错。

Lombok可以通过添加注解的方法，在编译时自动为属性生成getter/setter、toString、构造器等代码，我们在源码中不再修改维护这一堆代码，只需添加注解即可，编译后的class文件中会自动生成。

二、使用方法
1、引入Maven依赖
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.16</version>
    <scope>provided</scope>
</dependency>

scope为provided，表明只在编译阶段生效，不打到包里，因为Lombok是在编译期生效，将带Lombok注解的Java文件编译为完整的Class文件。

2、Idea中安装Lombok插件

打开 File -> Settings -> Plugins，搜索 Lombok，点击 Installed 即可。
在这里插入图片描述

三、常用注解

对常用的注解进行说明，为了直观体现每个注解的效果，会列出注解在源码中的使用方式和编译后class文件中的实际效果

@Setter

注解在类上，为类中所有属性提供Setter方法；注解在某属性上，为该属性提供Setter方法。

源码

@Setter
public class UserInfo01 {

    private String userId;

    @Setter
    private String userName;

    @Setter
    private Integer age;

}

实际效果

public class UserInfo01 {
    
    private String userId;
    
    private String userName;
    
    private Integer age;

    public UserInfo01() {
    }

    public void setUserId(final String userId) {
        this.userId = userId;
    }

    public void setUserName(final String userName) {
        this.userName = userName;
    }

    public void setAge(final Integer age) {
        this.age = age;
    }
    
}
@Getter

注解在类上，为类中所有属性提供Getter方法；注解在某属性上，为该属性提供Getter方法。

源码

@Getter
public class UserInfo02 {

    private String userId;

    @Setter
    private String userName;

    @Setter
    private Integer age;

}
@NoArgsConstructor

注解在类上，为类提供一个无参的构造方法。类中有 final 字段没有被初始化时，编译器会报错，此时可用 @NoArgsConstructor(force = true)，然会为没有初始化的 final 字段设置默认值。

源码

@NoArgsConstructor(force = true)
public class UserInfo03 {

    private final String userId;

    private String userName;

    private Integer age;

}

实际效果

public class UserInfo03 {
    
    private final String userId = null;
    
    private String userName;
    
    private Integer age;

    public UserInfo03() {
    }
    
}
@AllArgsConstructor

注解在类上，为类提供一个全参的构造方法。

源码

@AllArgsConstructor
public class UserInfo04 {

    private String userId;

    private String userName;

    private Integer age;

}

实际效果

public class UserInfo04 {
    
    private String userId;
    
    private String userName;
    
    private Integer age;

    public UserInfo04(final String userId, final String userName, final Integer age) {
        this.userId = userId;
        this.userName = userName;
        this.age = age;
    }
    
}
@RequiredArgsConstructor

注解在类上，为未初始化的final属性提供一个private的构造方法；可通过staticName参数生成一个static方法。

源码

@RequiredArgsConstructor(staticName = "of")
public class UserInfo05 {

    private final String userId;

    private final String userName = "张三";

    private Integer age;

}

实际效果

public class UserInfo05 {
    
    private final String userId;
    
    private final String userName = "张三";
    
    private Integer age;

    private UserInfo05(final String userId) {
        this.userId = userId;
    }

    public static UserInfo05 of(final String userId) {
        return new UserInfo05(userId);
    }
    
}
@Builder

注解在类上，建造者模式的一个变种，在创建复杂对象时常使用。

源码

@Builder
public class UserInfo06 {

    private final String userId;

    private final String userName;

    private Integer age;

}

实际效果

public class UserInfo06 {
    
    private final String userId;
    
    private final String userName;
    
    private Integer age;

    UserInfo06(final String userId, final String userName, final Integer age) {
        this.userId = userId;
        this.userName = userName;
        this.age = age;
    }

    public static UserInfo06.UserInfo06Builder builder() {
        return new UserInfo06.UserInfo06Builder();
    }

    public static class UserInfo06Builder {
        
        private String userId;
        
        private String userName;
        
        private Integer age;

        UserInfo06Builder() {
        }

        public UserInfo06.UserInfo06Builder userId(final String userId) {
            this.userId = userId;
            return this;
        }

        public UserInfo06.UserInfo06Builder userName(final String userName) {
            this.userName = userName;
            return this;
        }

        public UserInfo06.UserInfo06Builder age(final Integer age) {
            this.age = age;
            return this;
        }

        public UserInfo06 build() {
            return new UserInfo06(this.userId, this.userName, this.age);
        }

        public String toString() {
            return "UserInfo06.UserInfo06Builder(userId=" + this.userId + ", userName=" + this.userName + ", age=" + this.age + ")";
        }
    }
}

使用Builder模式创建对象

public class BuilderTest {

    public static void main(String[] args) {
        // Builder模式创建对象
        UserInfo06 userInfo06 = UserInfo06.builder().userId("1").userName("张三").age(99).build();
    }

}
@Data

注解在类上，是@Getter、@Setter、@ToString、@EqualsAndHashCode、 @RequiredArgsConstructor的集合。

源码

@Data
public class UserInfo07 {

    private String userId;

    private String userName;

    private Integer age;

}

实际效果

public class UserInfo07 {
    
    private String userId;
    
    private String userName;
    
    private Integer age;

    public UserInfo07() {
    }

    public String getUserId() {
        return this.userId;
    }

    public String getUserName() {
        return this.userName;
    }

    public Integer getAge() {
        return this.age;
    }

    public void setUserId(final String userId) {
        this.userId = userId;
    }

    public void setUserName(final String userName) {
        this.userName = userName;
    }

    public void setAge(final Integer age) {
        this.age = age;
    }

    public boolean equals(final Object o) {
        if (o == this) {
            return true;
        } else if (!(o instanceof UserInfo07)) {
            return false;
        } else {
            UserInfo07 other = (UserInfo07)o;
            if (!other.canEqual(this)) {
                return false;
            } else {
                label47: {
                    Object this$age = this.getAge();
                    Object other$age = other.getAge();
                    if (this$age == null) {
                        if (other$age == null) {
                            break label47;
                        }
                    } else if (this$age.equals(other$age)) {
                        break label47;
                    }

                    return false;
                }

                Object this$userId = this.getUserId();
                Object other$userId = other.getUserId();
                if (this$userId == null) {
                    if (other$userId != null) {
                        return false;
                    }
                } else if (!this$userId.equals(other$userId)) {
                    return false;
                }

                Object this$userName = this.getUserName();
                Object other$userName = other.getUserName();
                if (this$userName == null) {
                    if (other$userName != null) {
                        return false;
                    }
                } else if (!this$userName.equals(other$userName)) {
                    return false;
                }

                return true;
            }
        }
    }

    protected boolean canEqual(final Object other) {
        return other instanceof UserInfo07;
    }

    public int hashCode() {
        int PRIME = true;
        int result = 1;
        Object $age = this.getAge();
        int result = result * 59 + ($age == null ? 43 : $age.hashCode());
        Object $userId = this.getUserId();
        result = result * 59 + ($userId == null ? 43 : $userId.hashCode());
        Object $userName = this.getUserName();
        result = result * 59 + ($userName == null ? 43 : $userName.hashCode());
        return result;
    }

    public String toString() {
        return "UserInfo07(userId=" + this.getUserId() + ", userName=" + this.getUserName() + ", age=" + this.getAge() + ")";
    }
}
@Value

注解在类上，和@Data类似，区别在于它会把所有成员变量默认定义为private final修饰，也不会生成set方法。

源码

@Value
public class UserInfo08 {

    private String userId;

    private String userName;

    private Integer age;

}

实际效果

public final class UserInfo08 {
    private final String userId;
    private final String userName;
    private final Integer age;

    public UserInfo08(final String userId, final String userName, final Integer age) {
        this.userId = userId;
        this.userName = userName;
        this.age = age;
    }

    public String getUserId() {
        return this.userId;
    }

    public String getUserName() {
        return this.userName;
    }

    public Integer getAge() {
        return this.age;
    }

    public boolean equals(final Object o) {
        if (o == this) {
            return true;
        } else if (!(o instanceof UserInfo08)) {
            return false;
        } else {
            UserInfo08 other;
            label44: {
                other = (UserInfo08)o;
                Object this$age = this.getAge();
                Object other$age = other.getAge();
                if (this$age == null) {
                    if (other$age == null) {
                        break label44;
                    }
                } else if (this$age.equals(other$age)) {
                    break label44;
                }

                return false;
            }

            Object this$userId = this.getUserId();
            Object other$userId = other.getUserId();
            if (this$userId == null) {
                if (other$userId != null) {
                    return false;
                }
            } else if (!this$userId.equals(other$userId)) {
                return false;
            }

            Object this$userName = this.getUserName();
            Object other$userName = other.getUserName();
            if (this$userName == null) {
                if (other$userName != null) {
                    return false;
                }
            } else if (!this$userName.equals(other$userName)) {
                return false;
            }

            return true;
        }
    }

    public int hashCode() {
        int PRIME = true;
        int result = 1;
        Object $age = this.getAge();
        int result = result * 59 + ($age == null ? 43 : $age.hashCode());
        Object $userId = this.getUserId();
        result = result * 59 + ($userId == null ? 43 : $userId.hashCode());
        Object $userName = this.getUserName();
        result = result * 59 + ($userName == null ? 43 : $userName.hashCode());
        return result;
    }

    public String toString() {
        return "UserInfo08(userId=" + this.getUserId() + ", userName=" + this.getUserName() + ", age=" + this.getAge() + ")";
    }
}
@Slf4j

注解在类上；为类提供一个 属性名为 log 的日志对象。

源码

@Slf4j
public class Slf4jTest {

    public static void main(String[] args) {
        log.info("日志打印测试");
    }

}

实际效果

public class Slf4jTest {
    
    private static final Logger log = LoggerFactory.getLogger(Slf4jTest.class);

    public Slf4jTest() {
    }

    public static void main(String[] args) {
        log.info("日志打印测试");
    }
    
}
@Cleanup

注解在流上，生成关闭流的方法。

源码

public class CleanupTest {

    public static void main(String[] args) throws IOException {
        @Cleanup InputStream in = new FileInputStream(args[0]);
        @Cleanup OutputStream out = new FileOutputStream(args[1]);
        byte[] b = new byte[10000];
        while (true) {
            int r = in.read(b);
            if (r == -1) {
                break;
            }
            out.write(b, 0, r);
        }
    }

}

实际效果

public class CleanupTest {
    
    public CleanupTest() {
    }

    public static void main(String[] args) throws IOException {
        FileInputStream in = new FileInputStream(args[0]);
        try {
            FileOutputStream out = new FileOutputStream(args[1]);
            try {
                byte[] b = new byte[10000];
                while(true) {
                    int r = in.read(b);
                    if (r == -1) {
                        return;
                    }
                    out.write(b, 0, r);
                }
            } finally {
                if (Collections.singletonList(out).get(0) != null) {
                    out.close();
                }
            }
        } finally {
            if (Collections.singletonList(in).get(0) != null) {
                in.close();
            }
        }
    }
    
}
@SneakyThrows

注解在方法上，给方法中的代码添加try/catch捕获异常。

源码

public class SneakyThrowsTest {

    @SneakyThrows
    public void test() {
        System.out.println("test");
    }

}

实际效果

public class SneakyThrowsTest {
    
    public SneakyThrowsTest() {
    }

    public void test() {
        try {
            System.out.println("test");
        } catch (Throwable var2) {
            throw var2;
        }
    }
    
}
@Synchronized

注解在方法上，给方法中的代码添加同步锁。

源码

public class SynchronizedTest {

    @Synchronized
    public void test() {
        System.out.println("test");
    }

}

实际效果

public class SynchronizedTest {
    
    private final Object $lock = new Object[0];

    public SynchronizedTest() {
    }

    public void test() {
        synchronized(this.$lock) {
            System.out.println("test");
        }
    }
    
}
@NonNull

注解在参数上，在方法或构造函数的参数上使用@NonNull会给参数生成null-check语句。

public class NonNullTest {

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

    public static void test(@NonNull String id) {
        System.out.println(id);
    }

}

实际效果

public class NonNullTest {
    
    public NonNullTest() {
    }

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

    public static void test(@NonNull String id) {
        if (id == null) {
            throw new NullPointerException("id is marked non-null but is null");
        } else {
            System.out.println(id);
        }
    }
    
}
四、Lombok的优点和缺点

Lombok当然不是万能的，使用Lombok能给开发人员提供很大的便利，同时也会带来一些问题，其优缺点如下。

优点：

  • 简化了大量的冗余代码，注解代替getter/setter等方法，能让源码更简洁；
  • 减少了代码维护 难度，修改属性后，上述方法也会随之改变，防止忘改错该问题；
  • 提升了开发效率，减少重复劳动。

缺点：

  • 使用Lombok需要在Idea中安装插件，团队里一个人用了Lombok其它人也得跟着用；
  • Lombok很多方法是自动生成的，屏蔽了代码的内部逻辑，一定程度上降低了代码的可读性；
  • 对Lombok理解较少的话会出现意想不到的现象，比如使用@Data注解时， 会自动生成equals()方法，但是这个equals()方法只会比较子类的属性，不会考虑从父类继承的属性，要想比较父类方法需添加@EqualsAndHashCode(callSuper=true)注解。

Lombok有优点也有缺点，个人认为瑕不掩瑜，还是比较好用的，大家根据自己情况按需使用。

五、参考文档

官网地址

https://projectlombok.org/features/all

淡淡的说非
关注
  • 2
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
java lombok 使用_Lombok 使用详解，简化Java编程
weixin_31774171的博客
02-16 1200
前言在 Java 应用程序中存在许多重复相似的、生成之后几乎不对其做更改的代码，但是我们还不得不花费很多精力编写它们来满足 Java 的编译需求比如，在 Java 应用程序开发中，我们几乎要为所有 Bean 的成员变量添加 get() ,set() 等方法，这些相对固定但又不得不编写的代码浪费程序员很多精力，同时让类内容看着更杂乱，我们希望将有限的精力关注在更重要的地方。Lombok 已经诞生很久...
深入了解java Lombok的使用方法
08-25
例如，通过在字段上使用`@Getter`和`@Setter`注解，Lombok会在编译时自动为这些字段生成对应的getter和setter方法。 安装Lombok可以有两种方式：一是将lombok.jar文件添加到项目的lib目录；二是如果你的项目使用...
java lombok
一千世界
07-11 212
java效率工具 Lombok KenDoEverthing发布于2018-11-29 Java项目中，充斥着太多不友好的代码：POJO的getter/setter/toStringm异常处理,I/O流的关闭操作等等，这些样板代码既没有技术含量，又影响着代码的美观，Lombok应运而生。 Lombok是以注解的方式减少了代码量,虽说 IDEA 的插件可以自动生成 get/set/toString 方法，但是使用 Lombok 可以让代码更简洁。 IDEA安装插件 打开 IDEA 的 Settin.
Java工具包——Lombok
最新发布
m0_63299495的博客
06-26 1258
在Spring项目中创建java对象，如果使用手动生成getter、setter、toString等方法提供调用接口，会导致代码修改成本与复杂度大大增加；lombok是一个Java工具库，通过的方式简化了Java的开发；接下来简单介绍lombok的使用方法；
Lombok介绍、使用方法和总结
u011062735的博客
09-01 83
Lombok介绍、使用方法和总结 转载地址：Lombok介绍、使用方法和总结
lombok常用注解的使用
qq_41307492的博客
03-31 166
常用注解： @Setter ：注解在类或字段，注解在类时为所有字段生成setter方法，注解在字段上时只为该字段生成setter方法。 @Getter ：使用方法同上，区别在于生成的是getter方法。 @ToString ：注解在类，添加toString方法。 @EqualsAndHashCode： 注解在类，生成hashCode和equals方法。 @NoArgsConstructo...
Java lombok
nickfover的专栏
10-23 478
lombok 提供了简单的注解的形式来帮助我们简化消除一些必须有但显得很臃肿的 Java代码。特别是对于 POJO类来说， 下面介绍几个常用的 lombok 注解：         @Data   ：注解在类上；提供类所有属性的 getting 和 setting 方法，此外还提供了equals、canEqual、hashCode、toString 方法
Java效率工具之Lombok的具体使用
08-25
本文将详细介绍Lombok的使用，包括引入Lombok、IDE工具对Lombok的支持、Lombok实现原理和Lombok注解的使用等方面。 一、引入Lombok 要使用Lombok，首先需要在项目中引入Lombok的Maven依赖关系，代码如下： ```xml...
java lombok.rar
09-29
Java Lombok是一个非常实用的Java库，它通过提供一系列注解来简化代码，尤其是那些通常在getter、setter、构造函数、equals、hashCode和toString方法中出现的样板代码。Lombok的目标是减少Java开发者编写冗余代码的...
java项目中使用 Lombok遇到的问题小结
08-27
Lombok 是一个 Java 库，它通过注解处理器自动为类生成常见的 getter、setter、构造器和其他辅助方法，从而减少样板代码。在 Java 项目中使用 Lombok 可以显著提高开发效率，但同时也会遇到一些问题。以下是一些常见...
java如何使用Lombok更优雅地编码
08-25
Lombok 是一个 Java 开发工具，它通过注解的方式来消除 Java 代码中的样板代码，使得代码更加简洁、易读和维护。Lombok 提供了一系列的注解，可以在编译时自动生成构造器、getter/setter、equals、hashCode 和 ...
Java使用Lombok详解
Lifelong learning
03-27 2835
Lombok 是一种 Java 实用工具，可用来帮助开发人员消除 Java 的冗长，尤其是对于简单的 Java 对象（POJO）。它通过注释实现这一目的。通过在开发环境中实现 Lombok，开发人员可以节省构建诸如 hashCode() 和 equals() 、getter / setter 这样的方法以及以往用来分类各种 accessor 和 mutator 的大量时间。
Java Lombok
把习惯当成一种生活
12-02 427
前提 自从进公司实习后，项目代码中能用 Lombok 的都用了，毕竟这么好的轮子要充分利用好。也可以减少一些 get/set/toString 方法的编写，虽说 IDEA 的插件可以自动生成 get/set/toString 方法，但是使用 Lombok 可以让代码更简洁。 下面看看如何在 IDEA　中如何安装 Lombok： 安装 打开 IDEA 的 Settings 面板，并选择 Plugins 选项，然后点击 “Browse repositories” 在输入框输入”lombok”，得到搜索结果，点击
Java开发神器Lombok的使用与原理
weixin_34161032的博客
05-16 753
在面向对象编程中必不可少需要在代码中定义对象模型，而在基于Java的业务平台开发实践中尤其如此。相信大家在平时开发中也深有感触，本来是没有多少代码开发量的，但是因为定义的业务模型对象比较多，而需要重复写Getter/Setter、构造器方法、字符串输出的ToString方法和Equals/HashCode方法...
java lombok 使用_Java基础002 --- Lombok的使用
weixin_31147757的博客
02-24 245
简介Lombok是一个java库，通过使用简单的注解，简化java代码开发，并且在编译生成的字节码文件中生成对应的方法；主要的应用场景：java bean的代码开发。在以往的开发中，我们需要在java bean中为每个属性添加getter&setter方法，并且需要重写toString和equals方法；有多个java bean，我们需要添加很多重复化代码，并且，如果我们需要添加或者修改某...
Java学习之Lombok
weixin_63958646的博客
09-23 121
Lombok（发音为"LOM-bok"）是一个Java库，它通过自动生成常见的Java代码（如Getter、Setter、构造函数、equals和hashCode方法等）来简化Java代码的编写。要使用Lombok，你需要在项目中引入Lombok库的依赖，并在你的Java类上添加相应的注解。然后，在编译时，Lombok会自动生成相应的代码，使你的类拥有所需的功能，而无需手动编写这些代码。使用Lombok可以减少样板代码的编写，提高代码的可维护性，并减少出错的可能性。：自动生成类的Getter方法。
lombok java中的使用
weixin_46140377的博客
01-26 1116
lombok可以通过注解来帮助我们简化和消除一些重复的代码，比如get set方法，toString方法等； 以idea为例，打开IDEA,选择 file -> settings -> plugins; 在搜索框中输入Lombok plugin,点击install;重启IDEA,安装完成。 在maven项目中 在pom文件中引入依赖 <dependency> <groupId>org.projectlombok</groupId> .
java：lombok使用
a232884c的博客
10-27 605
java：lombok使用 1 安装lombok https://search.maven.org:搜索lombok的版本 pom依赖如下： <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.22</version> </dependency> 2 使用
Java Lombok的@Builder：慎用与冲突解析
"本文将深入探讨Java中的Lombok库，特别是关于`@Builder`注解的使用，以及在使用过程中可能出现的问题和解决方案。" Lombok是一个非常实用的Java库，它通过注解的方式自动为类生成诸如构造函数、getter/setter、...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值