Spring Boot JUnit测试中无法覆盖@ImportResource配置的问题

问题核心 #

你的IgniteCacheManager类本身通过@ImportResource硬编码加载了默认的Ignite配置文件，这个配置的加载优先级高于测试类中指定的配置，导致测试环境无法使用自定义的服务器节点配置。

解决方案 #

方案一：通过配置占位符动态切换配置路径 #

这种方式无需修改太多代码，只需让配置路径支持外部参数注入，测试时指定测试配置路径即可。

1. 修改IgniteCacheManager类的@ImportResource注解，使用Spring占位符，默认值保留原配置路径：

@Component
@Configuration
@ImportResource("${ignite.config.path:file:./config/IgniteConfig.xml}")
public class IgniteCacheManager {
    
    @Autowired
    private IgniteConfiguration cfg;
    
    private Ignite igniteClient;
    private static final Logger log = LoggerFactory.getLogger(IgniteCacheManager.class);

    @PostConstruct
    private void init() {
        try {           
            igniteClient = Ignition.start(cfg);
        } catch (Exception ex) {
            log.error("Unable to connect to ignite cache ", ex);
        }
    }
}

2. 在测试类中通过@TestPropertySource指定测试用的配置路径：

@SpringBootTest
@TestPropertySource(properties = {"ignite.config.path=file:./src/test/resources/IgniteConfigTest.xml"})
public class JWTEndtoEndTest {

    @Test
    public void loginValidateAndLogOutUser() {
        // 测试逻辑
    }
}

方案二：创建测试专用配置类覆盖Bean #

直接在测试环境定义一个@Primary的IgniteConfiguration Bean，让Spring优先使用这个测试配置，无需依赖XML文件。

1. 在src/test/java下创建测试配置类：

@Configuration
public class TestIgniteConfig {

    @Bean
    @Primary
    public IgniteConfiguration igniteConfiguration() {
        IgniteConfiguration cfg = new IgniteConfiguration();
        // 配置为服务器节点，关闭自动发现其他节点
        cfg.setClientMode(false);
        TcpDiscoverySpi discoverySpi = new TcpDiscoverySpi();
        TcpDiscoveryVmIpFinder ipFinder = new TcpDiscoveryVmIpFinder();
        // 仅使用本地地址，不寻找外部节点
        ipFinder.setAddresses(Collections.singletonList("127.0.0.1:47500..47509"));
        discoverySpi.setIpFinder(ipFinder);
        cfg.setDiscoverySpi(discoverySpi);
        
        // 添加测试需要的缓存配置等其他参数
        return cfg;
    }
}

2. 测试类中导入该配置类：

@SpringBootTest
@Import(TestIgniteConfig.class)
public class JWTEndtoEndTest {

    @Test
    public void loginValidateAndLogOutUser() {
        // 测试逻辑
    }
}

方案三：替换原IgniteCacheManager为测试版本 #

如果不想修改原业务类，可以在测试中排除原IgniteCacheManager，替换为测试专用的版本。

1. 创建测试用的TestIgniteCacheManager：

@Component
@Configuration
@ImportResource("file:./src/test/resources/IgniteConfigTest.xml")
public class TestIgniteCacheManager {
    
    @Autowired
    private IgniteConfiguration cfg;
    
    private Ignite igniteClient;
    private static final Logger log = LoggerFactory.getLogger(TestIgniteCacheManager.class);

    @PostConstruct
    private void init() {
        try {           
            igniteClient = Ignition.start(cfg);
        } catch (Exception ex) {
            log.error("Unable to connect to ignite cache ", ex);
        }
    }
}

2. 测试类中排除原类并导入测试类：

@SpringBootTest(exclude = IgniteCacheManager.class)
@Import(TestIgniteCacheManager.class)
public class JWTEndtoEndTest {

    @Test
    public void loginValidateAndLogOutUser() {
        // 测试逻辑
    }
}

原方案失效原因 #

原测试类中添加的@ImportResource优先级低于IgniteCacheManager类自身携带的@ImportResource，Spring会优先加载业务类中指定的配置文件，导致测试配置被覆盖。

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