Spring Boot测试工具类创建使用及依赖注入异常解决

问题 #

我想创建一个仅用于测试的工具类，封装所有测试都会用到的方法来减少代码重复。请问这个类应该放在什么位置，以及如何在测试类中导入并使用它？

遇到的报错 #

org.springframework.beans.factory.UnsatisfiedDependencyException: 
Error creating bean with name 'FooTest': Unsatisfied dependency
expressed through field 'myTestUtils'; nested exception is 
org.springframework.beans.factory.NoSuchBeanDefinitionException: 

No qualifying bean of type 'com.utils.MyTestUtils' available: expected 
at least 1 bean which qualifies as autowire candidate. Dependency 
annotations: {@org.springframework.beans.factory.annotation.Autowired(required=true)}

相关代码 #

初始测试工具类 #

// src/test/com/example/utils/MyTestUtils.java
public class MyTestUtils {
    public String foo = "bar";
}

测试类代码 #

// src/test/com/example/services/FooTest.java
import com.example.utils.TestUtils;

@SpringBootTest
public class FooTest {
  
    // 移除@Autowired注解后，myTestUtils会为空
    @Autowired
    MyTestUtils myTestUtils;

    @Test
    public void testFoo() throws Exception {
        AssertThat(myTestUtils.foo).equals("bar");
    }
}

问题分析与解决 #

1. 测试工具类的创建位置 #

测试专用工具类应该放在src/test/java目录下，建议和业务代码保持一致的包结构，比如业务代码的工具类在src/main/java/com/example/utils，测试工具类就对应放在src/test/java/com/example/utils，这样既符合项目规范，也便于后续维护和导入。

2. 导入方式 #

在测试类中直接通过全限定类名导入即可，注意原测试类中的import语句存在错误：应该导入MyTestUtils而不是TestUtils，正确的导入语句为：

import com.example.utils.MyTestUtils;

3. 依赖注入问题解决 #

报错的核心原因是MyTestUtils没有被Spring容器管理，所以@Autowired无法找到对应的bean。通过给MyTestUtils添加Spring的组件注解（比如@Service、@Component），即可将其纳入容器管理，解决依赖注入问题：

// src/test/com/example/utils/MyTestUtils.java
@Service
public class MyTestUtils {
    public String foo = "bar";
}

（注：如果工具类不需要Spring的其他特性，也可以不用依赖注入，直接通过new MyTestUtils()的方式实例化使用，这样更轻量化）

内容的提问来源于stack exchange，提问作者haulvulgar