Spring测试框架中的@ContextConfiguration继承机制

在Spring框架中，@ContextConfiguration 注解是一个非常重要的工具，它用于指定测试类的上下文配置来源。然而，很多人可能并不清楚，这个注解还提供了 inheritLocations 和 inheritInitializers 属性，用于控制是否继承父类的配置位置和上下文初始化器。本文将通过具体的代码示例，深入探讨这两个属性的作用。

默认行为：继承配置位置和初始化器

在默认情况下，inheritLocations 和 inheritInitializers 的值均为 true，这意味着子类测试会继承父类中声明的配置类和上下文初始化器。我们先来看一个具体的例子。

假设我们有一个简单的Spring应用，包含两个服务接口：CustomerService 和 OrderService，以及相应的配置类 AppConfig 和 AppConfigExtended。

@Service
public interface CustomerService {
    String getCustomerById(String id);
}

@Service
public interface OrderService {
    String getOrdersForCustomer(String customerId);
}

@Configuration
public class AppConfig {
    @Bean
    public CustomerService customerService() {
        return new CustomerService() {
            @Override
            public String getCustomerById(String id) {
                return "Customer " + id;
            }
        };
    }
}

@Configuration
public class AppConfigExtended {
    @Bean
    public OrderService orderService() {
        return new OrderService() {
            @Override
            public String getOrdersForCustomer(String customerId) {
                return "orders for customer " + customerId;
            }
        };
    }
}

接下来，我们定义两个测试类：BaseServiceTests 和 ExtendedServiceTests。BaseServiceTests 使用了 AppConfig，而 ExtendedServiceTests 继承自 BaseServiceTests 并添加了 AppConfigExtended。

@ContextConfiguration(classes = AppConfig.class,
        initializers = MyContextInitializer.class)
public class BaseServiceTests {
    @Autowired
    private CustomerService customerService;

    @Test
    public void testCustomerById() {
        String customer = customerService.getCustomerById("323");
        System.out.println("-- CustomerById test --");
        System.out.println(customer);
        Assert.notNull(customer, "customer is null for id 323");
    }
}

@RunWith(SpringRunner.class)
@ContextConfiguration(classes = AppConfigExtended.class)
public class ExtendedServiceTests extends BaseServiceTests {
    @Autowired
    private OrderService orderService;

    @Test
    public void testOrderCustomer() {
        String orders = orderService.getOrdersForCustomer("323");
        System.out.println("-- OrdersByCustomer test --");
        System.out.println(orders);
        Assert.notNull(orders, "Orders is null for id 323");
    }
}

public class MyContextInitializer implements
        ApplicationContextInitializer<ConfigurableApplicationContext> {
    @Override
    public void initialize(ConfigurableApplicationContext ac) {
        System.out.println("-- in context initializer --");
    }
}

运行 ExtendedServiceTests 时，输出结果如下：

-- in context initializer --
-- OrdersByCustomer test --
orders for customer 323
-- CustomerById test --
Customer 323

从输出可以看出，ExtendedServiceTests 继承了父类的配置类 AppConfig 和上下文初始化器 MyContextInitializer，同时添加了自己的配置类 AppConfigExtended。

禁用配置位置继承

如果我们不想让子类继承父类的配置类，可以通过将 inheritLocations 设置为 false 来实现。假设我们希望在 ExtendedServiceTests 中替换父类的 AppConfig，可以这样写：

@ContextConfiguration(inheritLocations = false,
        classes = {
                AppConfigExtended.class, OtherAppConfig.class
        })
public class ExtendedServiceTests extends BaseServiceTests {
    @Autowired
    private OrderService orderService;

    @Test
    public void testOrderCustomer() {
        String orders = orderService.getOrdersForCustomer("323");
        System.out.println("-- OrdersByCustomer test --");
        System.out.println(orders);
        Assert.notNull(orders, "Orders is null for id 323");
    }
}

@Configuration
public class OtherAppConfig {
    @Bean
    public CustomerService customerService() {
        return new CustomerService() {
            @Override
            public String getCustomerById(String id) {
                return "Other Customer " + id;
            }
        };
    }
}

运行后，输出结果如下：

-- in context initializer --
-- OrdersByCustomer test --
orders for customer 323
-- CustomerById test --
Other Customer 323

可以看到，ExtendedServiceTests 没有继承父类的 AppConfig，而是使用了新的配置类 OtherAppConfig。

总结

通过 @ContextConfiguration 的 inheritLocations 和 inheritInitializers 属性，我们可以灵活地控制测试类的配置继承行为。默认情况下，子类会继承父类的配置类和上下文初始化器，但通过设置这两个属性，我们可以根据需要调整继承行为。这种机制在复杂的测试场景中非常有用，可以帮助我们更好地组织和管理测试代码。