Lombok常用注解

简介: Lombok常用注解

一、简介

官网

https://projectlombok.org/

二、Idea中配置

三、Maven中配置

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

四、相应注解

1、@Data

作用位置: 类上(实体类)

用途:

是1个注解集合:

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

案例:

@Data
public class User {
    private String name;
    private int age;
    private String address;
}

2、@RequiredArgsConstructor

作用位置: 类上(实体类)

用途:

注解 集合:

  • @AllArgsConstructor
  • @NoArgsConstructor
    案例:
@RequiredArgsConstructor
public class User {
    private String name;
    private int age;
    private String address;
}

3、@AllArgsConstructor

作用位置: 类上(实体类)

用途: 生成全参构造器

案例:

@AllArgsConstructor
public class User {
    private String name;
    private int age;
    private String address;
}

4、@NoArgsConstructor

作用位置: 类上(实体类)

用途: 生成无参构造器

案例:

@NoArgsConstructor
public class User {
    private String name;
    private int age;
    private String address;
}

5、@Getter/@Setter:

作用位置: 类上(实体类)、成员变量

用途:

作用类上:生成所有成员变量的getter/setter方法

成员变量:生成该成员变量的getter/setter方法

案例:

@Getter
@Setter
public class User {
    private String name;
    private int age;
    private String address;
}

6、@ToString

作用位置: 作用于类。

用途: 覆盖默认的toString()方法。

案例:

@ToString
public class User {
    private String name;
    private int age;
    private String address;
}

7、@EqualsAndHashCode

作用位置: 作用于类

用途: 覆盖默认的equals和hashCod

案例:

@EqualsAndHashCode
public class User {
    private String name;
    private int age;
    private String address;
}

8、@Builder

作用位置: 作用于类上

用途: 将类转变为建造者模式

案例:

import lombok.Builder;
@Builder
public class User {
    private String name;
    private int age;
    private String address;
}
public void test() {
    User build = User.builder()
            .name("张三")
            .age(18)
            .address("北京")
            .build();
}

9、@NonNull

作用位置: 成员变量和参数中

用途: 标识不能为空,否则抛出空指针异常

案例:

public NonNullExample(@NonNull Person person) {
   super("Hello");
   this.name = person.getName();
}

10、@Log

作用位置: 作用于类上

用途: 生成日志变量。针对不同的日志实现产品,有不同的注解

java.util.logging.Logger
java.util.logging.Logger#getLogger(java.lang.String)
@CommonsLog
@Log4j
@Log4j2
@Slf4j
@XSlf4j
@JBossLog
@Flogger
@CustomLog

案例:

@Log
public class Test {
    public void test() {
    }
}

11、@Slf4j

作用位置:

用途: 表明使用slf4j日志门面

案例:

@Slf4j
public class LogExampleOther {
  public void test() {
    log.error("Something else is wrong here");
  }
}

12、@Log4j2

作用位置:

用途:

  • 自动关闭资源
  • 针对实现了java.io.Closeable接口的对象有效,如:典型的IO流对象

案例:

@Log4j2
public class LogExampleOther {
  public void test() {
    log.error("Something else is wrong here");
  }
}

13、@SneakyThrows

作用位置:

用途: 可以对受检异常进行捕捉并抛出

案例:

import lombok.SneakyThrows;
public class SneakyThrowsExample implements Runnable {
  @SneakyThrows(UnsupportedEncodingException.class)
  public String utf8ToString(byte[] bytes) {
    return new String(bytes, "UTF-8");
  }
  @SneakyThrows
  public void run() {
    throw new Throwable();
  }
}

14、@Cleanup

作用位置:

案例:

import lombok.Cleanup;
import java.io.*;
public class CleanupExample {
  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);
    }
  }
}

15、@Synchronized

  • 作用于方法级别,可以替换synchronize关键字或lock锁
  • 用处不大

16、@SneakyThrows

使用位置: 方法

作用: 可以将方法中的代码用 try-catch 语句包裹起来,捕获异常并在 catch 中用 Lombok.sneakyThrow(e) 把异常抛出,可以使用 @SneakyThrows(Exception.class) 的形式指定抛出哪种异常。

