Lombok常用注解总结

已于 2023-11-07 15:54:04 修改
阅读量1.7k 收藏 7
点赞数 2
分类专栏： Java 文章标签： java
于 2019-12-22 22:06:59 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_33204709/article/details/103657755
版权

Lombok常用注解总结

什么是Lombok

Lombok是一个通过使用注解修饰，来简化Java代码的一个工具库。

官网中为大家展示了如何将 Lombok 作为扩展，添加到 IDE上。

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

下面为大家介绍一些常用的Lombok工具注解：

基本注解：

注解功能
@ToString修饰JavaBean，可以动态生成相应的ToString方法，
格式为：User(username=admin, password=123)<br /
@EqualsAndHashCode修饰JavaBean，默认情况下，会使用所有非静态（non-static）和非瞬态（non-transient）属性来生成equals和hasCode
@Getter可以修饰JavaBean，也可以修饰属性，生成相应属性的get()方法
@Setter可以修饰JavaBean，也可以修饰属性，生成相应属性的set()方法
@NonNull修饰方法参数，自动判断参数是否为null，为nulll则抛出NullPointerException
@NoArgsConstructor修饰JavaBean，可以动态生成无参构造器方法
@RequiredArgsConstructor修饰JavaBean，生成private构造方法，使用staticName选项生成指定名称的static方法，与@NonNull联用，指定那些属性是本方法参数
@AllArgsConstructor修饰JavaBean，可以动态生成全参构造器方法
@Data修饰JavaBean，集合了@ToString、@EqualsAndHashCode、@Getter/@Setter、@RequiredArgsConstructor的所有特性。
@Value修饰JavaBean，和@Data类似，区别在于它会把所有成员变量默认定义为private final修饰，并且不会生成set方法
@Slf4j修饰JavaBean，当项目中使用Slf4j日志架构的时候自动创建log日志实例
@Log4j修饰JavaBean，当项目中使用Log4j日志架构的时候自动创建log日志实例，需要创建log4j.properties配置文件，推荐使用@Log4j2
@Log4j2修饰JavaBean，当项目中使用Log4j日志架构的时候自动创建日志实例，不需要配置文件
@Synchronized修饰方法，自动生成同步代码块锁
@Cleanup修饰流变量，自动调用close()方法

高级注解：

注解功能
@Accessors(chain=true)修饰JavaBean，链式风格，在调用set方时，返回当前实例
@Builder修饰JavaBean，构建者模式，不可与@NoArgsConstructor同时使用
@Delegate修饰JavaBean，代理模式

IDEA Lombok 插件安装

打开IDEA

Ctrl + Alt + S 打开 设置面板

在Plugins的Marketplace中搜索Lombok

在这里插入图片描述

Lombok Maven坐标

<!-- Lombok -->
<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
  <version>1.18.8</version>
</dependency>

Lombok 公共属性

属性作用
exclude不包含哪些属性
示例：@ToString(exclude = {“username”})
of包含哪些属性
示例：@ToString(of = {“username”})
callSuper是否包含超类
示例：@ToString(callSuper=true)

示例参考@ToString

Lombok 基础注解 详解

@ToString

修饰JavaBean，可以动态生成相应的ToString方法，格式为：User(username=admin, password=123)

@ToString(exclude={“column1”,“column2”})：排除多个column列所对应的元素

@ToString(of={“column1”,“column2”})：只生成包含多个column列所对应的元素

代码实现

public class Test {
    public static void main(String[] args) {
        User1 user1 = new User1().setUsername("admin").setPassword("123");
        System.out.println(user1);
        User2 user2 = new User2().setUsername("admin").setPassword("123");
        System.out.println(user2);
        User3 user3 = new User3().setUsername("admin").setPassword("123");
        System.out.println(user3);
        User4 user4 = new User4().setUsername("admin").setPassword("123");
        System.out.println(user4);
    }
}
@ToString
class User1{
    private String username;
    private String password;

    public User1 setUsername(String username) {
        this.username = username;
        return this;
    }

    public User1 setPassword(String password) {
        this.password = password;
        return this;
    }
}
@ToString(exclude = {"username"})
class User2{
    private String username;
    private String password;

