使用 Project Lombok 增强 Java：简化您的代码，提高您的工作效率-java教程-PHP中文网

使用 Project Lombok 增强 Java：简化您的代码，提高您的工作效率

花韻仙語

发布： 2024-11-01 19:56:11

转载

385人浏览过

使用 project lombok 增强 java：简化您的代码，提高您的工作效率

java 以其冗长而闻名，尤其是在处理重复的样板代码（如 getter、setter、构造函数和 tostring 方法）时。虽然有必要，但这种混乱会减慢开发速度，并使代码更难以阅读和维护。 lombok 项目通过在编译时自动生成样板代码来解决这个问题。

在本指南中，我们将深入探讨为什么 lombok 是 java 中的必备工具、如何设置它，并深入幕后了解 lombok 如何使用注释处理来映射和修改 java 的抽象语法树（ast），确保我们的代码简洁而不牺牲功能。

为什么我们需要龙目岛？

java 需要大量的样板代码。考虑一个简单的 pojo，其中包括字段、构造函数、getter、setter 和 tostring 方法：

public class user {
    private string name;
    private int age;

    public user(string name, int age) {
        this.name = name;
        this.age = 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;
    }

    @override
    public string tostring() {
        return "user{name='" + name + "', age=" + age + '}';
    }
}

登录后复制

这对于小型项目来说是可以管理的，但随着应用程序规模的扩大，样板文件很快就会变得不堪重负。

解决方案：龙目岛

立即学习“Java免费学习笔记（深入）”；

使用 lombok，我们可以避免所有这些重复的代码。这是同一个类在 lombok 中的样子：

import lombok.data;

@data
public class user {
    private string name;
    private int age;
}

登录后复制

只需一个注解，lombok 就可以生成 getter、setter、tostring、equals 和 hashcode 方法，使代码更干净、更易于维护。

如何设置龙目岛

第1步：添加lombok依赖

要在 maven 项目中使用 lombok，请将此依赖项添加到 pom.xml：

<dependency>
    <groupid>org.projectlombok</groupid>
    <artifactid>lombok</artifactid>
    <version>1.18.28</version>
    <scope>provided</scope>
</dependency>

登录后复制

对于 gradle：

compileonly 'org.projectlombok:lombok:1.18.28'
annotationprocessor 'org.projectlombok:lombok:1.18.28'

登录后复制

第 2 步：ide 设置

确保您的 ide 已安装 lombok 插件。在 intellij idea 中：

1.  go to settings > plugins.
2.  search for lombok.
3.  install the lombok plugin.
4.  enable annotation processing under settings > build, execution, deployment > compiler > annotation processors.

登录后复制

lombok 的工作原理：幕后花絮

注释处理的力量

lombok 使用 java 注释处理器与 java 抽象语法树 (ast) 进行交互。注释处理器在编译过程中分析并可能修改代码的结构。 lombok 的注释处理器利用它来生成 getter、setter 和 tostring 等方法，在代码编译之前将它们直接插入到 ast 中。

理解抽象语法树 (ast)

ast 是代码的内部表示，将源代码分解为编译器可以处理的结构化树。当您编写 java 代码时，每个元素（如类、字段、方法）都会映射到 ast 中的一个节点。

当lombok的注释处理器遇到带有lombok注释的类时，它会修改ast节点以将方法直接添加到树中。这意味着样板方法是在编译期间生成的，而不是源代码的一部分。当代码编译时，它已经添加了所有必要的方法，这就是它们无缝工作的原因。

时机：lombok 何时以及如何生成代码

lombok 的注释在编译阶段（解析 java 源代码和生成字节码之间）进行处理。以下是分步过程：

LuckyCola工具库

LuckyCola工具库是您工作学习的智能助手，提供一系列AI驱动的工具，旨在为您的生活带来便利与高效。

查看详情

1.  ast creation: the compiler reads the java source code and generates the ast.
2.  annotation processing: lombok’s annotation processor scans the ast for lombok annotations.
3.  ast manipulation: when an annotation like @getter or @setter is found, lombok adds nodes to the ast to represent the corresponding methods.
4.  bytecode generation: the modified ast is used to generate the final bytecode, which includes the methods added by lombok.

登录后复制

因此，当您运行代码时，getter、setter 和其他方法看起来就像是原始源代码的一部分，即使它们是在编译时添加的。

lombok 注解解释

@getter 和 @setter

这些注释会为您的字段生成 getter 和 setter 方法，有效地节省您自己编写它们的精力。

import lombok.getter;
import lombok.setter;

@getter
@setter
public class user {
    private string name;
    private int age;
}

登录后复制

@tostring

@tostring 生成一个 tostring 方法，默认包含所有字段，并且可以选择排除特定字段。

import lombok.tostring;

@tostring(exclude = „password“)
public class user {
    private string name;
    private int age;
    private string password;
}

登录后复制

@equalsandhashcode

生成 equals 和 hashcode 方法。这些方法对于比较对象以及在 hashmap 或 hashset 等集合中使用它们至关重要。

import lombok.equalsandhashcode;

@equalsandhashcode
public class user {
    private string name;
    private int age;
}

登录后复制

@noargsconstructor、@allargsconstructor 和 @requiredargsconstructor

这些注释生成具有不同参数选项的构造函数。

• @noargsconstructor: no-argument constructor.
• @allargsconstructor: constructor with parameters for all fields.
• @requiredargsconstructor: constructor for fields marked final or @nonnull.

登录后复制

import lombok.noargsconstructor;
import lombok.allargsconstructor;
import lombok.requiredargsconstructor;

@noargsconstructor
@allargsconstructor
@requiredargsconstructor
public class user {
    private final string name;
    private int age;
}

登录后复制

@数据

组合@getter、@setter、@tostring、@equalsandhashcode 和@requiredargsconstructor。

import lombok.data;

@data
public class user {
    private string name;
    private int age;
}

登录后复制

@builder

实现构建器模式，这对于构造具有多个参数的复杂对象特别有用。

import lombok.builder;

@builder
public class user {
    private string name;
    private int age;
}

登录后复制

用法：

user user = user.builder()
    .name("john doe")
    .age(30)
    .build();

登录后复制

@slf4j（日志记录）

提供 slf4j logger 实例，简化日志记录设置。

import lombok.extern.slf4j.slf4j;

@slf4j
public class userservice {

    public void createuser() {
        log.info("user is being created");
    }
}

登录后复制

spring boot 应用程序中的 lombok

lombok 的功能在 spring boot 应用程序中特别有用，在这些应用程序中，样板代码可以轻松地累积在服务、存储库和模型中。以下是在 spring boot 服务中使用 lombok 的示例：

import lombok.requiredargsconstructor;
import lombok.extern.slf4j.slf4j;
import org.springframework.stereotype.service;

@slf4j
@service
@requiredargsconstructor
public class userservice {

    private final userrepository userrepository;

    public void saveuser(user user) {
        log.info("saving user: {}", user);
        userrepository.save(user);
    }
}

登录后复制

在此示例中：

• @RequiredArgsConstructor generates a constructor for userRepository, which Spring Boot uses for dependency injection.<br>
• @Slf4j adds a logger, so we don’t need to manually define a logging instance.<br>

登录后复制