Laravel 8 PHPUnit测试中如何模拟父类控制器封装的Guzzle API调用
落地实现步骤
第一步:做最小侵入的代码调整,为测试预留可替换入口
原实现的核心问题是在
getAPI方法内部直接new Guzzle Client,属于硬编码依赖,外部无法在测试阶段替换实例,自然无法拦截请求。只需对基础控制器做极小改动,完全不影响现有业务逻辑运行:
// 改造后的基础Controller use GuzzleHttp\Client; class Controller extends BaseController { // 新增可被外部覆盖的Client属性,测试时可直接替换 protected ?Client $httpClient = null; protected function getAPI(string $url, array $params = []) { // 优先使用已定义的Client实例,未定义时从Laravel容器解析默认实例 $client = $this->httpClient ?? app(Client::class); $requestOptions = [ 'form_params' => $params, 'http_errors' => false ]; $response = $client->get($url, $requestOptions); // 原有响应处理逻辑保持完全不变 } }
注:原有子类控制器中调用getAPI('/get_data', [], 'get')的写法属于代码笔误,原方法定义未接收第三个参数,不影响后续测试逻辑实现。
第二步:基于Guzzle内置Mock能力编写单元测试
不需要额外引入第三方依赖,直接用Guzzle自带的MockHandler就可以完全拦截真实网络请求,测试逻辑如下:
- 构造预设的固定响应内容,模拟外部API的返回结果
- 用MockHandler绑定该响应,创建完全隔离的Guzzle Client
- 将这个带Mock的Client赋值给被测试控制器的
$httpClient属性,替换真实网络请求实例 - 正常调用被测的控制器方法,编写业务断言即可
对应的测试代码示例:
class OtherControllerTest extends TestCase { public function test_someMethod_business_logic() { // 构造模拟的API成功响应,完全不发起真实请求 $mockApiResponse = new \GuzzleHttp\Psr7\Response( 200, ['Content-Type' => 'application/json'], json_encode([ 'code' => 0, 'data' => ['field_a' => 'test_value'] ]) ); // 初始化Guzzle Mock处理器,把预设响应加入响应队列 $mockHandler = new \GuzzleHttp\Handler\MockHandler([$mockApiResponse]); // 用Mock处理器创建无网络能力的Guzzle Client $mockClient = new \GuzzleHttp\Client(['handler' => $mockHandler]); // 实例化被测控制器,替换为带Mock的HTTP客户端 $controller = new OtherController(); $controller->httpClient = $mockClient; // 正常调用被测业务方法,内部的getAPI请求会自动走Mock逻辑 $result = $controller->someMethod(); // 编写业务断言验证逻辑正确性 $this->assertEquals('test_value', $result['field_a']); } }
关键注意事项
- 不要直接Mock父类的
getAPI方法:如果直接把getAPI替换成返回固定值的Mock方法,会跳过对封装在基础控制器内的请求逻辑、响应处理逻辑的测试,相当于测试失效。我们要拦截的是最底层的真实网络请求,而不是上层封装的业务方法。 - 遇到连续多个API调用的场景,只要按照请求顺序,把对应的模拟响应依次塞进MockHandler的队列数组即可,MockHandler会自动按顺序返回对应响应。
- 原有代码的参数配置可后续优化:比如GET请求更适合用
query配置传递参数,替换掉当前的form_params,但这部分优化不影响测试逻辑的正常落地。
内容的提问来源于stack exchange,提问作者saionachi
相关产品推荐
相关产品推荐