    public User2 setUsername(String username) {
        this.username = username;
        return this;
    }

    public User2 setPassword(String password) {
        this.password = password;
        return this;
    }
}
@ToString(of = {"username"})
class User3{
    private String username;
    private String password;

    public User3 setUsername(String username) {
        this.username = username;
        return this;
    }

    public User3 setPassword(String password) {
        this.password = password;
        return this;
    }
}
@ToString(callSuper=true, includeFieldNames=false)
class User4{
    private String username;
    private String password;

    public User4 setUsername(String username) {
        this.username = username;
        return this;
    }

    public User4 setPassword(String password) {
        this.password = password;
        return this;
    }
}

输出结果

User1(username=admin, password=123)
User2(password=123)
User3(username=admin)
User4(super=com.test.User4@6536e911, admin, 123)

@EqualsAndHashCode

修饰JavaBean，默认情况下，会使用所有非静态（non-static）和非瞬态（non-transient）属性来生成equals和hasCode

代码实现

public class Test {
    public static void main(String[] args) {
        User1 user11 = new User1().setUsername("admin").setPassword("123");
        User1 user12 = new User1().setUsername("admin1").setPassword("123");
        System.out.println(user11.equals(user12));
        User2 user21 = new User2().setUsername("admin").setPassword("123");
        User2 user22 = new User2().setUsername("admin1").setPassword("123");
        System.out.println(user21.equals(user22));
        User3 user31 = new User3().setUsername("admin").setPassword("123");
        User3 user32 = new User3().setUsername("admin").setPassword("1234");
        System.out.println(user31.equals(user32));
    }
}
@EqualsAndHashCode
class User1{
    private String username;
    private String password;

    public User1 setUsername(String username) {
        this.username = username;
        return this;
    }

    public User1 setPassword(String password) {
        this.password = password;
        return this;
    }
}
@EqualsAndHashCode(exclude = {"username"})
class User2{
    private String username;
    private String password;

    public User2 setUsername(String username) {
        this.username = username;
        return this;
    }

    public User2 setPassword(String password) {
        this.password = password;
        return this;
    }
}
@EqualsAndHashCode(of = {"username"})
class User3{
    private String username;
    private String password;

    public User3 setUsername(String username) {
        this.username = username;
        return this;
    }

    public User3 setPassword(String password) {
        this.password = password;
        return this;
    }
}

输出结果

false
true
true

@Getter

可以修饰JavaBean，也可以修饰属性，生成相应属性的get()方法

代码实现

public class Test {
    public static void main(String[] args) {
        User user = new User();
        System.out.println("username:" + user.getUsername());
        System.out.println("password:" + user.getPassword());
    }
}
@Getter
class User{
    private String username = "admin";
    private String password = "123";
}

输出结果

username:admin
password:123

@Setter

可以修饰JavaBean，也可以修饰属性，生成相应属性的set()方法

代码实现

public class Test {
    public static void main(String[] args) {
        User user = new User();
        user.setUsername("admin");
        user.setPassword("123");
        System.out.println(user);
    }
}
@Setter
@ToString
class User{
    private String username;
    private String password;
}

输出结果

User(username=admin, password=123)

@NonNull

修饰方法参数，自动判断参数是否为null，为null则抛出NullPointerException

代码实现

public class Test {
    public static void main(String[] args) {
        Test.test("");
        Test.test(null);
    }
    public static void test(@NonNull String str) {
        System.out.println("str:" + str);
    }
}

输出结果

str:
Exception in thread "main" java.lang.NullPointerException: str

@NoArgsConstructor

修饰JavaBean，可以动态生成无参构造器方法

最没用的注解，没有之一！

代码实现

public class Test {
    public static void main(String[] args) {
        User user = new User();
        System.out.println(user);
    }
}
@NoArgsConstructor
class User{
    private String username;
    private String password;
}

输出结果

com.test.User@7bb11784

@RequiredArgsConstructor

修饰JavaBean，生成private构造方法，使用staticName选项生成指定名称的static方法，与@NonNull联用，指定那些属性是本方法参数

代码实现

