Spring依赖注入方式

 写在前面：大家好！我是晴空๓。如果博客中有不足或者的错误的地方欢迎在评论区或者私信我指正，感谢大家的不吝赐教。我的唯一博客更新地址是：https://ac-fun.blog.csdn.net/。非常感谢大家的支持。一起加油，冲鸭！
 用知识改变命运，用知识成就未来！加油 (ง •̀o•́)ง (ง •̀o•́)ง

前言

 Spring 框架对于 Java 服务端开发无疑是一个举足轻重的存在，它以简洁、高效、灵活的特性为我们开发提供了强大的支持，极大的提高了我们的开发效率和代码质量。Spring 解决了一个非常重要的问题，它可以通过 XML 或者 注解 来管理对象之间的依赖关系，也就是 Spring 的依赖注入机制。

 依赖注入（Dependency Injection，DI） 作为 Spring 核心理念之一，贯穿于整个框架的使用之中。通过依赖注入，Spring容器在创建一个对象时，会自动将这个对象的依赖注入进去，就不需要程序员主动通过 new对象 的方式进行对象创建。Spring 通过依赖注入机制打破了传统编程中对象之间紧密耦合的局面，让各个组件能够更加独立、灵活地进行开发、测试和维护，为构建复杂而稳定的软件系统奠定了坚实的基础。Spring 框架提供了多种依赖注入方式，本文主要介绍一下 Spring 框架中各种依赖注入的方式。

依赖注入方式

 Spring 主要有三种常见的注入方式，分别是基于构造方法的注入、基于Setter方法的注入、基于字段注入。还有不经常使用的基于方法注入、接口回调注入。

