环境配置与测试类编写

---

环境配置与测试类编写

本章详细讲解如何在 Spring Test 中配置测试环境，并编写符合规范的测试类。内容涵盖 配置加载方式、依赖注入实践 以及 多环境适配技巧，适用于纯 Spring 项目（不涉及 Spring Boot）。

---

1. 配置加载方式

1.1 使用 XML 配置文件

适用于传统 XML 配置的 Spring 项目。

示例：加载 XML 配置

@ExtendWith(SpringExtension.class)  
@ContextConfiguration(locations = "classpath:applicationContext.xml") // 指定 XML 路径  
public class XmlConfigTest {  
    @Autowired  
    private UserService userService;  

    @Test  
    void testService() {  
        assertNotNull(userService);  
    }  
}  

1.2 使用 Java Config 配置类

适用于基于注解的现代 Spring 项目。

步骤 1：定义配置类

@Configuration  
@ComponentScan("com.example.service") // 扫描 Service 层  
@EnableTransactionManagement  
public class AppConfig {  
    @Bean  
    public DataSource dataSource() {  
        // 配置数据源（例如 H2 内存数据库）  
        return new EmbeddedDatabaseBuilder()  
            .setType(EmbeddedDatabaseType.H2)  
            .addScript("classpath:schema.sql")  
            .build();  
    }  

    @Bean  
    public PlatformTransactionManager transactionManager(DataSource dataSource) {  
        return new DataSourceTransactionManager(dataSource);  
    }  
}  

步骤 2：测试类引用配置类

@ExtendWith(SpringExtension.class)  
@ContextConfiguration(classes = AppConfig.class) // 指定配置类  
public class JavaConfigTest {  
    @Autowired  
    private UserService userService;  

    @Test  
    void testService() {  
        User user = userService.findById(1L);  
        assertEquals("Alice", user.getName());  
    }  
}  

1.3 混合配置（XML + Java Config）

同时使用 XML 和 Java Config 的场景。

示例：混合加载

@ExtendWith(SpringExtension.class)  
@ContextConfiguration(  
    classes = ServiceConfig.class, // Java 配置类  
    locations = "classpath:dao-config.xml" // XML 配置文件  
)  
public class MixedConfigTest {  
    @Autowired  
    private UserService userService;  

    @Autowired  
    private UserDao userDao;  
}  

---

2. 多环境适配与 Profile

2.1 定义 Profile 专属配置

为不同环境（如测试、生产）创建独立配置。

示例：测试专用配置类

@Configuration  
@Profile("test") // 仅当 Profile 为 "test" 时生效  
public class TestDataSourceConfig {  
    @Bean  
    public DataSource dataSource() {  
        // 测试环境使用 H2 内存数据库  
        return new EmbeddedDatabaseBuilder()  
            .setType(EmbeddedDatabaseType.H2)  
            .addScript("classpath:test-data.sql")  
            .build();  
    }  
}  

2.2 激活 Profile

在测试类中指定激活的 Profile。

示例：启用测试 Profile

@ExtendWith(SpringExtension.class)  
@ContextConfiguration(classes = {AppConfig.class, TestDataSourceConfig.class})  
@ActiveProfiles("test") // 激活 Profile  
public class ProfileTest {  
    @Autowired  
    private DataSource dataSource;  

    @Test  
    void testDataSource() {  
        assertTrue(dataSource instanceof EmbeddedDatabase);  
    }  
}  

---

3. 测试类结构规范

3.1 基础模板

@ExtendWith(SpringExtension.class) // 必须添加  
@ContextConfiguration(classes = AppConfig.class) // 指定配置  
public class StandardTestTemplate {  
    @Autowired  
    private MyService myService;  

    @BeforeEach  
    void setUp() {  
        // 初始化操作（如准备测试数据）  
    }  

    @Test  
    @Transactional  
    void testBusinessLogic() {  
        // 测试方法  
    }  

    @AfterEach  
    void tearDown() {  
        // 清理操作（如删除临时文件）  
    }  
}  

3.2 依赖注入的最佳实践

• 直接注入被测试对象：

  @Autowired  
  private UserService userService; // 直接注入 Service  
  

• 注入辅助工具：

  @Autowired  
  private JdbcTemplate jdbcTemplate; // 用于直接操作数据库验证结果  
  

• 避免注入 Spring 上下文：

  // 不推荐（除非必要）  
  @Autowired  
  private ApplicationContext context;  
  

---

4. 复杂场景配置技巧

4.1 加载多个配置类

合并多个配置类以满足复杂需求。

示例：合并数据库和服务配置

@ExtendWith(SpringExtension.class)  
@ContextConfiguration(classes = {DatabaseConfig.class, ServiceConfig.class})  
public class MultiConfigTest {  
    @Autowired  
    private UserService userService;  

    @Autowired  
    private DataSource dataSource;  
}  

4.2 使用 @TestConfiguration 覆盖 Bean

在测试中临时替换某些 Bean 的实现。

示例：模拟外部服务

@ExtendWith(SpringExtension.class)  
@ContextConfiguration(classes = {AppConfig.class, MockConfig.class})  
public class OverrideBeanTest {  
    @Autowired  
    private PaymentService paymentService;  

    @Test  
    void testPayment() {  
        assertTrue(paymentService.processPayment() instanceof MockPaymentService);  
    }  

    @TestConfiguration  
    static class MockConfig {  
        @Bean  
        public PaymentService paymentService() {  
            return new MockPaymentService(); // 覆盖原有 Bean  
        }  
    }  
}  

---

5. 常见问题与解决方案

问题 1：无法注入 Bean

• 可能原因：
  • 配置类未正确扫描 Bean（检查 @ComponentScan 范围）。
  • 测试类未指定 @ContextConfiguration。
• 解决方案：

  @ContextConfiguration(classes = AppConfig.class) // 确认配置类包含被测试 Bean  
  @ComponentScan("com.example.service") // 确保扫描路径正确  
  

问题 2：事务未回滚

• 可能原因：
  • 忘记添加 @Transactional 注解。
  • 使用了错误的 PlatformTransactionManager。
• 解决方案：

  @Transactional // 确保添加注解  
  @ContextConfiguration(classes = DataSourceConfig.class) // 确认事务管理器配置正确  
  

问题 3：上下文重复加载

• 可能原因：
  • 不同测试类使用了不同配置，导致无法复用上下文。
  • 过度使用 @DirtiesContext。
• 优化方案：

  // 统一相同测试类的配置  
  @ContextConfiguration(classes = CommonConfig.class)  
  

---

通过本章内容，您可掌握 Spring Test 的核心配置方法，并能够根据项目需求灵活调整测试环境。