Spring Boot 中的三种依赖注入方式及推荐使用

HaYiBoy

于 2025-01-17 19:04:49 发布

阅读量2.6k

点赞数 60

分类专栏： Java知识网络文章标签： java springboot spring

本文链接：https://blog.csdn.net/weixin_42611375/article/details/145148597

版权

Java知识网络专栏收录该内容

5 篇文章

订阅专栏

在Spring Boot中，依赖注入（Dependency Injection, DI）是核心功能之一，它允许我们将组件之间的依赖关系外部化，从而提高代码的可测试性和可维护性。Spring Boot提供了三种主要的依赖注入方式：字段注入（Field Injection）、构造器注入（Constructor Injection）和方法注入（Setter Injection）。每种方式都有其优缺点，适用于不同的场景。本文将详细介绍这三种注入方式，并给出推荐使用的建议。

1. 字段注入（Field Injection）

代码示例

@Service
public class MyService {

    @Autowired
    private MyDependency myDependency;

    // 其他方法
}

优点

简洁：代码简洁，直接在字段上使用@Autowired注解，无需编写额外的构造器或方法。

缺点

不可变性：依赖项可以被外部修改，导致对象状态不一致。
测试困难：单元测试时，需要使用反射来注入依赖项，增加了测试的复杂性。
强制性不明确：无法明确哪些依赖项是必需的，哪些是可选的。

2. 构造器注入（Constructor Injection）

代码示例

@Service
public class MyService {

    private final MyDependency myDependency;

    @Autowired
    public MyService(MyDependency myDependency) {
        this.myDependency = myDependency;
    }

    // 其他方法
}

优点

不可变性：依赖项在对象创建时被初始化，并且是不可变的，提高了代码的线程安全性和可预测性。
强制性明确：构造器参数明确表示哪些依赖项是必需的，否则对象无法被创建。
易于测试：单元测试时，可以直接通过构造器传递依赖项的模拟对象（Mock Objects），简化了测试过程。

缺点

代码稍显冗余：需要编写构造器和字段赋值语句，代码量稍多。

构造器注入 + Lombok

Lombok是一个用于简化Java代码的工具库，能帮助减少大量的样板代码。@RequiredArgsConstructor是Lombok提供的一个注解，它自动为所有final修饰的字段生成构造器，特别适合与构造器注入结合使用。

代码示例
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {
    private final MapFeignClient mapFeignClient;
    private final FeeRuleFeignClient feeRuleFeignClient;
    private final OrderInfoFeignClient orderInfoFeignClient;
    private final NewOrderFeignClient newOrderFeignClient;
    private final DriverInfoFeignClient driverInfoFeignClient;
}
**@RequiredArgsConstructor**注解自动生成包含所有final字段的构造器，避免手动编写构造方法。

每个依赖通过构造器注入，且被声明为final，这不仅简化了代码，还增强了类的不可变性，确保在对象生命周期中依赖不会被修改。

3. 方法注入（Setter Injection）

代码示例

@Service
public class MyService {

    private MyDependency myDependency;

    @Autowired
    public void setMyDependency(MyDependency myDependency) {
        this.myDependency = myDependency;
    }

    // 其他方法
}

优点

灵活性：可以在对象创建后动态修改依赖项，适用于一些特殊场景。
兼容性：与传统的JavaBean规范兼容，适用于一些需要动态配置的场景。

缺点

不可变性：依赖项可以被外部修改，导致对象状态不一致。
测试困难：单元测试时，需要调用setter方法来注入依赖项，增加了测试的复杂性。
强制性不明确：无法明确哪些依赖项是必需的，哪些是可选的。

小结

通过合理选择依赖注入方式，可以提高代码的质量和可维护性。推荐使用构造器注入，因为它提供了不可变性和明确的强制性，使代码更健壮、更易于测试和维护。方法注入在需要动态修改依赖项的特殊场景下非常有用，但应谨慎使用。字段注入虽然代码简洁，但存在不可变性和测试困难的问题，应尽量避免在生产环境中使用。结合Lombok的@RequiredArgsConstructor注解，可以进一步简化构造器注入的代码，提高开发效率。

下面我们将从定义、使用方式、依赖项的不可变性、线程安全性、测试便利性等方面，详细对比字段注入、构造器注入和方法注入这三种Spring Boot中的依赖注入方式。

1. 定义和使用方式

字段注入（Field Injection）

定义：通过在字段上直接使用@Autowired注解来注入依赖。

代码示例：

@Service
public class MyService {
    @Autowired
    private MyDependency myDependency;
}

使用方式：直接在字段上标注@Autowired，Spring会在对象创建后自动注入依赖。

构造器注入（Constructor Injection）

定义：通过在构造器上使用@Autowired注解，并将依赖项作为构造器参数来注入依赖。

代码示例：

