两个Spring JUnit测试类@TestPropertySource值不同时触发InstanceAlreadyExistsException

问题背景 #

我有两个仅类名不同的Spring JUnit测试类ATest和BTest，ATest的代码如下：

@RunWith(SpringRunner.class) 
@EnableAutoConfiguration 
@TestPropertySource(properties = {"myProperty=true"}) 
@ActiveProfiles("test") 
public class ATest { 
    @Test 
    public void aTest() throws Exception { 
        Assert.assertEquals("Hello", "Hello"); 
    } 
}

当两个测试类的myProperty属性值相同时，同时运行均可通过；但将其中一个测试类的myProperty值改为false后，第二个测试会抛出InstanceAlreadyExistsException异常，堆栈信息如下：

java.lang.IllegalStateException: Failed to load ApplicationContext 
at org.springframework.test.context.cache.DefaultCacheAwareContextLoaderDelegate.loadContext(DefaultCacheAwareContextLoaderDelegate.java:124) 
at org.springframework.test.context.support.DefaultTestContext.getApplicationContext(DefaultTestContext.java:83) 
at org.springframework.test.context.support.DependencyInjectionTestExecutionListener.injectDependencies(DependencyInjectionTestExecutionListener.java:117) 
at org.springframework.test.context.support.DependencyInjectionTestExecutionListener.prepareTestInstance(DependencyInjectionTestExecutionListener.java:83) 
at org.springframework.test.context.TestContextManager.prepareTestInstance(TestContextManager.java:230) 
at org.springframework.test.context.junit4.SpringJUnit4ClassRunner.createTest(SpringJUnit4ClassRunner.java:228) 
at org.springframework.test.context.junit4.SpringJUnit4ClassRunner$1.runReflectiveCall(SpringJUnit4ClassRunner.java:287) 
at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12) 
at org.springframework.test.context.junit4.SpringJUnit4ClassRunner.methodBlock(SpringJUnit4ClassRunner.java:289) 
at org.springframework.test.context.junit4.SpringJUnit4ClassRunner.runChild(SpringJUnit4ClassRunner.java:247) 
at org.springframework.test.context.junit4.SpringJUnit4ClassRunner.runChild(SpringJUnit4ClassRunner.java:94) 
at org.junit.runners.ParentRunner$3.run(ParentRunner.java:290) 
at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:71) 
at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288) 
at org.junit.runners.ParentRunner.access$000(ParentRunner.java:58) 
at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:268) 
at org.springframework.test.context.junit4.statements.RunBeforeTestClassCallbacks.evaluate(RunBeforeTestClassCallbacks.java:61) 
at org.springframework.test.context.junit4.statements.RunAfterTestClassCallbacks.evaluate(RunAfterTestClassCallbacks.java:70) 
at org.junit.runners.ParentRunner.run(ParentRunner.java:363) 
at org.springframework.test.context.junit4.SpringJUnit4ClassRunner.run(SpringJUnit4ClassRunner.java:191) 
at org.junit.runners.Suite.runChild(Suite.java:128) 
at org.junit.runners.Suite.runChild(Suite.java:27) 
at org.junit.runners.ParentRunner$3.run(ParentRunner.java:290) 
at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:71) 
at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288) 
at org.junit.runners.ParentRunner.access$000(ParentRunner.java:58) 
at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:268) 
at org.junit.runners.ParentRunner.run(ParentRunner.java:363) 
at org.junit.runner.JUnitCore.run(JUnitCore.java:137) 
at com.intellij.junit4.JUnit4IdeaTestRunner.startRunnerWithArgs(JUnit4IdeaTestRunner.java:68) 
at com.intellij.rt.execution.junit.IdeaTestRunner$Repeater.startRunnerWithArgs(IdeaTestRunner.java:47) 
at com.intellij.rt.execution.junit.JUnitStarter.prepareStreamsAndStart(JUnitStarter.java:242) 
at com.intellij.rt.execution.junit.JUnitStarter.main(JUnitStarter.java:70) 
Caused by: org.springframework.jmx.export.UnableToRegisterMBeanException: Unable to register MBean [org.springframework.cloud.context.environment.EnvironmentManager@444720b7] with key 'environmentManager'; nested exception is javax.management.InstanceAlreadyExistsException: org.springframework.cloud.context.environment:name=environmentManager,type=EnvironmentManager 
at org.springframework.jmx.export.MBeanExporter.registerBeanNameOrInstance(MBeanExporter.java:628) 
at org.springframework.jmx.export.MBeanExporter.registerBeans(MBeanExporter.java:550) 
at org.springframework.jmx.export.MBeanExporter.afterSingletonsInstantiated(MBeanExporter.java:432) 
at org.springframework.beans.factory.support.DefaultListableBeanFactory.preInstantiateSingletons(DefaultListableBeanFactory.java:781) 
at org.springframework.context.support.AbstractApplicationContext.finishBeanFactoryInitialization(AbstractApplicationContext.java:867) 
at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:543) 
at org.springframework.test.context.support.AbstractGenericContextLoader.loadContext(AbstractGenericContextLoader.java:128) 
at org.springframework.test.context.support.AbstractGenericContextLoader.loadContext(AbstractGenericContextLoader.java:60) 
at org.springf

问题原因 #

这个异常的核心是Spring测试上下文缓存机制和Spring Cloud JMX MBean全局唯一性的冲突：

1. Spring测试框架会根据测试的配置（比如@TestPropertySource、@ActiveProfiles）生成唯一缓存键，当两个测试配置不同时，会加载两个独立的ApplicationContext。
2. Spring Cloud的EnvironmentManager会被注册为JMX MBean，而JMX的MBean名称是全局唯一的。当第二个ApplicationContext尝试注册同名的EnvironmentManager MBean时，就会触发InstanceAlreadyExistsException。

解决方案 #

这里提供三个可行的解决思路，按推荐优先级排序：

1. 配置MBean注册策略为忽略已存在的实例

在测试类上添加@EnableMBeanExport(registration = RegistrationPolicy.IGNORE_EXISTING)，这样当MBean已经存在时，Spring会跳过注册操作，避免冲突。修改后的测试类示例：

@RunWith(SpringRunner.class)
@EnableAutoConfiguration
@TestPropertySource(properties = {"myProperty=true"})
@ActiveProfiles("test")
@EnableMBeanExport(registration = RegistrationPolicy.IGNORE_EXISTING)
public class ATest {
    @Test
    public void aTest() throws Exception {
        Assert.assertEquals("Hello", "Hello");
    }
}

记得把这个注解也添加到BTest类中。

2. 直接禁用Spring Cloud的JMX功能

在@TestPropertySource中添加spring.cloud.jmx.enabled=false，彻底关闭Spring Cloud的JMX组件，这样就不会注册EnvironmentManager MBean了：

@TestPropertySource(properties = {"myProperty=true", "spring.cloud.jmx.enabled=false"})

这个方案简单直接，适合不需要Spring Cloud JMX功能的测试场景。

3. 使用@DirtiesContext销毁上下文

在每个测试类上添加@DirtiesContext(classMode = ClassMode.AFTER_CLASS)，这样每个测试类执行完成后会立即销毁对应的ApplicationContext，确保下一个测试加载全新的上下文时不会有MBean残留。不过这个方案会增加测试时间，因为每次都要重新初始化上下文，适合测试用例较少的场景：

@RunWith(SpringRunner.class)
@EnableAutoConfiguration
@TestPropertySource(properties = {"myProperty=true"})
@ActiveProfiles("test")
@DirtiesContext(classMode = ClassMode.AFTER_CLASS)
public class ATest {
    // ... 测试方法
}

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