public class Test {
    public static void main(String[] args) {
        User user = new User();
        System.out.println("user:" + user);
        User2 user2 = User2.of();
        System.out.println("user2:" + user2);
    }
}
@RequiredArgsConstructor
class User{
    private String username;
    private String password;
}
@RequiredArgsConstructor(staticName = "of")
class User2{
    private String username;
    private String password;
}

输出结果

user:com.test.User@7bb11784
user2:com.test.User2@33a10788

@AllArgsConstructor

修饰JavaBean，可以动态生成全参构造器方法

代码实现

public class Test {
    public static void main(String[] args) {
        User user = new User("admin", "123");
        System.out.println("user:" + user);
    }
}
@AllArgsConstructor()
@ToString
class User{
    private String username;
    private String password;
}

输出结果

user:User(username=admin, password=123)

@Data

修饰JavaBean，集合了@ToString、@EqualsAndHashCode、@Getter/@Setter、@RequiredArgsConstructor的所有特性，如果属性中

代码实现

public class Test {
    public static void main(String[] args) {
        User user = new User();
        User user1 = new User();
        System.out.println(user.equals(user1));
        user.setUsername("admin");
        System.out.println("admin:" + user.getUsername());
        System.out.println("user:" + user);
        User2 user2 = User2.of("admin2");
        System.out.println("user2:" + user2);
    }
}
@Data
class User{
    private String username;
    private String password;
}
@Data(staticConstructor = "of")
class User2{
    @NonNull
    private String username;
    private String password;
}

输出结果

true
admin:admin
user:User(username=admin, password=null)
user2:User2(username=admin2, password=null)

@Value

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

代码实现

public class Test {
    public static void main(String[] args) {
        User user = new User("admin", "123");
        System.out.println(user);
    }
}
@Value
class User{
    private String username;
    private String password;
}

输出结果

User(username=admin, password=123)

@Slf4j

修饰JavaBean，当项目中使用Slf4j日志架构的时候自动创建log日志实例

@Slf4j主要用于替换如下代码

private static final Logger log = LoggerFactory.getLogger(当前类名.class);

Slf4j Maven 坐标

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
</dependency>

代码实现

@Slf4j
public class Test {
    public static void main(String[] args) {
        log.info("test");
    }
}

输出结果

