Spring Boot 3类库中Repository集成测试的正确注解配置

问题背景 #

我基于Spring Boot 3开发类库，需要实现Repository的集成测试。用Spring官方的gs-accessing-data-jpa示例复现问题：移除带@SpringBootApplication的主启动类后，原测试类无法注入CustomerRepository，测试直接失败。

复现步骤：

git clone https://github.com/spring-guides/gs-accessing-data-jpa.git
cd gs-accessing-data-jpa/complete
mvn test # 测试正常通过
rm src/main/java/com/example/accessingdatajpa/AccessingDataJpaApplication.java
mvn test # 测试失败

之前尝试的几种注解组合均报错：

• 同时使用@SpringBootTest和@DataJpaTest：触发多个@BootstrapWith声明的冲突
• 仅用@SpringBootTest：Spring无法检测到配置类，无法注入Repository
• @SpringBootTest(classes = {CustomerRepository.class})：找不到合格的Repository Bean实例

正确解决方案 #

核心是给测试提供Spring配置类，用来启用JPA相关配置并扫描Repository组件，以下两种方案都可行：

方案1：测试类内嵌套配置类 #

直接在测试类中添加静态嵌套配置类，集中配置JPA相关规则：

@ExtendWith(SpringExtension.class)
@DataJpaTest
@ContextConfiguration(classes = CustomerRepositoryTests.TestConfig.class)
public class CustomerRepositoryTests {

    @Autowired
    private CustomerRepository customers;

    @Autowired
    private TestEntityManager entityManager;

    // 测试方法示例
    @Test
    public void testFindByLastName() {
        entityManager.persist(new Customer("Jack", "Bauer"));
        List<Customer> result = customers.findByLastName("Bauer");
        assertThat(result.size()).isEqualTo(1);
    }

    // 测试专用配置类
    @Configuration
    @EnableJpaRepositories(basePackages = "com.example.accessingdatajpa")
    @EntityScan(basePackages = "com.example.accessingdatajpa")
    @EnableTransactionManagement
    @AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.ANY)
    static class TestConfig {
        // 如需自定义数据源可在此添加，默认会自动配置H2内存数据库
    }
}

方案2：单独创建共用测试配置类 #

如果多个测试类需要复用配置，可单独编写配置类：

// src/test/java/com/example/accessingdatajpa/TestJpaConfig.java
@Configuration
@EnableJpaRepositories(basePackages = "com.example.accessingdatajpa")
@EntityScan(basePackages = "com.example.accessingdatajpa")
@EnableTransactionManagement
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.ANY)
public class TestJpaConfig {
}

然后在测试类中引用该配置：

@ExtendWith(SpringExtension.class)
@DataJpaTest
@ContextConfiguration(classes = TestJpaConfig.class)
public class CustomerRepositoryTests {

    @Autowired
    private CustomerRepository customers;

    @Autowired
    private TestEntityManager entityManager;

    // 测试方法...
}

关键配置说明 #

• @EnableJpaRepositories：指定Repository所在包路径，让Spring扫描并生成Repository Bean
• @EntityScan：指定实体类所在包，确保JPA能识别并映射实体
• @DataJpaTest：专为JPA测试设计的注解，自动配置内存数据库、TestEntityManager等组件，比@SpringBootTest更轻量
• @AutoConfigureTestDatabase：强制使用内存数据库，避免依赖外部数据库环境

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