Spring Boot集成测试：按Profile切换Mock与真实外部API方案

Spring Boot Test完全支持这种根据环境切换Mock与真实外部API的场景，核心思路是通过Spring Profile配合条件注入实现不同环境下的Bean切换，具体实现步骤如下：

1. 定义外部API的接口规范 #

先抽象外部API的调用逻辑为统一接口，保证Mock和真实实现的可替换性：

public interface ExternalApiClient {
    String fetchData(String param);
}

2. 实现真实的外部API调用类 #

编写调用真实外部REST API的实现类，用@Profile标注仅在real-api Profile下生效：

@Service
@Profile("real-api")
public class RealExternalApiClient implements ExternalApiClient {
    private final RestTemplate restTemplate;

    public RealExternalApiClient(RestTemplate restTemplate) {
        this.restTemplate = restTemplate;
    }

    @Override
    public String fetchData(String param) {
        // 实际调用外部REST API的逻辑
        return restTemplate.getForObject("https://external-api.com/data?param={param}", String.class, param);
    }
}

3. 实现Mock版本的外部API调用类 #

编写Mock实现类，用@Profile标注在mock-api或默认Profile下生效（确保API不可用时自动用Mock）：

@Service
@Profile({"mock-api", "default"})
public class MockExternalApiClient implements ExternalApiClient {
    @Override
    public String fetchData(String param) {
        // 返回Mock数据，模拟外部API响应
        return "Mocked data for param: " + param;
    }
}

4. 在测试类中指定Profile运行 #

通过@ActiveProfiles注解指定测试使用的Profile，实现Mock/真实API的切换：

使用Mock API的测试 #

@SpringBootTest
@ActiveProfiles("mock-api")
public class ExternalApiMockTest {
    @Autowired
    private ExternalApiClient externalApiClient;

    @Test
    void testFetchDataWithMock() {
        String result = externalApiClient.fetchData("test");
        assertEquals("Mocked data for param: test", result);
    }
}

使用真实API的测试 #

@SpringBootTest
@ActiveProfiles("real-api")
public class ExternalApiRealTest {
    @Autowired
    private ExternalApiClient externalApiClient;

    @Test
    void testFetchDataWithRealApi() {
        // 调用真实外部API，需确保测试环境中API可用
        String result = externalApiClient.fetchData("test");
        assertNotNull(result);
        // 根据真实API的预期响应编写断言
    }
}

5. 进阶：通过配置文件控制Profile（可选） #

在application.properties中设置默认Profile，避免依赖不可用的外部API：

spring.profiles.active=mock-api

在CI/CD或特定测试环境中，可通过命令行参数覆盖：

# 运行测试时指定使用real-api Profile
mvn test -Dspring.profiles.active=real-api

这种方案基于Spring原生Profile机制，无需额外引入Mock框架（若需复杂Mock逻辑，也可结合Mockito增强），代码简洁易维护，完美适配你的场景。

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