Lombok注解的使用

最新推荐文章于 2024-05-25 18:28:15 发布
最新推荐文章于 2024-05-25 18:28:15 发布
阅读量1.6k 收藏 6
点赞数 1
分类专栏： 技术分享 实用工具 文章标签： java spring intellij-idea
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_37687594/article/details/122150984
版权

目录

文章目录

1.简介

lombok是一个编译级别的插件，它可以在项目编译的时候生成一些代码。通俗的说，lombok可以通过注解来标示生成getter settter等代码，简便我们的开发。

2.使用

2.1引入依赖

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

2.2通过注解使用

注解如下：

  • @Data
  • @Setter
  • @Getter
  • @Log4j
  • @AllArgsConstructor
  • @NoArgsConstructor
  • @EqualsAndHashCode
  • @NonNull
  • @Cleanup
  • @ToString
  • @RequiredArgsConstructor
  • @Value
  • @SneakyThrows
  • @Synchronized

3.注解详情

3.1 @NonNull

标记字段不可为null

@Setter
public class Person {
    @NonNull
    private String name;
    @NonNull
    private Integer age;
}

生成的字节码文件：

public class Person {
    @NonNull
    private String name;
    @NonNull
    private Integer age;

    public Person() {
    }

    public void setName(@NonNull String name) {
        if (name == null) {
            throw new NullPointerException("name");
        } else {
            this.name = name;
        }
    }

    public void setAge(@NonNull Integer age) {
        if (age == null) {
            throw new NullPointerException("age");
        } else {
            this.age = age;
        }
    }
}

3.2 @Getter/@Setter

自动生成getter和setter方法

public class Person {
    @Getter
    private String name;
    @Setter
    private Integer age;
}

对应的字节码文件：

public class Person {
    private String name;
    private Integer age;

    public Person() {
    }

    public String getName() {
        return this.name;
    }

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

3.3 @Cleanup

自动关闭流代码

@Cleanup
InputStream in = new FileInputStream(args[0]);

对应的字节码文件：

InputStream in = new FileInputStream(args[0]);
if (Collections.singletonList(in).get(0) != null) {
    in.close();
}

3.4 @AllArgsConstructor/@NoArgsConstructor

自动生成全参构造函数和无参构造函数

@AllArgsConstructor
@NoArgsConstructor
public class Person {
    private String name;
    private Integer age;
}

对应的字节码文件

public class Person {
    private String name;
    private Integer age;

    public Person(String name, Integer age) {
        this.name = name;
        this.age = age;
    }

    public Person() {
    }
}

3.5 @RequiredArgsConstructor

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

@RequiredArgsConstructor
public class Student {

    private final String host;

}

对应的字节码文件

public class Student {
    private final String host;

    public Student(String host) {
        this.host = host;
    }
}

3.6 @Builder

自动生成建造者模式的bean

@Builder
public class Person {
    private String name;
    private Integer age;
}

对应的字节码文件

public class Person {
    private String name;
    private Integer age;

    Person(String name, Integer age) {
        this.name = name;
        this.age = age;
    }

    public static Person.PersonBuilder builder() {
        return new Person.PersonBuilder();
    }

    public static class PersonBuilder {
        private String name;
        private Integer age;

        PersonBuilder() {
        }

        public Person.PersonBuilder name(String name) {
            this.name = name;
            return this;
        }

        public Person.PersonBuilder age(Integer age) {
            this.age = age;
            return this;
        }

        public Person build() {
            return new Person(this.name, this.age);
        }

        public String toString() {
            return "Person.PersonBuilder(name=" + this.name + ", age=" + this.age + ")";
        }
    }
}

3.7 @EqualsAndHashCode

自动生成equals和hashcode方法

@EqualsAndHashCode
public class Person {
    private String name;
    private Integer age;
}

对应的字节码文件

public class Person {
    private String name;
    private Integer age;

    public Person() {
    }

