SpringBoot 构造器注入、Setter方法注入和Field注入对比

  • Z时代
  • 2024-01-10
  • 分类：游戏

本文内容纲要：

- 0. 引入
- 1. 常见的三种注解注入方式对比
- Field 注入
- Setter 方法注入
- Constructor 注入
- 2. 构造器注入还是 Setter 注入？

0. 引入

今天在看项目代码的时候发现在依赖注入的时候使用了构造器注入，之前使用过 Field 注入和 Setter 方法注入，对构造器注入不是很了解。经过查阅资料看到，Spring 推荐使用构造器注入的方式，下面介绍构造器注入到底有什么玄机。

1. 常见的三种注解注入方式对比

Field 注入

@Controller
public class HelloController {
    @Autowired
    private AlphaService alphaService;
    @Autowired
    private BetaService betaService;
}

field 注入方式是使用最多的，原因是这种方式使用起来非常简单，代码更加简洁。

Setter 方法注入

@Controller
public class HelloController {
    private AlphaService alphaService;
    private BetaService betaService;
    @Autowired
    public void setAlphaService(AlphaService alphaService) {
        this.alphaService = alphaService;
    }
    @Autowired
    public void setBetaService(BetaService betaService) {
        this.betaService = betaService;
    }
}

在 Spring 3.x 刚推出的时候，Spring 官方在对比构造器注入和 Setter 注入时，推荐使用 Setter 方法注入：

Spring 3.x Constructor-based or setter-based DI?

The Spring team generally advocates setter injection, because large numbers of constructor arguments can get unwieldy, especially when properties are optional. Setter methods also make objects of that class amenable to reconfiguration or re-injection later. Management through JMX MBeans is a compelling use case.

Some purists favor constructor-based injection. Supplying all object dependencies means that the object is always returned to client (calling) code in a totally initialized state. The disadvantage is that the object becomes less amenable to reconfiguration and re-injection.

意思是说，当出现很多注入项的时候，构造器参数可能会变得臃肿，特别是当参数时可选的时候。Setter 方式注入可以让类在之后重新配置和重新注入；

Constructor 注入

@Controller
public class HelloController {
    private final AlphaService alphaService;
    private final BetaService betaService;
    @Autowired
    public HelloController(AlphaService alphaService, BetaService betaService) {
        this.alphaService = alphaService;
        this.betaService = betaService;
    }
}

Spring 4.x 的时候，Spring 官方在对比构造器注入和 Setter 注入时，推荐使用构造器注入方式：

Spring 4.x Constructor-based or setter-based DI?

The Spring team generally advocates constructor injection as it enables one to implement application components as immutable objects and to ensure that required dependencies are not null. Furthermore constructor-injected components are always returned to 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.

Setter injection should primarily only be used for optional dependencies that can be assigned reasonable default values within the class. Otherwise, not-null checks must be performed everywhere the code uses the dependency. One benefit of setter injection is that setter methods make objects of that class amenable to reconfiguration or re-injection later. Management through JMX MBeans is therefore a compelling use case for setter injection.

因为使用构造器注入方式注入的组件不可变，且保证了需要的依赖不为 null。此外，构造器注入的组件总是能够在完全初始化的状态返回给客户端（调用方）；对于很多参数的构造器说明可能包含了太多了职责，违背了单一职责原则，表示代码应该重构来分离职责到合适的地方。

2. 构造器注入还是 Setter 注入？

在对比 Setter 方法注入和 构造器注入的时候 分别引用的 Spring 官方文档的第二段阐述了除推荐方式的另一种方式的特点。

在 Spring 3.x 的时候 Spring 推荐 Setter 方法注入，第二段表示：一些纯粹主义者喜欢基于构造函数的注入。提供所有对象依赖项意味着对象总是在完全初始化状态下返回给客户机(调用)代码。缺点是对象不太容易重新配置和重新注入。

在 Spring 4.x 的时候 Spring 推荐构造器注入，第二段表示：Setter 注入应该主要用于可选的依赖项，这些依赖项可以在类中分配合理的默认值。否则，必须在代码使用依赖项的任何地方执行非空检查。setter 注入的一个好处是，setter 方法使该类的对象能够在以后重新配置或重新注入。

Setter 注入应该被用于可选依赖项。当没有提供它们时，类应该能够正常工作。在对象被实例化之后，依赖项可以在任何时候被更改。

构造器注入有利于强制依赖。通过在构造函数中提供依赖，您可以确保依赖对象在被构造时已准备好被使用。在构造函数中赋值的字段也可以是final的，这使得对象是完全不可变的，或者至少可以保护其必需的字段。

构造器注入还可以避免 Field 注入的循环依赖问题，比如 在 Alpha 中注入 Beta，又在 Beta 中注入 Alpha。如果使用构造器注入，在 Spring 启动的时候就会抛出 BeanCurrentlyInCreationException 提醒循环依赖。

参考：

https://docs.spring.io/spring-framework/docs/3.1.x/spring-framework-reference/html/beans.html#d0e2778

https://docs.spring.io/spring-framework/docs/4.2.x/spring-framework-reference/html/beans.html#beans-constructor-injection

https://www.vojtechruzicka.com/field-dependency-injection-considered-harmful/

本文内容总结：0. 引入，1. 常见的三种注解注入方式对比，Field 注入，Setter 方法注入，Constructor 注入，2. 构造器注入还是 Setter 注入？，

原文链接：https://www.cnblogs.com/zhangshuaiyin/p/15035887.html

以上是 SpringBoot 构造器注入、Setter方法注入和Field注入对比 的全部内容， 来源链接： utcz.com/yxgl/295861.html

回到顶部