java 中 Lombok 的注解怎么用

Lombok是一个Java库，它通过注解的方式自动化地生成常见的代码，比如getters、setters、equals、hashCode和toString方法等，简化代码、提高开发效率、减少模板代码的编写。Lombok最常用的几个注解包括但不限于@Data、@Getter/@Setter、@NoArgsConstructor、@AllArgsConstructor、@Builder等。以@Data注解为例，它集成了@Getter、@Setter、@ToString、@EqualsAndHashCode的功能。当在类上使用@Data注解时，无需手动编写getter和setter方法等，Lombok会在编译期间自动生成这些方法，大大减少了样板代码。

一、@DATA

@Data是Lombok的核心注解之一，使用在类上可以自动生成setter/getter方法、equals方法、hashCode方法以及toString方法。使用@Data可以有效减少冗余代码，使类更加清晰。

类定义使用@Data

import lombok.Data;

@Data
public class User {
    private Integer id;
    private String name;
    private String emAIl;
}

在这个User类中，我们不需要编写任何的getter和setter方法，Lombok会在编译的时候自动生成这些方法。

自动生成的方法

public Integer getId() {

    return this.id;
}
public void setId(Integer id) {
    this.id = id;
}
// 以及其他的getter和setter、equals、hashCode和toString方法...

二、@GETTER/@SETTER

当我们只需要为类中的特定字段生成getter和setter方法时，可以使用@Getter和@Setter注解。这为我们提供了属性级别的控制。

属性上使用@Getter/@Setter

import lombok.Getter;

import lombok.Setter;
public class User {
    @Getter @Setter private Integer id;
    @Getter @Setter private String name;
    private String password; // 这里我们有意省略getter和setter
}

这样，只有id和name字段会生成相应的getter和setter方法。

三、@NoArgsConstructor、@AllArgsConstructor、@RequiredArgsConstructor

@NoArgsConstructor生成无参构造器，@AllArgsConstructor生成包含所有属性的构造器，@RequiredArgsConstructor生成包含final和@NonNull注解的成员变量的构造器。这三个注解方便我们快速生成构造方法。

构造方法注解使用示例

import lombok.NoArgsConstructor;

import lombok.AllArgsConstructor;
import lombok.RequiredArgsConstructor;
import lombok.NonNull;
@NoArgsConstructor
@AllArgsConstructor
@RequiredArgsConstructor
public class User {
    private Integer id;
    private String name;
    @NonNull private String email;
}

四、@BUILDER

Lombok的@Builder可以让我们采用建造者模式来创建对象。建造者模式是一种创建复杂对象的软件设计模式，它能够将一个复杂对象的构建与它的表示分离。

类定义中使用@Builder

import lombok.Builder;

@Builder
public class User {
    private Integer id;
    private String name;
    private String email;
}

使用@Builder之后，可以采用链式调用的方式创建User对象：

User user = User.builder()

                .id(1)
                .name("John Doe")
                .email("john.doe@example.com")
                .build();

五、@SLF4J

在需要记录日志的类上添加@Slf4j注解，可以直接使用log对象进行日志的记录，减少了手动创建日志对象的需要。

添加日志记录功能

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class User {
    // 类的内容...
    public void someMethod() {
        log.debug("Some debug message");
        // 其他逻辑...
    }
}

六、@SNEAKYTHROWS

@SneakyThrows可以将受检异常（checked exception）转换为不检查异常（unchecked exception）。使用这个注解，可以避免使用try-catch块，使代码更加简洁，但也可能隐藏潜在的异常处理问题。

异常处理简化

import lombok.SneakyThrows;

import java.io.UnsupportedEncodingException;
public class User {
    @SneakyThrows(UnsupportedEncodingException.class)
    public String encodeName(String name) {
        return java.net.URLEncoder.encode(name, "UTF-8");
    }
}

以上便是Java中Lombok库使用注解的基本方法。使用Lombok可以极大减少Java开发中的模板代码，提升开发速度和效率，但它也有一些缺点，比如可能会隐藏一些复杂的逻辑、让代码的可读性变差等。因此，开发者需要在考虑代码简洁性和可维护性之间做出平衡选择。

相关问答FAQs：

问题1：Lombok中的注解有哪些常用的？如何使用它们实现代码简洁化？

Lombok中有许多常用的注解，例如@Data、@Getter、@Setter、@ToString等。可以通过在类上添加这些注解，实现自动生成相关的getter、setter方法、toString方法等，从而减少了手动编写这些重复代码的工作量，提高了代码的可读性和开发效率。

问题2：Lombok中的注解如何帮助我们实现不可变对象（Immutable）？

通过使用Lombok中的注解，我们可以轻松地实现不可变对象。例如，通过添加@AllArgsConstructor和@Accessors(chain = true)注解，我们可以在生成构造函数和链式调用的同时，将类的所有属性设置为final修饰符，确保对象实例创建后不被修改，从而实现不可变性。

问题3：如何在Spring Boot项目中正确使用Lombok注解？

在Spring Boot项目中使用Lombok注解非常简单。首先，在项目的pom.xml文件中添加Lombok的依赖。然后，在需要使用Lombok注解的Java类上添加对应的注解，如@Data、@NoArgsConstructor等。在编译和运行项目时，Lombok会自动生成相关的代码，无需额外的配置或手动编写代码。这样，我们就能够轻松地实现更简洁、更易读的代码编写和维护。

最后建议，企业在引入信息化系统初期，切记要合理有效地运用好工具，这样一来不仅可以让公司业务高效地运行，还能最大程度保证团队目标的达成。同时还能大幅缩短系统开发和部署的时间成本。特别是有特定需求功能需要定制化的企业，可以采用我们公司自研的企业级低代码平台：织信Informat。 织信平台基于数据模型优先的设计理念，提供大量标准化的组件，内置AI助手、组件设计器、自动化（图形化编程）、脚本、工作流引擎（BPMN2.0）、自定义API、表单设计器、权限、仪表盘等功能，能帮助企业构建高度复杂核心的数字化系统。如ERP、MES、CRM、PLM、SCM、WMS、项目管理、流程管理等多个应用场景，全面助力企业落地国产化/信息化/数字化转型战略目标。