轻松搞定Java代码，Lombok注解全解析！

在日常的Java开发中，我们经常会面对大量繁琐的模板代码，比如各种getter和setter、equals和hashCode方法，以及各种构造函数等等。这些代码虽然简单，但却占用了我们宝贵的开发时间。幸运的是，Lombok库的出现，让我们可以用几个简单的注解来自动生成这些模板代码，极大地提升了我们的开发效率。

在这篇文章中，我们将全面讲解Lombok库提供的所有注解，并通过通俗易懂的方式，配合详细的Java示例，帮助你快速掌握Lombok的强大功能。让我们开始吧！

什么是Lombok？

Lombok是一个Java库，它通过一系列的注解来帮助开发者减少冗余的Java代码。简而言之，Lombok能够自动为你的Java类生成getter和setter、构造函数、toString、equals和hashCode方法，甚至更多。这意味着你不再需要手动编写和维护这些重复的模板代码，从而让你可以专注于真正重要的业务逻辑。

Lombok的安装

在开始使用Lombok之前，你需要将其添加到你的项目中。如果你使用的是Maven，只需要在你的pom.xml文件中添加以下依赖：

复制代码

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>最新版本号</version>
    <scope>provided</scope>
</dependency>

请确保替换最新版本号为Lombok的最新版本。

Lombok注解全览

接下来，让我们一一探索Lombok提供的各种注解，并了解它们的用法。

@Getter 和 @Setter

这是两个最常用的Lombok注解，它们分别用于生成字段的getter和setter方法。

复制代码

import lombok.Getter;
import lombok.Setter;

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

上面的代码会自动生成getName(), setName(String name), getAge(), setAge(int age)这四个方法。

@ToString

@ToString注解可以帮助你自动生成toString方法，这个方法会返回一个包含所有字段信息的字符串。

复制代码

import lombok.ToString;

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

@EqualsAndHashCode

这个注解会自动生成equals方法和hashCode方法。

复制代码

import lombok.EqualsAndHashCode;

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

@NoArgsConstructor, @RequiredArgsConstructor 和 @AllArgsConstructor

这三个注解分别用于自动生成无参构造函数、部分参数的构造函数（对于有final修饰符或者有@NonNull注解的字段），以及全参数的构造函数。

复制代码

import lombok.*;

@NoArgsConstructor
@RequiredArgsConstructor
@AllArgsConstructor
public class User {
    @NonNull private String name;
    private int age;
}

@Data

@Data注解是一个方便的快捷方式，它结合了@Getter、@Setter、@ToString、@EqualsAndHashCode和@RequiredArgsConstructor的功能。

复制代码

import lombok.Data;

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

@Builder

@Builder注解可以让你使用建造者模式来创建对象实例。

复制代码

import lombok.Builder;
import lombok.Getter;
import lombok.Setter;

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

// 使用建造者模式创建User对象
User user = User.builder()
                .name("John Doe")
                .age(30)
                .build();

@SneakyThrows

@SneakyThrows注解可以让你在不声明异常的情况下抛出检查时异常（checked exception）。

复制代码

import lombok.SneakyThrows;

public class Example {
    @SneakyThrows
    public void readFile(String path) {
        // 这里抛出的IOException不需要在方法签名中声明
        Files.readAllLines(Paths.get(path));
    }
}

@NonNull

@NonNull注解可以自动帮你生成字段检查null值的代码。

复制代码

import lombok.NonNull;

public class User {
    private String name;
    private int age;
    
    public User(@NonNull String name, int age) {
        if (name == null) {
            throw new NullPointerException("name is marked non-null but is null");
        }
        this.name = name;
        this.age = age;
    }
}

@Value

@Value注解生成一个不可变的类，相当于@Data的不可变版本，它会将所有字段设置为私有并且只有getter方法，不会有setter。

复制代码

import lombok.Value;

@Value
public class User {
    String name;
    int age;
}

@Cleanup

@Cleanup注解可以自动管理资源，例如自动关闭文件流。

复制代码

import lombok.Cleanup;

public class Example {
    @SneakyThrows
    public void readFile(String path) {
        @Cleanup InputStream in = new FileInputStream(path);
        // do something with the stream
    }
}

@Log

Lombok提供了多种日志相关的注解，例如@Log、@Slf4j、@Log4j等，用于自动创建日志对象。

复制代码

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class LogExample {
    public static void main(String... args) {
        log.error("Something's wrong here");
    }
}

结论

Lombok是一个强大的工具，可以显著减少Java开发中的模板代码。通过本文的介绍，你应该对Lombok的各种注解有了一个清晰的了解，并且可以开始在你的项目中使用它们了。

记住，虽然Lombok可以让代码变得更加简洁，但是在一些情况下，过度使用Lombok可能会使得代码的可读性降低。因此，合理地使用Lombok，让它成为你提升开发效率的得力助手！

👉 💐🌸 公众号请关注 "果酱桑", 一起学习,一起进步! 🌸💐