springboot @RequiredArgsConstructor的概念與使用方式

更新時間：2024年09月04日 15:55:33 作者：小馬哥學JAVA

這篇文章主要介紹了springboot @RequiredArgsConstructor的概念與使用方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

概念

@RequiredArgsConstructor會生成一個構造函數(shù)，這個構造函數(shù)只包括最終（final）字段和標記為@NonNull的字段作為參數(shù)。

如果所有字段都是非final且沒有標記@NonNull，那么這個構造函數(shù)會是一個空構造函數(shù)。

優(yōu)點

1. 簡化構造函數(shù)的編寫

使用@RequiredArgsConstructor可以自動生成一個構造函數(shù)，這個構造函數(shù)會包含類中所有標記為final或@NonNull的成員變量。

這省去了手動編寫這些構造函數(shù)的需要，減少了代碼量，使代碼更加簡潔。

2. 強制依賴注入

通過生成的構造函數(shù)，可以實現(xiàn)依賴的自動注入。

這對于Spring框架中的依賴注入尤為重要，特別是推薦的構造器注入方式，可以確保依賴的不可變性和非空性。

這種注入方式比字段注入更為安全，因為它防止了在類完全構造之前使用部分構造的對象。

3. 支持不變性

對于被標記為final的字段，一旦它們通過構造函數(shù)被賦值后，就不能被更改。

這種不變性有助于創(chuàng)建更穩(wěn)定、可預測的代碼，尤其是在多線程環(huán)境中，不變對象天然地是線程安全的。

4. 清晰的依賴關系

自動生成的構造函數(shù)明確要求必須提供所有必需的依賴，這使得開發(fā)者在使用類的時候更加清晰地了解到哪些依賴是必須的，有助于提高代碼的可讀性和可維護性。

使用示例

假設你有一個服務類，需要依賴于其他幾個組件。以下是一個使用@RequiredArgsConstructor的例子：

首先，確保你的項目已經(jīng)包括了Lombok依賴：

<!-- 在pom.xml中添加Lombok依賴 -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>最新版本</version>
    <scope>provided</scope>
</dependency>

使用@RequiredArgsConstructor創(chuàng)建類：

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

@Service
@RequiredArgsConstructor
public class UserService {

    private final UserRepository userRepository;
    private final MailService mailService;

    // 業(yè)務方法
    public void registerUser(User user) {
        userRepository.save(user);
        mailService.sendRegistrationEmail(user);
    }
}

在這個例子中，UserService類需要UserRepository和MailService這兩個組件。

通過@RequiredArgsConstructor自動生成的構造函數(shù)，Spring將在創(chuàng)建UserService實例時自動注入這兩個依賴。