案例:

import lombok.SneakyThrows;
public class SneakyThrowsExample implements Runnable {
  @SneakyThrows(UnsupportedEncodingException.class)
  public String utf8ToString(byte[] bytes) {
    return new String(bytes, "UTF-8");
  }
  @SneakyThrows
  public void run() {
    throw new Throwable();
  }
}

效果:

import lombok.Lombok;
public class SneakyThrowsExample implements Runnable {
  public String utf8ToString(byte[] bytes) {
    try {
      return new String(bytes, "UTF-8");
    } catch (UnsupportedEncodingException e) {
      throw Lombok.sneakyThrow(e);
    }
  }
  public void run() {
    try {
      throw new Throwable();
    } catch (Throwable t) {
      throw Lombok.sneakyThrow(t);
    }
  }
}

五、XMind整理

地址

https://download.csdn.net/download/weixin_44624117/87738347

目录
相关文章
|
17天前
|
XML Java 编译器
Java学习十六—掌握注解:让编程更简单
Java 注解(Annotation)是一种特殊的语法结构,可以在代码中嵌入元数据。它们不直接影响代码的运行,但可以通过工具和框架提供额外的信息,帮助在编译、部署或运行时进行处理。
84 43
Java学习十六—掌握注解:让编程更简单
|
12天前
|
Java 开发者 Spring
[Java]自定义注解
本文介绍了Java中的四个元注解(@Target、@Retention、@Documented、@Inherited)及其使用方法,并详细讲解了自定义注解的定义和使用细节。文章还提到了Spring框架中的@AliasFor注解,通过示例帮助读者更好地理解和应用这些注解。文中强调了注解的生命周期、继承性和文档化特性,适合初学者和进阶开发者参考。
36 14
|
12天前
|
前端开发 Java
[Java]讲解@CallerSensitive注解
本文介绍了 `@CallerSensitive` 注解及其作用,通过 `Reflection.getCallerClass()` 方法返回调用方的 Class 对象。文章还详细解释了如何通过配置 VM Options 使自定义类被启动类加载器加载,以识别该注解。涉及的 VM Options 包括 `-Xbootclasspath`、`-Xbootclasspath/a` 和 `-Xbootclasspath/p`。最后,推荐了几篇关于 ClassLoader 的详细文章,供读者进一步学习。
26 12
|
2月前
|
Java
lombok的使用
本文介绍了Lombok库的基本使用方法和常用注解,通过示例代码展示了如何使用Lombok简化Java对象的创建、属性访问、日志记录等编码工作,使代码更加简洁。
lombok的使用
|
6天前
|
Java 编译器
Java进阶之标准注解
Java进阶之标准注解
18 0
|
1月前
|
JSON Java 数据库
java 常用注解大全、注解笔记
关于Java常用注解的大全和笔记,涵盖了实体类、JSON处理、HTTP请求映射等多个方面的注解使用。
34 0
java 常用注解大全、注解笔记
|
24天前
|
IDE Java 编译器
java的反射与注解
java的反射与注解
14 0
|
2月前
|
Java 编译器 程序员
Java注解,元注解,自定义注解的使用
本文讲解了Java中注解的概念和作用,包括基本注解的用法(@Override, @Deprecated, @SuppressWarnings, @SafeVarargs, @FunctionalInterface),Java提供的元注解(@Retention, @Target, @Documented, @Inherited),以及如何自定义注解并通过反射获取注解信息。
Java注解,元注解,自定义注解的使用
|
2月前
|
IDE Java 编译器
lombok编译遇到“找不到符号的问题”
【9月更文挑战第18天】当使用 Lombok 遇到 “找不到符号” 的问题时,可能是由于 Lombok 未正确安装、编译器不支持、IDE 配置不当或项目构建工具配置错误。解决方法包括确认 Lombok 安装、编译器支持,配置 IDE 和检查构建工具配置。通过这些步骤通常可解决问题,若问题仍存在,建议检查项目配置和依赖,或查看日志获取更多信息。
460 2
|
1月前
|
XML Java 数据格式
Java-spring注解的作用
Java-spring注解的作用
20 0