Spring Boot 基于构造函数的依赖注入（Constructor-based Dependency Injection）配合 Lombok @RequiredArgsConstructor

基于构造函数的依赖注入 + @RequiredArgsConstructor

Spring Boot 使用 基于构造函数的依赖注入（Constructor-based Dependency Injection）配合 Lombok @RequiredArgsConstructor，是不是很合适？

是的，Spring Boot 结合使用 基于构造函数的依赖注入（Constructor-based Dependency Injection）和 Lombok 的 @RequiredArgsConstructor 是一个非常高效且优雅的组合。这种方式可以带来以下好处：

1. 代码简洁：

   • Lombok 的 @RequiredArgsConstructor 注解会自动为类生成一个构造函数，该构造函数包含所有被 final 修饰的字段以及用 @NonNull 标注的非 final 字段。这样，你不需要手动编写构造函数，代码变得更加简洁。

2. 依赖明确：

   • 构造函数注入确保了所有依赖项在类实例化时就被注入，这有助于避免 NullPointerException，并使依赖关系在代码中清晰可见。

3. 可维护性：

   • 明确的依赖关系使得代码更容易理解和维护，也方便进行重构。

4. 与 Spring Boot 的良好集成：

   • Spring Boot 本身就鼓励使用构造函数注入，因为它可以提供更安全的依赖注入机制，同时与 Lombok 结合使用可以进一步简化代码。

要使用 @RequiredArgsConstructor，你需要在你的类上添加这个注解，并确保你的项目已经包含了 Lombok 依赖。

总的来说，@RequiredArgsConstructor 和构造函数注入是一个很好的实践，尤其适合于那些需要在初始化时就具有特定依赖的类。

示例

示例代码

下面示例代码中，IocService iocService 是通过构造函数注入的，并且使用 @RequiredArgsConstructor 自动为类生成构造器。

package com.example.web.ioc.controller;

import com.example.web.ioc.service.IocService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * 基于构造函数的依赖注入，并且使用 @RequiredArgsConstructor 注解自动生成构造函数。
 */
@Tag(name = "构造函数-依赖注入")
@RestController
@RequestMapping("/ioc")
@RequiredArgsConstructor
public class IocController {

    private final IocService iocService;

    @GetMapping("/message")
    @Operation(summary = "查询消息")
    public String getMessage() {
        return iocService.getMessage();
    }

}

package com.example.web.ioc.service;

import org.springframework.stereotype.Service;

@Service
public class IocService {

    public String getMessage() {
        return "Hello World!";
    }

}

注入效果

依赖能够正常注入，应用启动正常，接口访问也正常。

• 启动正常

• 接口访问正常

Lombok：@RequiredArgsConstructor

@RequiredArgsConstructor 是 Lombok 库中的一个注解，它用于自动生成一个构造器，该构造器包含类中所有被 final 修饰的字段或所有没有默认值的 @NonNull 注解的字段。这个注解对于确保不可变对象（即其状态在创建后不能改变的对象）的正确初始化非常有用。

当在一个类上使用 @RequiredArgsConstructor，Lombok 将会生成一个构造函数，该构造函数接收所有被标记为必需的字段作为参数，并将这些参数赋给相应的字段。如果某个字段是 final 类型，或者被标注了 @NonNull，那么它就会被认为是必需的，必须通过构造函数传入。

这里是一个简单的示例：

import lombok.RequiredArgsConstructor;

@RequiredArgsConstructor
public class Example {
    private final String name;
    private final int age;
    
    // Lombok 自动生成的构造函数如下：
    public Example(String name, int age) {
        this.name = name;
        this.age = age;
    }
}

在这个例子中，Example 类有两个 final 字段 name 和 age。由于它们都是 final 的，所以 @RequiredArgsConstructor 注解会自动生成一个构造函数，要求调用者在创建 Example 对象时必须提供这两个参数。

注意，如果你的类中有一些 final 字段但不希望它们包含在构造函数中，你可以使用 @NoArgsConstructor 或者 @AllArgsConstructor 注解，或者手动定义构造函数。

基于构造器还是基于设置器的DI

Constructor-based or setter-based DI?

官方推荐：

The Spring team generally advocates constructor injection, as it lets you implement application components as immutable objects and ensures that required dependencies are not null. Furthermore, constructor-injected components are always returned to the client (calling) code in a fully initialized state. As a side note, a large number of constructor arguments is a bad code smell, implying that the class likely has too many responsibilities and should be refactored to better address proper separation of concerns.

Spring团队通常提倡构造函数注入，因为它允许您将应用程序组件实现为不可变对象，并确保所需的依赖关系不是 null 。此外，构造函数注入的组件总是以完全初始化的状态返回给客户端（调用）代码。顺便说一下，大量的构造函数参数是一种糟糕的代码气味，这意味着类可能有太多的责任，应该重构以更好地解决关注点的适当分离。

Spring官方文档：依赖注入

Dependency Injection