SpringBoot 项目中 Lombok 的使用

介绍

Lombok是一个Java库，通过在编译时期自动生成样板代码来简化Java开发。在SpringBoot项目中，Lombok能帮助我们减少冗余代码，提高开发效率。本篇博客将介绍如何在SpringBoot项目中使用Lombok。

安装Lombok

要在SpringBoot项目中使用Lombok，需要在项目的构建工具中添加Lombok依赖。如果使用Maven，可以在pom.xml文件中添加以下依赖：

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

如果使用Gradle，可以在build.gradle文件中添加以下依赖：

implementation 'org.projectlombok:lombok'

如何使用Lombok

@Getter和@Setter

使用@Getter和@Setter注解可以自动为类的成员变量生成getter和setter方法。

import lombok.Getter;
import lombok.Setter;

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

上述代码等同于手动编写以下getter和setter方法：

public class User {
    private String name;
    private int age;
    
    public String getName() {
        return name;
    }
    
    public void setName(String name) {
        this.name = name;
    }
    
    public int getAge() {
        return age;
    }
    
    public void setAge(int age) {
        this.age = age;
    }
}

@ToString

使用@ToString注解可以自动生成toString方法。

import lombok.ToString;

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

上述代码等同于手动编写以下toString方法：

public class User {
    private String name;
    private int age;
    
    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

@NoArgsConstructor和@AllArgsConstructor

使用@NoArgsConstructor注解可以生成无参构造方法，使用@AllArgsConstructor注解可以生成包含所有参数的构造方法。

import lombok.NoArgsConstructor;
import lombok.AllArgsConstructor;

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

上述代码等同于手动编写以下构造方法：

public class User {
    private String name;
    private int age;
    
    public User() {
    }
    
    public User(String name, int age) {
        this.name = name;
        this.age = age;
    }
}

总结

Lombok可以大大减少SpringBoot项目中的样板代码，让开发变得更加简单和高效。通过使用@Getter和@Setter注解可以自动生成getter和setter方法，使用@ToString注解可以自动生成toString方法，使用@NoArgsConstructor和@AllArgsConstructor注解可以自动生成构造方法。这些注解能够提高代码的可读性，减少开发时间。因此，在SpringBoot项目中，我们应该充分利用Lombok来优化代码的编写。

本文来自极简博客，作者：清风徐来，转载请注明原文链接：SpringBoot 项目中 Lombok 的使用