    public boolean equals(Object o) {
        if (o == this) {
            return true;
        } else if (!(o instanceof Person)) {
            return false;
        } else {
            Person other = (Person)o;
            if (!other.canEqual(this)) {
                return false;
            } else {
                Object this$name = this.name;
                Object other$name = other.name;
                if (this$name == null) {
                    if (other$name != null) {
                        return false;
                    }
                } else if (!this$name.equals(other$name)) {
                    return false;
                }

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

                return true;
            }
        }
    }

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

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

3.8 @ToString

自动生成toString()方法

@ToString
public class Person {
    private String name;
    private Integer age;
}

对应的字节码文件

public class Person {
    private String name;
    private Integer age;

    public Person() {
    }

    public String toString() {
        return "Person(name=" + this.name + ", age=" + this.age + ")";
    }
}

3.9 @Value

自动生成全参构造函数、Getter方法、equals方法、hashCode法、toString方法

@Value
public class Person {
    private String name;
    private Integer age;
}

注意：@Value不会生成Setter方法

对应的字节码文件：

public final class Person {
    private final String name;
    private final Integer age;

    public Person(String name, Integer age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return this.name;
    }

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

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

            Object this$name = this.getName();
            Object other$name = other.getName();
            if (this$name == null) {
                if (other$name != null) {
                    return false;
                }
            } else if (!this$name.equals(other$name)) {
                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 $name = this.getName();
        result = result * 59 + ($name == null ? 43 : $name.hashCode());
        return result;
    }

    public String toString() {
        return "Person(name=" + this.getName() + ", age=" + this.getAge() + ")";
    }
}

3.10 @Synchronized

自动为被标记的方法添加synchronized锁

public class SynchronizedExample {
  private final Object readLock = new Object();
  
  @Synchronized
  public static void hello() {
    System.out.println("world");
  }
  
  @Synchronized
  public int answerToLife() {
    return 42;
  }
  
  @Synchronized("readLock")
  public void foo() {
    System.out.println("bar");
  }
}

对应的字节码文件

public class SynchronizedExample {
    private static final Object $LOCK = new Object[0];
    private final Object $lock = new Object[0];
    private final Object readLock = new Object();

    public static void hello() {
        synchronized($LOCK) {
            System.out.println("world");
        }
    }

    public int answerToLife() {
        synchronized($lock) {
            return 42;
        }
    }

    public void foo() {
        synchronized(readLock) {
            System.out.println("bar");
        }
    }
}

3.11 @Data

这是一个非常常用的住家，这个注解其实是五个注解的合体：

它是一个复合注解：

image-20211226001700233

使用：

@Data
public class Person {
    private String name;
    private Integer age;
}

生成的字节码文件：

public class Person {
    private String name;
    private Integer age;

    public Person() {
    }

    public String getName() {
        return this.name;
    }

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

    public void setName(String name) {
        this.name = name;
    }

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

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

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

                return true;
            }
        }
    }

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

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

    public String toString() {
        return "Person(name=" + this.getName() + ", age=" + this.getAge() + ")";
    }
}

3.12 @Slf4j

注解在 类 上；为类提供一个 属性名为 log 的slf4j 日志对象，提供默认构造方法。（注意使用时你的日志框架依赖中已经有slf4j的实现）

@Slf4j
public class Person {
    private String name;
    private Integer age;

    public void hello() {

        log.info("haha");
        System.out.println("he");
    }
}

字节码文件如下：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Person {
    private static final Logger log = LoggerFactory.getLogger(Person.class);
    private String name;
    private Integer age;

    public Person() {
    }

    public void hello() {
        log.info("haha");
        System.out.println("he");
    }
}

3.13 @Delegate

为标记属性生成委托方法

public class DelegateExample {
    public void show() {
        System.out.println("show...");
    }
}
@AllArgsConstructor
public class Demo {
    @Delegate
    private final DelegateExample delegateExample;
}

对应的字节码文件:

public class DelegateExample {
    public DelegateExample() {
    }

    public void show() {
        System.out.println("show...");
    }
}
public class Demo {
    private final DelegateExample delegateExample;

    public Demo(DelegateExample delegateExample) {
        this.delegateExample = delegateExample;
    }

