Lombok你不知道的用法

news2024/11/24 9:39:52

Lombok是大家经常用的一款工具，它可以帮我们减少很多重复代码的书写，但是我们对它的使用，可能更多局限于实体类的编写，比如说通过@Data注解实现减少getter/setter/toString等方法的编写，其实它还有更多的注解功能，让我们一起来了解Lombok更多的注解吧！

1. IDEA中的安装

IDEA的Setting –> 选择Plugins选项 –> 选择Browse repositories –> 搜索lombok –> 点击安装 –> 安装完成重启IDEA –> 安装成功
如下图：
在这里插入图片描述

2. 依赖的引入

在项目中添加Lombok依赖jar，在pom文件中添加如下，版本可以自己去Maven仓库找：

<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.16.18</version>
    <scope>provided</scope>
</dependency>

3. Lombok常用注解

@Setter
@Getter
@Data
@Log(泛型注解，具体有很多种形式)
@AllArgsConstructor
@NoArgsConstructor
@EqualsAndHashCode
@NonNull
@Cleanup
@ToString
@RequiredArgsConstructor
@Value
@SneakyThrows
@Synchronized

4. 注解详情

4.1 log

注解在类上。有如下可选择可用：

//@CommonsLog 等价于
private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);
//@JBossLog 等价于
private static final org.jboss.logging.Logger log = org.jboss.logging.Logger.getLogger(LogExample.class);
//@Log 等价于
private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName());
//@Log4j 等价于
private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class);
//@Log4j2 等价于
private static final org.apache.logging.log4j.Logger log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);
//@Slf4j 等价于
private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class);
//@XSlf4j 等价于
private static final org.slf4j.ext.XLogger log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);

最常用的是@Slf4j注解，主要看你要引用哪个日志框架，不同的注解，引用的日志框架不同。自己根据情况选择。

4.2 @Getter和@Setter

该注解使用在类或者属性上，生成的getter遵循布尔属性的约定。例如：boolean类型的sex,getter方法为isSex而不是getSex。
在使用该注解时，会默认生成一个无参构造。和对应的getterhe setter方法，如下图，二者是等价的：
在这里插入图片描述
该注解也可以使用在单个属性上，会默认生成一个无参构造：

4.3 @Data

该注解使用在类上，是最常用的注解，它是@ToString，@EqualsAndHashCode， @Getter和@Setter的结合。本质上使用@Data注解，类默认@ToString和@EqualsAndHashCode以及每个字段都有@Setter和@getter。同时也会生成一个公共构造函数，可以将所有字段作为参数。

4.4 @NonNull

该注解使用在属性上，用于非空检查，当放在setter方法的字段上，将生成一个空检查，如果为空，则抛出NullPointerException。该注解会默认是生成一个无参构造。

4.5 @toString

该注解使用在类上，该注解默认生成任何非讲台字段以名称-值的形式输出。
参数：

includeFieldNames：是否包含属性名称。
exclude：排除指定字段
callSuper：输出父类属性

注意：父类也要有toString方法，不然打印的是对象内存地址

4.6 @EqualsAndHashCode

该注解使用在类上，该注解在类级别注释会同时生成equals和hashCode。
存在继承关系需要设置callSuper参数为true。

4.7 @AllArgsConstructor

该注解使用在类上，该注解提供一个全参数的构造方法，默认不提供无参构造。

4.8 @NoArgsConstructor

该注解使用在类上，该注解提供一个无参构造。

4.9 @RequiredArgsConstructor

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

4.10 @Value

这个注解用在类上，会生成含所有参数的构造方法，get 方法，此外还提供了equals、hashCode、toString 方法。 注意：没有setter。

4.11 @Cleanup

该注解使用在属性前，该注解是用来保证分配的资源被释放。在本地变量上使用该注解，任何后续代码都将封装在try/finally中，确保当前作用于中的资源被释放。默认@Cleanup清理的方法为close，可以使用value指定不同的方法名称，例如 @Cleanup("clean")。
如下：
不使用之前：

try {
	// to do something
}finally {
    if (in != null) {
        in.close();
    }
}

public class CleanupExample {
    public static void main(String[] args) throws IOException {

        try(InputStream inputStream =
                    new FileInputStream(".\\src\\main\\java\\com\\cauchy6317\\common\\Cleanup\\ForCleanupExample.txt")){
            // to do something
        }
        @Cleanup Reader fileReader =
                new FileReader(".\\src\\main\\java\\com\\cauchy6317\\common\\Cleanup\\ForCleanupExample1.txt");
        // to do something

    }
}

4.12 @Synchronized

在方法上使用synchronized 关键字可能会导致不幸的后果。如果是实例方法，则synchronized 关键字将锁定当前对象（此对象）；对于静态方法，该关键字将锁定该类对象。这意味着开发人员无法控制代码锁定同一对象，从而导致死锁。通常建议改为显式地锁定在专用于该目的的单独对象上，并且不要以允许未经请求的锁定的方式公开。

该注解使用在类或者实例方法上。该注解用在类方法或者实例方法上，效果和 synchronized 关键字相同，区别在于锁对象不同。对于类方法和实例方法，它俩区别在于：

synchronized 关键字的锁对象分别是“类的 class 对象”和“this 对象”
@Synchronized 的锁对象分别是“私有静态 final 对象 lock”和“私有 final 对象 lock”。当然，也可以自己指定锁对象。

用@Synchronized注释实例方法将提示Lombok生成一个名为$lock的私有锁定字段，该方法将在执行之前在该字段上锁定。类似地，以相同的方式注释静态方法将生成一个名为$lock的私有静态对象，以供静态方法以相同方式使用。可以通过为注释的value参数提供字段名称来指定其他锁定对象。提供字段名称时，开发人员必须定义属性，因为Lombok不会生成该属性。

使用如下：

    private DateFormat format = new SimpleDateFormat("MM-dd-YYYY");
     
    @Synchronized
    public String synchronizedFormat(Date date) {
        return format.format(date);
    }

等价于：

 private final java.lang.Object $lock = new java.lang.Object[0];
 private DateFormat format = new SimpleDateFormat("MM-dd-YYYY");
     
    public String synchronizedFormat(Date date) {
        synchronized ($lock) {
            return format.format(date);
        }
    }

4.13 @SneakyThrows

该注解使用在方法上，这个注解用在方法上，可以将方法中的代码用 try-catch 语句包裹起来，捕获异常并在 catch 中用Lombok.sneakyThrow(e) 把异常抛出，可以使用 @SneakyThrows(Exception.class) 的形式指定抛出哪种异常。该注解需要谨慎使用。

在这里插入图片描述