基于构造法方法的注入

 所谓基于构造方法注入，就是通过构造方法将依赖项传递给对象。在对象实例化时，Spring IoC 容器会根据构造方法的参数类型，从容器中查找并注入匹配的依赖项。

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

 相比于其他注入方式，Spring 官方更推荐构造函数注入。官方文档说明如下(https://docs.spring.io/spring-framework/reference/core/beans/dependencies/factory-collaborators.html#beans-setter-injection)：

官方推荐使用构造器注入的原因主要有以下几点：

1. 依赖完整性：构造器注入可以确保在对象创建时，所有必需的依赖项都已经被注入，从而避免空指针异常。
2. 实现不可变对象：构造器注入可以将对象实现为不可变对象，即对象的状态在创建后不能被修改。不可变对象在多线程环境中更安全，因为它们的状态不会被改变。
3. 初始化保证：通过构造器注入的组件总是以完全初始化的状态返回给客户端（调用方）代码。组件在使用前已完全初始化，减少了潜在的错误。
4. 避免过多的构造器参数：构造器注入鼓励将类的设计保持简洁，避免过多的依赖项。如果一个类有过多的构造器参数，这通常是一个糟糕的设计，表明该类承担了过多的职责，应该进行重构。

基于Setter方法的注入

 通过类的 Setter 方法来注入依赖项。适用于可选依赖或易于变更的配置属性的场景，因为对象可以先创建一个默认状态，然后再通过 Setter 方法补充注入依赖。基于 Setter 方法注入的一个好处是，Setter 方法使得该类的对象便于以后重新配置或重新注入。

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

基于字段注入

 基于字段注入直接通过注解（@Autowired、@Resource、@Inject）将依赖项注入到目标类的字段中。这是最简洁的方式，但通常不推荐使用。

public class MyService {  @Autowired  private MyDependency myDependency;  
}

基于方法注入

 通过普通方法（非Setter方法）注入依赖项。这种方式较为灵活，但使用较少。

public class MyService {  public void performAction(@Autowired MyDependency myDependency) {  myDependency.doSomething();  }  
}

配置方式

 以上这些注入方式主要通过三种方式进行配置，分别是基于XML文件的配置、基于注解的配置和基于Java类的配置。其中基于XML文件的配置是 Spring 早期的配置方式，现在使用的比较少。目前我们常用的配置方式主要是后两种。但是第一种方式也是需要了解的，如果看一些老项目的话还是需要掌握一下。

示例代码

 为了方便展示写了一个简单的计算器，该计算器只实现了加减乘除操作，我们需要在计算器的 Controller 类中注入加减乘除服务的实现类 ServiceImpl

// CalculatorApplication类
package com.qingkong.application;import com.qingkong.calculator.CalculatorController;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;public class CalculatorApplication {public static void main(String[] args) {// 加载Spring的配置文件ApplicationContext context = new ClassPathXmlApplicationContext("beans.xml");// 获取 CalculatorController BeanCalculatorController calculatorController = context.getBean(CalculatorController.class);// 测试计算器的功能System.out.println(calculatorController.add(1, 2));}
}---
// CalculatorService 接口
package com.qingkong.service;public interface CalculatorService {double add(double a, double b);double subtract(double a, double b);double multiply(double a, double b);double divide(double a, double b);
}---
// CalculatorService 接口实现类
package com.qingkong.service.impl;import com.qingkong.service.CalculatorService;public class CalculatorServiceImpl implements CalculatorService {public CalculatorServiceImpl() {System.out.println("CalculatorServiceImpl无参构造方法被调用了");}@Overridepublic double add(double a, double b) {return a + b;}@Overridepublic double subtract(double a, double b) {return a - b;}@Overridepublic double multiply(double a, double b) {return a * b;}@Overridepublic double divide(double a, double b) {if (b == 0) {throw new IllegalArgumentException("不能除以0!");}return a / b;}
}

基于XML文件的配置注入

pom依赖

 要想实现 Spring 的依赖注入功能，需要引入 spring-context 依赖。spring-context 模块是 Spring 框架的核心模块之一，它提供了支持 Spring 应用上下文和事件驱动模型的功能。它构建在 spring-core 和 spring-beans 模块之上，提供了以下功能：

• 依赖注入（DI）：支持通过 XML 配置、注解或 Java 配置进行依赖注入。
• 应用上下文（ApplicationContext）：提供了更高级的上下文接口，如 ClassPathXmlApplicationContext 和 FileSystemXmlApplicationContext，用于加载配置文件和管理 Bean。
• 事件支持：支持事件发布和监听。

 我们只在 pom.xml 中引入 spring-context 依赖，Maven 会根据 依赖传递 自动将 spring-core、spring-bean、spring-aop等spring-context依赖的其他 Spring 模块引入。这些模块是 spring 框架的核心模块，真实的开发场景下还会引入其他模块。

<dependency><groupId>org.springframework</groupId><artifactId>spring-context</artifactId><version>5.3.30</version>
</dependency>

相关标签

bean标签

 在 XML 中我们可以通过 <bean> 标签来配置一个bean，该标签主要的元素如下所示：

属性	作用
id	Bean 的唯一标识符，用于在 Spring 容器中引用该 Bean
class	Bean 的全限定类名
scope	定义 Bean 的作用域（如 singleton、prototype 等）
autowire	指定自动装配的方式（如 byName、byType 等）
factory-bean	指定一个工厂 Bean，用于创建当前 Bean
factory-method	指定工厂 Bean 中用于创建当前 Bean 的方法，与 factory-bean 配合使用
parent	指定当前 Bean 的父 Bean
lazy-init	指定是否延迟初始化该 Bean
depends-on	指定该 Bean 依赖的其他 Bean
primary	标记当前 Bean 为优先选择的 Bean
init-method	指定 Bean 初始化时执行的方法
destroy-method	指定 Bean 销毁时执行的方法

constructor-arg标签

 XML 配置文件使用 <constructor-arg/> 标签传入构造方法所需要的内容。该标签主要的属性如下：

属性	作用
ref	传给构造方法参数的Bean ID
value	传给构造方法参数的值
type	构造方法参数对应的类型
index	构造方法参数对应的位置，从0开始计算
name	构造方法参数对应的名称

property标签

 使用 <property/> 可以为 Bean 的属性赋值或注入其他 Bean。该标签主要的元素如下：

属性	作用
name	指定要设置的属性名称
value	指定要注入的属性值
ref	引用另一个 Bean 的 Bean ID

XML实现构造器注入

 对于 CalculatorController 类，先生成该类的构造方法，然后将其依赖的 CalculatorService 类作为构造方法的参数注入。完成之后在 XML 文件中进行配置，具体实现如下：

CalculatorController类：

public class CalculatorController {private final CalculatorService calculatorService;// 构造器注入public CalculatorController(CalculatorService calculatorService) {System.out.println("开始进行构造器注入");this.calculatorService = calculatorService;}public double add(double a, double b) {return calculatorService.add(a, b);}public double subtract(double a, double b) {return calculatorService.subtract(a, b);}public double multiply(double a, double b) {return calculatorService.multiply(a, b);}public double divide(double a, double b) {return calculatorService.divide(a, b);}
}

XML配置文件：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans.xsd"><!-- 定义 CalculatorService 的 Bean --><bean id="calculatorService" class="com.qingkong.service.impl.CalculatorServiceImpl"/><!-- 定义 CalculatorController 的 Bean，使用构造器注入 --><bean id="calculatorController" class="com.qingkong.calculator.CalculatorController" ><constructor-arg ref="calculatorService"/></bean></beans>

XML实现Setter方法注入

 首先在 CalculatorController 类中设置 calculatorService 的类型的属性，然后生成 Set 方法。完成之后在 XML 文件中进行配置，具体实现如下：

CalculatorController类：

public class CalculatorController {private CalculatorService calculatorService;// Set方法public void setCalculatorService(CalculatorService calculatorService) {System.out.println("开始进行Setter方法注入");this.calculatorService = calculatorService;}public double add(double a, double b) {return calculatorService.add(a, b);}public double subtract(double a, double b) {return calculatorService.subtract(a, b);}public double multiply(double a, double b) {return calculatorService.multiply(a, b);}public double divide(double a, double b) {return calculatorService.divide(a, b);}
}

XML配置文件：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans.xsd"><!-- 定义 CalculatorService 的 Bean --><bean id="calculatorService" class="com.qingkong.service.impl.CalculatorServiceImpl"/><!-- 定义 CalculatorController 的 Bean，使用Setter方法注入 --><bean id="calculatorController" class="com.qingkong.calculator.CalculatorController" ><!-- name属性的值对应 calculatorController 方法中相关属性的名称 --><property name="calculatorService" ref="calculatorService"/></bean></beans>

基于注解的配置注入

 使用注解注入有两种方式，分别是基于XML和注解混合方式 和 纯注解方式。第一种方式需要在 XML 文件中配置 context:component-scan 标签，而基于纯注解方式则不需要进行任何 XML 配置，只需要在配置类中加入 @ComponentScan 注解并执行扫描包路径即可。

将一个类声明为Bean的注解

 在 XML配置注入 中我们通过 <bean/> 配置一个 Bean，而在基于注解的配置时我们只需要在类上面添加如下四个注解中的任意一个都能让 Spring 容器把他们配置为 Bean。

注解	说明
@Component	将类标识为普通的Bean
@Service	用于标识服务层的类
@Controller	用于标识控制器层（Controller）的类（后来针对REST服务又增加了一个@RestController注解）
@Repository	用于标识数据访问层的类，与数据库进行交互

 这四个注解本质上没有区别，而且后面三个注解都是 @Component 注解的衍生注解，之所以这么做主要是为了在分层架构中提供更好的语义化支持和分层的明确性，提高代码的可读性和可维护性。

可注入依赖的注解

 Spring 内置的 @Autowired 以及 JDK 内置的 @Resource 和 @Inject 都可以用于注入 Bean。这里需要注意的是 @Autowired 默认的注入方式为 byType（根据类型进行匹配），如果一个接口存在多个实现类，Spring 会同时找到多个满足条件的选择，这种情况下，注入方式会变为 byName（根据名称进行匹配），这个名称通常就是类名（首字母小写）。

 如果一个接口有多个实现类一般建议使用 @Autowired 和 @Qualifier 注解配合的方式来显式指定名称而不是依赖变量的名称来区分。@Qualifier 注解主要用来在依赖注入时消除歧义。当面对一个接口有多个实现类我们可以使用 @Qualifier(“类名”) 的方式使 Spring 在依赖注入时准确的找到依赖。

 @Resource 默认注入方式为 byName。如果无法通过名称匹配到对应的 Bean 时，注入方式会变为 byType。 该注解 name 和 type 有两个重要的属性。如果仅指定 name 属性则注入方式为 byName，如果仅指定 type属性则注入方式为 byType，如果同时指定 name 和 type 属性（不建议这么做）则注入方式为byType + byName。

基于XML和注解混合方式

CalculatorServiceImpl类

@Component
public class CalculatorServiceImpl implements CalculatorService {// 省略重复代码……
}

CalculatorController类

@Component
public class CalculatorController {@Autowiredprivate CalculatorService calculatorService;public double add(double a, double b) {return calculatorService.add(a, b);}public double subtract(double a, double b) {return calculatorService.subtract(a, b);}public double multiply(double a, double b) {return calculatorService.multiply(a, b);}public double divide(double a, double b) {return calculatorService.divide(a, b);}
}

XML文件

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:context="http://www.springframework.org/schema/context"xsi:schemaLocation="http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans.xsdhttp://www.springframework.org/schema/contexthttp://www.springframework.org/schema/context/spring-context.xsd"><!-- 开启注解并扫描指定包中带有注解的类   --><context:component-scan base-package = "com.qingkong"/></beans>

基于Java类的配置注入

 从 Spring Framework 3.0 开始，我们可以使用 @Configuration 注解定义配置类，可以达到替换 XML 配置文件的效果。使用 @Configuration、@Bean、@ComponentScan 等一系列注解，基本可以满足日常开发所需。

我们只需要将原来的 XML 配置文件删除，再加上带有 @Configuration 注解的配置类即可。

配置类代码：

@Configuration
@ComponentScan("com.qingkong")
public class Config {
}

 当使用时需要通过 AnnotationConfigApplicationContext 对象来加载我们定义的配置类。

// 加载Spring的配置类
ApplicationContext context = new AnnotationConfigApplicationContext(Config.class);
// 获取 CalculatorController Bean
CalculatorController calculatorController = context.getBean(CalculatorController.class);

@ComponentScan

 @ComponentScan 注解指定了类扫描的包名，作用与 XML 配置文件中的 <context:component-scan/> 类似。如果配置类的 @ComponentScan 没有指定扫描的基础包路径或者类，那么默认从该配置类的包开始扫描（最好还是指定路径，防止漏包）。该注解的 includeFilters 和 excludeFilters 属性可以用来指定包含和排除组件。官网中也给出了相应的示例：

@Configuration
@ComponentScan(basePackages = "org.example",includeFilters = @Filter(type = FilterType.REGEX, pattern = ".*Stub.*Repository"),excludeFilters = @Filter(Repository.class))
public class AppConfig {...
}

该配置类与以下 XML配置 等效：

<beans><context:component-scan base-package="org.example"><context:include-filter type="regex"expression=".*Stub.*Repository"/><context:exclude-filter type="annotation"expression="org.springframework.stereotype.Repository"/></context:component-scan>
</beans>

@Bean

 我们也可以在配置类将 @Bean 注解放在方法上面，这样方法的返回对象就会被当做容器的一个 Bean。默认情况下，Bean 名称与方法名称相同。官网给出了使用例子：

@Configuration
public class AppConfig {@Beanpublic TransferService transferService() {return new TransferServiceImpl();}
}

该配置与以下 XML 中的配置是等价的：

<beans><bean id="transferService" class="com.acme.TransferServiceImpl"/>
</beans>

 既然有了 @Component 等注解为什么还要用 @Bean 注解呢？@Component 注解作用于类，而 @Bean 注解作用于方法。当我们引用第三方库中的类需要装配到 Spring 容器时，只能用 @Bean 注解来实现，因为通常情况下我们是无法修改第三方类库的代码的。

---

1. https://docs.spring.io/spring-framework/docs/5.2.x/spring-framework-reference/core.html#spring-core
2. 《学透Spring 从入门到项目实战》
3. JavaGuide