SLF4J: Class path contains multiple SLF4J bindings.
SLF4J: Found binding in [jar:file:/D:/maven_repository/ch/qos/logback/logback-classic/1.2.3/logback-classic-1.2.3.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: Found binding in [jar:file:/D:/maven_repository/org/apache/logging/log4j/log4j-slf4j-impl/2.10.0/log4j-slf4j-impl-2.10.0.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: See http://www.slf4j.org/codes.html#multiple_bindings for an explanation.
SLF4J: Actual binding is of type [ch.qos.logback.classic.util.ContextSelectorStaticBinder]
09:59:36.413 [main] INFO com.test.Test - test

@Log4j

修饰JavaBean，当项目中使用Log4j日志架构的时候自动创建日志实例

@Log4j主要用于替换如下代码

private static final Logger log = Logger.getLogger(当前类名.class);

Log4j Maven 坐标

<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

在项目的resources目录下，创建log4j.properties文件，内容如下：

# Global logging configuration 开发时候建议使用 debug
#log4j.rootLogger=debug, stdout
log4j.rootLogger=info, stdout

# Console output...
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d %p [%c] - %m%n

代码实现

@Log4j
public class Test {
    public static void main(String[] args) {
        log.info("test");
    }
}

输出结果

2019-12-23 10:34:46,566 INFO [com.test.Test] - test

@Log4j2

修饰JavaBean，当项目中使用Log4j日志架构的时候自动创建日志实例

@Log4j主要用于替换如下代码

private static final Logger log = Logger.getLogger(当前类名.class);

Log4j Maven 坐标

<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

代码实现

@Log4j2
public class Test {
    public static void main(String[] args) {
        log.info("test");
    }
}

输出结果

10:49:52.742 [main] INFO com.test.Test - test

@Synchronized

修饰方法，自动生成同步代码块锁

@Sychronized 是一个处理线程安全问题的annotation， 类似 synchronized关键字，不同点在于关键字synchronized是锁定当前对象（this指针） ， 而@Synchronized则会锁定一个private的常量。如果当前类中没有这个常量，就会自动生成一个。

代码实现

public class Test {

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

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

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

相当于

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

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

    public void test2() {
        synchronized($lock) {
            System.out.println("test2");
        }
    }

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

@Cleanup

修饰流变量，自动调用close()方法

代码实现

public class Test {
    public static void main(String[] args) throws IOException {
        @Cleanup InputStream in = new FileInputStream(args[0]);
        @Cleanup OutputStream out = new FileOutputStream(args[1]);
    }
}

Lombok 高级注解 详解

@Accessors(chain=true)

修饰JavaBean，链式风格，在调用set方时，返回当前实例

代码实现

public class Test {
    public static void main(String[] args) {
        User user = new User().setUsername("admin").setPassword("123");
        System.out.println(user);
    }
}
@Setter
@ToString
@Accessors(chain = true)
class User{
    private String username;
    private String password;
}

输出结果

User(username=admin, password=123)

@Builder

修饰JavaBean，构建者模式，不可与@NoArgsConstructor同时使用

代码实现

public class Test {
    public static void main(String[] args) {
        User user = User.builder().username("admin").password("123").build();
        System.out.println(user);
    }
}
@Builder
@ToString
class User{
    private String username;
    private String password;
}

输出结果

User(username=admin, password=123)

@Delegate

修饰JavaBean，代理模式

代码实现

@AllArgsConstructor
public abstract class FilterRestTemplate implements RestOperations {
    @Delegate
    protected volatile RestTemplate restTemplate;
}

/*********************************************/

public abstract class FilterRestTemplate implements RestOperations {

    protected volatile RestTemplate restTemplate;

    protected FilterRestTemplate(RestTemplate restTemplate) {
            this.restTemplate = restTemplate;
    }

    @Override
    public <T> T getForObject(String url, Class<T> responseType, Object... uriVariables) throws RestClientException {
            return restTemplate.getForObject(url,responseType,uriVariables);
    }

    @Override
    public <T> T getForObject(String url, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException {
            return restTemplate.getForObject(url,responseType,uriVariables);
    }

    @Override
    public <T> T getForObject(URI url, Class<T> responseType) throws RestClientException {
            return restTemplate.getForObject(url,responseType);
    }

    @Override
    public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Object... uriVariables) throws RestClientException {
            return restTemplate.getForEntity(url,responseType,uriVariables);
    }
    //其他实现代码略。。。
}







参考：

https://www.cnblogs.com/heyonggang/p/8638374.html

https://www.cnblogs.com/pascall/p/10281169.html

不愿放下技术的小赵
关注
  • 2
    点赞
  • 踩
  • 7
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
专栏目录
lombok常用注解总结
cbb
05-19 600
lombok 简介 Lombok项目是一个Java库，它会自动插入编辑器和构建工具中，Lombok提供了一组有用的注释，用来消除Java类中的大量样板代码。 “Boilerplate”是一个术语，用于描述在应用程序的许多部分中很少改动就重复的代码。对Java语言最常见的批评就是在大多数项目中都可以找到这种类型的代码，由于语言本身的局限性而更加严重。龙目岛计划（Project Lombok）旨在通过用简单的注释集代替众多的代码。 lombok官网 常用的注解 @Data//生成get和set （注解
Lombok 实战教程 - @ToString | 自动生成类的 ToString 方法
最新发布
qq_33240556的博客
05-25 580
Lombok 提供的@ToString注解可以帮助我们自动生成类的toString方法，从而减少样板代码，使代码更加简洁和可读。@ToString注解不仅可以生成包含类中所有字段的toString方法，还可以根据需要进行自定义。@ToString。
LomBok常用注解及详细介绍
weixin_43982125的博客
09-05 9997
Lombok是一个作用于编辑器和构建工具的 Java 库，可以对编写的 Java 代码进行增强，比如说不用再写实体类的 getter 方法，equals 方法而是自动生成，自动生成日志输出变量等等，减少重复模板的代码。以上就是今天要讲的内容，本文仅仅简单介绍了LomBok注解的使用。
lombok常用注解整理
qq_43842093的博客
11-10 699
idea需要先安装好lombok插件，不会的可以参考这里https://blog.csdn.net/qq_43842093/article/details/115426380 引入依赖 <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok --> <dependency> <groupId>org.projectlombok</groupId> <artifact
Lombok 常用注解
m0_53067943的博客
07-26 505
主演总结了Lombok的常用注解
Lombok技术常用注解总结
m0_57697501的博客
07-17 656
简单的技术，对实体的注解简化
lombok常用注解
Java程序媛，欢迎大家一起交流学习~
05-26 887
lombok注解也是大家经常用到的，下面让我们一起看下吧~lombok注解使用起来会很方便，大家可以多去了解不同注解的作用哦。
Lombok工具 : 常用注解介绍 (全)
Guizy
08-14 8371
Lombok详细介绍, 全
SpringBoot(十一)： Lombok常用注解
mingyuli的博客
09-22 1210
·
【Java基础系列1】Lombok常用注解
飞楼踏梦
08-05 604
主要讲解Lombok几个常用的基本注解的使用。 最近工作中看到很多这种注解，就统一梳理一下，看一下相关的注解有哪些，便于应用到项目中。 前言 ​Lombok是一款在java开发中简洁化代码十分有用的插件工具，lombok提供了很多注解，在编译时候生成java代码，代替了手工编写一些简单的代码，使程序员可以关注更重要的实现。 插件配置 在使用lombok插件的时候，还要进行添加lombok的Maven依赖，代码示例： <!--lombok注解--> <dependen...
注解、反射、单元测试、lombok知识点总结笔记
01-30
Lombok是一个Java库，它通过注解处理器自动为类生成常见的 getter、setter、构造函数和其他常用方法，以减少样板代码。例如，使用`@Data`注解，Lombok会自动生成所有字段的getter和setter，使得代码更简洁、易于阅读...
tedu二阶段Lombok
03-13
以下是一些常用的注解及其用途： ##### 1. @Getter 和 @Setter 这两个注解用于生成字段的 getter 和 setter 方法。例如： ```java import lombok.Getter; import lombok.Setter; @Getter @Setter public class ...
lombok插件
11-29
以下是一些常用的Lombok注解： - `@Data`：这个注解会为类的所有非静态、非transient字段生成getter和setter方法，同时还会生成`equals()`, `hashCode()`和`toString()`方法。 - `@Getter` 和 `@Setter`：分别用于...
IDE工具lombok插件
05-12
Lombok是一个Java库，它通过注解处理器在编译时自动添加getter、setter、构造函数等常用方法，从而减少冗余代码，提高开发效率。Lombok插件则是集成于各类IDE（如IntelliJ IDEA、Eclipse等）中的辅助工具，帮助...
lombok.jar
04-12
Lombok是一款非常实用的Java库，它通过注解的方式，帮助开发者自动地生成Java实体类中的getter、setter、构造函数以及其他常用的辅助方法。这极大地简化了代码，避免了手动编写这些样板代码的繁琐过程，提高了开发...
Java 内存溢出（二）使用 MAT 分析 .hprof 内存映像文件
热门推荐
ACGkaka的博客
11-25 1万+
.hprof 文件：是 java 项目的 Heap Dump 文件，也叫内存映像文件、内存快照文件，可以存放一个 java 进程在某个时间点的内存快照。生成 Heap Dump 文件的方式有两种：一是使用 `jmap` 命令手动导出，二是启动脚本中添加 `-XX:+HeapDumpOnOutOfMemoryError` 参数自动导出。本文中只涉及第二种。
spring-mybatis整合配置文件（spring-mybatis.xml）
ACGkaka的博客
07-20 9633
spring-mybatis整合主要有以下配置： 1.读取jdbc配置文件（jdbc.properties），文件中是jdbc连接数据库的参数。 例如：mysql：（database_name处填写数据库名） driver=com.mysql.jdbc.Driver url=jdbc:mysql://localhost:3306/database_name us...
SpringBoot中@EnableAsync和@Async注解的使用
ACGkaka的博客
04-24 7253
SpringBoot中@EnableAsync和@Async注解的使用
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

不愿放下技术的小赵

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值