    // 委托方法
    public void show() {
        this.delegateExample.show();
    }
}

4.参考

@Builder注解的使用

Lombok中的注解

njitzyd
关注
  • 1
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
执行Spring Boot项目时报错：Lombok requires enabled annotation processing
yunyala的博客
09-05 2301
在使用 Lombok 时，你需要启用注解处理器（annotation processing）。
idea打开项目时右下角弹出“Lombok requires enabled annotation processing”的解决方法
weixin_54009596的博客
04-20 3133
Lombok requires enabled annotation processing：翻译过来就是Lombok 需要启用注释处理。文件 --> 设置 --> 构建、执行、部署 --> 编译器 --> 注解处理器。出现这个错误是因为使用了Lombok插件的原因，可能是安装时候没有配置好。然后勾选上启用注解处理即可。
Lombok 实战教程 - @Delegate | 将其他类方法注入到当前类
最新发布
qq_33240556的博客
05-25 260
注解，我们可以在当前类中使用被注入类的方法，而无需显式地在当前类中编写这些方法的实现。是 Lombok 提供的一个注解，可以将其他类的方法注入到当前类中。在上面的示例中，我们定义了一个接口。类中，这样我们就可以在。
Lombok的基本使用和所有注解
万事俱备，就差一个程序员了
03-23 778
以前的Java项目中，充斥着太多不友好的代码：POJO的getter/setter/toString；异常处理；I/O流的关闭操作等等，这些样板代码既没有技术含量，又影响着代码的美观，Lombok应运而生。 任何技术的出现都是为了解决某一类问题，如果在此基础上再建立奇技淫巧，不如回归Java本身，应该保持合理使用而不滥用。 Lombok的使用非常简单： 1）引入相应的maven包 ...
springboot依赖lombok插件、lombok常用注解
IT_Most的博客
11-22 6958
springboot依赖lombok插件、lombok常用注解讲解
LomBok使用讲解
Happy_lifer的博客
06-13 3299
当我调试程序项目代码到调用Mybatis的插入SQL对应的方法的时候时，我看到NMetaVerify对象的nMetaType属性还是有数据的，但是执行插入之后，数据库的nMetaType就是一直是null，原先我以为是我的枚举类型写法不正确，看了下别的同样具有枚举类型的细分，也是正常能插入到数据库当中的，这更让我感觉到疑惑了。可以以链的形式调用；顶级类Object⾥⾯的⽅法，所有类都是继承Object的，返回值int类型根据⼀定的hash规则(存储地址，字段，或者⻓度等)，映射成⼀个数值，即散列值。
lombok注解介绍小结
08-26
下面我们将详细介绍lombok注解的使用方法和作用。 首先，我们来看一下lombok支持的一些常见的注解： 1. @NonNull：这个注解可以用在成员方法或者构造方法的参数前面，会自动产生一个关于此参数的非空检查，如果...
Lombok 注解工具类
09-25
lombok 通过注解的形式来帮助我们简化消除一些必须有但显得很臃肿的 Java 代码的工具，比如属性getter，setter，构造函数等。 具体使用方式可以参考官网说明：https://projectlombok.org/features/all
java10下编译lombok注解代码分享
08-27
6. pom.xml文件的配置：在使用Lombok库时，需要在pom.xml文件中添加相关的依赖项，以便正确地编译Lombok注解代码。 7. Java10下的兼容性问题：Java10下的兼容性问题是指Java10对Java编译器的改动可能会导致Lombok...
lombok注解插件
04-04
注解类插件，减少冗长的代码，特别是相对于 POJO；简化代码必备
eclipse（STS）安装 lombok插件重启后注解无效的解决办法
03-07
Eclipse（Spring Tool Suite, STS）是一款广泛使用的Java集成开发环境，而Lombok则是一个流行的Java库，它通过注解的方式简化了Java代码，比如自动处理getter、setter、构造函数等。在Eclipse或STS中安装Lombok插件...
Lombok常用的10个注解及常规用法
i++;
02-18 2596
1.@Getter/@Setter:注解在类上或属性上，为类所有属性或单个属性提供Get/Set方法（默认public方法） 1.还可以设置get/set方法的一些属性，如把get方法设置成protected的 2.剔除单个属性的get/set方法 3.并不会为static修饰的属性添加get/set方法 4.只会为final修饰的属性添加get方法 2.@ToString :注解在类上，生成...
Lombok工具 : 常用注解介绍 (全)
Guizy
08-14 8290
Lombok详细介绍, 全
spring注解大全启用
萧曳丶
09-12 209
spring @component的作用 1、@controller 控制器（注入服务） 2、@service 服务（注入dao） 3、@repository dao（实现dao访问） 4、@component （把普通pojo实例化到spring容器中，相当于配置文件中的&lt;bean id="" class=""/&gt;）       @Component,@Servi...
Lombok的简单使用（IDEA)
YW博客
03-03 299
1.安装Lombok插件 让idea支持Lombok,指能够在源码中识别注解，调用链式方法，因为Lombok是在编译期起作用 2.实现原理： 在源码.java文件编译生成.class时，加入get,set等方法 3.导入Lombo依赖 4.常用： 1）@Data 生成get,set，hashcode,equals,toString方法 2) @Getter,@Setter,@ToString 3) 日志功能：@Slf4j(酸辣粉4斤），该注解相当于 private Logger log=LoggerFac
Lombok的使用和常用注解使用示例
.... 永远年轻，永远热泪盈眶
06-11 1万+
无意中发现了一个巨牛的人工智能教程，忍不住分享一下给大家。教程不仅是零基础，通俗易懂，而且非常风趣幽默，像看小说一样！觉得太牛了，所以分享给大家。点这里可以跳转到教程。 为何要使用Lombok 我们在开发过程中，通常都会定义大量的JavaBean，然后通过IDE去生成其属性的构造器、getter、setter、equals、hashcode、toString方法，当要增加属性或者对某个属性进...
一文搞懂Redis（VIP典藏版）
热门推荐
慕白Lee的博客
08-13 5万+
Nosql = not only sql（不仅仅是SQL）关系型数据库：列+行，同一个表下数据的结构是一样的。非关系型数据库：数据存储没有固定的格式，并且可以进行横向扩展。NoSQL泛指非关系型数据库，随着web2.0互联网的诞生，传统的关系型数据库很难对付web2.0大数据时代！尤其是超大规模的高并发的社区，暴露出来很多难以克服的问题，NoSQL在当今大数据环境下发展的十分迅速，Redis是发展最快的。传统RDBMS和NoSQLRDBMS- 组织化结构- 固定SQL。............
Lombok，一种编译时Java注释预处理器，可最大程度地减少代码大小
最佳 Java 编程
06-02 328
在本文中，我们将看到如何在常规Java代码中使用lombok来最小化代码长度和冗余。 什么是Lombok？ Lombok，一个编译时注释预处理器，有助于在编译时注入一些代码。 在详细介绍之前，我要求您应该从他们的网站上观看视频。 我不会像这样进行现场演示，但是我将展示如何在项目内部使用它（包括Maven生命周期）。 让我们从基本的了解开始。 如我所知，lombok是一个编译时注释...
IntelliJ IDEA 中使用 Lambok （注解无效问题的解决）
08-21 838
一，概述 Lambok可以说一个能很大提高开发效率的插件，只要在使用注解的方式就能实现很多常用的功能。如常用的@Data能在编译阶段自动生成toString方法，getter方法setter方法等。 二，问题 但我在刚开始在IDEA中使用它的时候，注解总是使用不了，经查阅资料后要如下设置才能使用。 三，解决 ①添加Lombok插件以添加对IntelliJ的lombok支持： ...
lombok注解不起作用
04-29
如果您使用Lombok注解没有起作用，可能是由于以下原因之一： 1. 您没有在IDE中安装Lombok插件。请确保您已经安装了Lombok插件，并且该插件已经启用。 2. 您的编译器不支持Lombok注解。请检查您的编译器是否支持...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值