测试夹具的依赖注入

当您使用 DependencyInjectionTestExecutionListener(默认配置)时,您的测试实例的依赖项将从您使用 @ContextConfiguration 或相关注解配置的应用程序上下文中的 bean 中注入。您可以使用 setter 注入、字段注入或两者,具体取决于您选择的注解以及您是在 setter 方法上还是在字段上放置它们。如果您使用的是 JUnit Jupiter,您还可以选择使用构造函数注入(请参阅 使用 SpringExtension 进行依赖注入)。为了与 Spring 的基于注解的注入支持保持一致,您还可以使用 Spring 的 @Autowired 注解或 JSR-330 的 @Inject 注解进行字段和 setter 注入。

对于除 JUnit Jupiter 之外的其他测试框架,TestContext 框架不参与测试类的实例化。因此,对于测试类,使用 @Autowired@Inject 进行构造函数没有效果。
虽然在生产代码中不鼓励使用字段注入,但在测试代码中,字段注入实际上非常自然。这种差异背后的原因是,你永远不会直接实例化你的测试类。因此,不需要能够在你的测试类上调用 `public` 构造函数或 setter 方法。

由于 `@Autowired` 用于执行 按类型自动装配,如果你有多个相同类型的 bean 定义,你不能依赖这种方法来处理这些特定的 bean。在这种情况下,你可以将 `@Autowired` 与 `@Qualifier` 结合使用。你也可以选择将 `@Inject` 与 `@Named` 结合使用。或者,如果你的测试类可以访问其 `ApplicationContext`,你可以使用(例如)调用 `applicationContext.getBean("titleRepository", TitleRepository.class)` 来执行显式查找。

如果你不希望将依赖注入应用于你的测试实例,请不要使用 `@Autowired` 或 `@Inject` 来注释字段或 setter 方法。或者,你可以通过使用 `@TestExecutionListeners` 显式配置你的类并从监听器列表中省略 `DependencyInjectionTestExecutionListener.class` 来完全禁用依赖注入。

考虑测试 `HibernateTitleRepository` 类的场景,如 目标 部分所述。接下来的两个代码清单演示了在字段和 setter 方法上使用 `@Autowired`。应用程序上下文配置在所有示例代码清单之后呈现。

以下代码清单中的依赖注入行为并非特定于 JUnit Jupiter。相同的 DI 技术可以与任何支持的测试框架结合使用。

以下示例调用了静态断言方法,例如 `assertNotNull()`,但没有在调用之前添加 `Assertions`。在这种情况下,假设该方法已通过 `import static` 声明正确导入,该声明未在示例中显示。

第一个代码清单展示了一个基于 JUnit Jupiter 的测试类实现,该类使用@Autowired进行字段注入。

  • Java

  • Kotlin

@ExtendWith(SpringExtension.class)
// specifies the Spring configuration to load for this test fixture
@ContextConfiguration("repository-config.xml")
class HibernateTitleRepositoryTests {

	// this instance will be dependency injected by type
	@Autowired
	HibernateTitleRepository titleRepository;

	@Test
	void findById() {
		Title title = titleRepository.findById(new Long(10));
		assertNotNull(title);
	}
}
@ExtendWith(SpringExtension::class)
// specifies the Spring configuration to load for this test fixture
@ContextConfiguration("repository-config.xml")
class HibernateTitleRepositoryTests {

	// this instance will be dependency injected by type
	@Autowired
	lateinit var titleRepository: HibernateTitleRepository

	@Test
	fun findById() {
		val title = titleRepository.findById(10)
		assertNotNull(title)
	}
}

或者,您可以将类配置为使用@Autowired进行 setter 注入,如下所示:

  • Java

  • Kotlin

@ExtendWith(SpringExtension.class)
// specifies the Spring configuration to load for this test fixture
@ContextConfiguration("repository-config.xml")
class HibernateTitleRepositoryTests {

	// this instance will be dependency injected by type
	HibernateTitleRepository titleRepository;

	@Autowired
	void setTitleRepository(HibernateTitleRepository titleRepository) {
		this.titleRepository = titleRepository;
	}

	@Test
	void findById() {
		Title title = titleRepository.findById(new Long(10));
		assertNotNull(title);
	}
}
@ExtendWith(SpringExtension::class)
// specifies the Spring configuration to load for this test fixture
@ContextConfiguration("repository-config.xml")
class HibernateTitleRepositoryTests {

	// this instance will be dependency injected by type
	lateinit var titleRepository: HibernateTitleRepository

	@Autowired
	fun setTitleRepository(titleRepository: HibernateTitleRepository) {
		this.titleRepository = titleRepository
	}

	@Test
	fun findById() {
		val title = titleRepository.findById(10)
		assertNotNull(title)
	}
}

前面的代码清单使用与@ContextConfiguration注释引用的相同 XML 上下文文件(即repository-config.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/beans
		https://www.springframework.org/schema/beans/spring-beans.xsd">

	<!-- this bean will be injected into the HibernateTitleRepositoryTests class -->
	<bean id="titleRepository" class="com.foo.repository.hibernate.HibernateTitleRepository">
		<property name="sessionFactory" ref="sessionFactory"/>
	</bean>

	<bean id="sessionFactory" class="org.springframework.orm.hibernate5.LocalSessionFactoryBean">
		<!-- configuration elided for brevity -->
	</bean>

</beans>

如果您从 Spring 提供的测试基类继承,而该基类恰好在其 setter 方法之一上使用@Autowired,那么您的应用程序上下文中可能定义了多个受影响类型的 bean(例如,多个DataSource bean)。在这种情况下,您可以覆盖 setter 方法并使用@Qualifier注释来指示特定的目标 bean,如下所示(但请确保也委托给超类中的覆盖方法):

  • Java

  • Kotlin

// ...

	@Autowired
	@Override
	public void setDataSource(@Qualifier("myDataSource") DataSource dataSource) {
		super.setDataSource(dataSource);
	}

// ...
// ...

	@Autowired
	override fun setDataSource(@Qualifier("myDataSource") dataSource: DataSource) {
		super.setDataSource(dataSource)
	}

// ...

指定的限定符值指示要注入的特定DataSource bean,将类型匹配集缩小到特定 bean。它的值与相应<bean>定义中的<qualifier>声明匹配。bean 名称用作后备限定符值,因此您也可以有效地通过名称指向特定 bean(如前所示,假设myDataSource是 bean 的id)。