@Service
public class MyService {
    private final MyDependency myDependency;

    @Autowired
    public MyService(MyDependency myDependency) {
        this.myDependency = myDependency;
    }
}

使用方式：在构造器上标注@Autowired，并通过构造器参数传递依赖项。依赖项通常被声明为final，表示不可变。

方法注入（Setter Injection）

定义：通过在setter方法上使用@Autowired注解来注入依赖。

代码示例：

@Service
public class MyService {
    private MyDependency myDependency;

    @Autowired
    public void setMyDependency(MyDependency myDependency) {
        this.myDependency = myDependency;
    }
}

使用方式：在setter方法上标注@Autowired，通过调用setter方法来注入依赖。

2. 依赖项的不可变性

字段注入

不可变性：依赖项可以被外部修改。因为字段没有被声明为final，外部代码可以通过反射等方式修改字段的值。

示例：

MyService myService = new MyService();
Field field = MyService.class.getDeclaredField("myDependency");
field.setAccessible(true);
field.set(myService, new MyDependency());

构造器注入

不可变性：依赖项不可被外部修改。依赖项通常被声明为final，在对象创建时通过构造器初始化，之后无法被修改。

示例：

@Service
public class MyService {
    private final MyDependency myDependency;

    @Autowired
    public MyService(MyDependency myDependency) {
        this.myDependency = myDependency;
    }
}

由于myDependency是final的，无法通过外部代码修改其值。

方法注入

不可变性：依赖项可以被外部修改。因为提供了setter方法，外部代码可以随时调用setter方法来修改依赖项的值。

示例：

MyService myService = new MyService();
myService.setMyDependency(new MyDependency());

3. 线程安全性

字段注入

线程安全性：由于依赖项可以被外部修改，存在线程安全问题。多个线程同时修改依赖项时，可能会引发竞态条件等问题。

示例：

// 线程1
myService.setMyDependency(new MyDependency1());

// 线程2
myService.setMyDependency(new MyDependency2());

构造器注入

线程安全性：由于依赖项是不可变的，不存在线程安全问题。多个线程可以安全地访问MyService对象，而不用担心依赖项的值会被其他线程修改。

示例：

@Service
public class MyService {
    private final MyDependency myDependency;

    @Autowired
    public MyService(MyDependency myDependency) {
        this.myDependency = myDependency;
    }
}

由于myDependency是final的，多个线程访问MyService对象时，myDependency的值不会改变。

方法注入

线程安全性：由于依赖项可以被外部修改，存在线程安全问题。多个线程同时修改依赖项时，可能会引发竞态条件等问题。

示例：

// 线程1
myService.setMyDependency(new MyDependency1());

// 线程2
myService.setMyDependency(new MyDependency2());

4. 测试便利性

字段注入

测试便利性：单元测试时，需要使用反射来注入依赖项，增加了测试的复杂性。

示例：

MyService myService = new MyService();
Field field = MyService.class.getDeclaredField("myDependency");
field.setAccessible(true);
field.set(myService, mock(MyDependency.class));

构造器注入

测试便利性：单元测试时，可以直接通过构造器传递依赖项的模拟对象（Mock Objects），简化了测试过程。

示例：

MyService myService = new MyService(mock(MyDependency.class));

方法注入

测试便利性：单元测试时，需要调用setter方法来注入依赖项，增加了测试的复杂性。

示例：

MyService myService = new MyService();
myService.setMyDependency(mock(MyDependency.class));

5. 适用场景

字段注入

适用场景：适用于一些简单的、不需要严格测试的项目。但在生产环境中应尽量避免使用，因为它存在不可变性和测试困难的问题。

构造器注入

适用场景：适用于大多数需要依赖注入的场景，特别是那些依赖项是必需的场景。构造器注入提供了不可变性和明确的强制性，使代码更健壮、更易于测试和维护。

方法注入

适用场景：适用于需要在对象创建后动态修改依赖项的场景。例如，某些配置类需要在运行时动态更新配置信息。但应尽量避免在普通业务逻辑中使用，因为它存在不可变性和测试困难的问题。

总结

字段注入：虽然代码简洁，但存在不可变性和测试困难的问题，容易导致潜在的错误。在生产环境中应尽量避免使用。
构造器注入：提供了不可变性和明确的强制性，使代码更健壮、更易于测试和维护。推荐在大多数需要依赖注入的场景中使用。
方法注入：适用于需要在对象创建后动态修改依赖项的特殊场景，但应谨慎使用，因为它存在不可变性和测试困难的问题。

通过合理选择依赖注入方式，可以提高代码的质量和可维护性。构造器注入通常是最佳选择，因为它提供了不可变性和明确的强制性，使代码更健壮、更易于测试和维护。结合Lombok的@RequiredArgsConstructor注解，可以进一步简化构造器注入的代码，提高开发效率。