SpringBoot @RequiredArgsConstructor的概念与使用

2024 年 10 月 07 日

61 次浏览

1677字数

在Spring Boot中，`@RequiredArgsConstructor`注解是Lombok库提供的功能，用于自动生成包含必需参数的构造函数。"必需参数"指的是那些被声明为`final`或者有`@NonNull`注解的成员变量。这种注解极大地简化了Java类的编写，尤其是在需要注入依赖或常量值时。

# 概念

`@RequiredArgsConstructor`会生成一个构造函数，这个构造函数只包括最终（final）字段和标记为@NonNull的字段作为参数。如果所有字段都是非final且没有标记@NonNull，那么这个构造函数会是一个空构造函数。

# 优点

1. **简化构造函数的编写**
   使用`@RequiredArgsConstructor`可以自动生成一个构造函数，这个构造函数会包含类中所有标记为`final`或`@NonNull`的成员变量。这省去了手动编写这些构造函数的需要，减少了代码量，使代码更加简洁。
2. **强制依赖注入**
   通过生成的构造函数，可以实现依赖的自动注入。这对于Spring框架中的依赖注入尤为重要，特别是推荐的构造器注入方式，可以确保依赖的不可变性和非空性。这种注入方式比字段注入更为安全，因为它防止了在类完全构造之前使用部分构造的对象。
3. **支持不变性**
   对于被标记为`final`的字段，一旦它们通过构造函数被赋值后，就不能被更改。这种不变性有助于创建更稳定、可预测的代码，尤其是在多线程环境中，不变对象天然地是线程安全的。
4. **清晰的依赖关系**
   自动生成的构造函数明确要求必须提供所有必需的依赖，这使得开发者在使用类的时候更加清晰地了解到哪些依赖是必须的，有助于提高代码的可读性和可维护性。

# 使用示例

假设你有一个服务类，需要依赖于其他几个组件。以下是一个使用`@RequiredArgsConstructor`的例子：

1、首先，确保你的项目已经包括了Lombok依赖：

```java

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

2、使用`@RequiredArgsConstructor`创建类：

```java
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;

@Service
@RequiredArgsConstructor
public class UserService {

private final UserRepository userRepository;
    private final MailService mailService;

// 业务方法
    public void registerUser(User user) {
        userRepository.save(user);
        mailService.sendRegistrationEmail(user);
    }
}
```

在这个例子中，`UserService`类需要`UserRepository`和`MailService`这两个组件。通过`@RequiredArgsConstructor`自动生成的构造函数，Spring将在创建`UserService`实例时自动注入这两个依赖。

# 小提示

使用`@RequiredArgsConstructor`可以使代码更加简洁且易于维护，但需要注意的是，它依赖于Lombok工具，因此确保IDE支持Lombok插件，以便正确识别和处理相关注解。这样的自动化功能可以显著减少样板代码，提高开发效率。

最后修改：2024 年 10 月 07 日