本文详细介绍了在Symfony 4.4项目中，如何有效地测试包含外部服务依赖的控制器。通过配置测试环境的services_test.yaml文件，使目标服务可被公开访问，然后在测试用例中创建服务的Mock对象，并将其注入到测试容器中，最终通过HTTP请求触发控制器逻辑，从而实现对控制器行为的隔离测试，避免了直接实例化控制器带来的复杂依赖问题。
导言
在开发复杂的web应用程序时，控制器（controller）作为处理用户请求和调度业务逻辑的核心组件，其测试的重要性不言而喻。然而，控制器往往会依赖于多个服务，这些服务可能涉及数据库操作、第三方api调用、邮件发送等。当这些依赖的服务在测试环境中难以模拟或成本较高时，就需要采用mock（模拟）技术来隔离控制器，确保测试的焦点仅集中在控制器自身的逻辑上，而不是其依赖服务的行为。
本教程将以一个Symfony 4.4项目中的WebhookController为例，详细演示如何通过Mock其外部服务依赖MyService，从而实现对控制器的有效测试。MyService被设定为调用外部API，因此在测试中需要被模拟。
理解控制器及其依赖
首先，我们来看一下需要测试的WebhookController的结构：
final class WebhookController extends AbstractController{ private CustomLoggerService $customLogger; private EntityManagerInterface $entityManager; private MyService $myService; // 外部服务依赖 private UserMailer $userMailer; private AdminMailer $adminMailer; public function __construct( CustomLoggerService $customLogger, EntityManagerInterface $entityManager, MyService $myService, UserMailer $userMailer, AdminMailer $adminMailer ) { $this->customLogger = $customLogger; $this->myService = $myService; $this->userMailer = $userMailer; $this->adminMailer = $adminMailer; $this->entityManager = $entityManager; } /** * @Route("/webhook/new", name="webhook_new") * @param Request $request * @return Response */ public function new(Request $request): Response { $uri = $request->getUri(); $this->customLogger->info("new event uri ".$uri); $query = $request->query->all(); if (isset($query['RessourceId'])) { $id = $query['RessourceId']; // 调用外部服务 $event = $this->myService->getInfos($id); $infoId = $event->infoId; $this->customLogger->info("new info id ".$infoId); $userRepo = $this->entityManager->getRepository(User::class); $user = $userRepo->findOneByEventUserId((int)$event->owners[0]); $this->userMailer->sendAdminEvent($event, $user); $this->customLogger->info("new mail sent"); } else { $this->adminMailer->sendSimpleMessageToAdmin("no ressource id", "no ressource id"); } return new JsonResponse(); }}
该控制器在new方法中根据请求参数RessourceId的有无，执行不同的逻辑。其中，当RessourceId存在时，会调用$this->myService->getInfos($id)来获取信息。由于MyService是一个调用外部API的服务，在测试时我们不希望真正发起外部请求，因此需要对其进行Mock。
传统测试方法的挑战
在Symfony中，测试控制器通常使用WebTestCase。然而，直接实例化控制器（如new WebhookController(xxxx)）会导致一系列问题：
依赖注入复杂性： 控制器有多个构造函数依赖，手动实例化意味着需要提供所有这些依赖，而这些依赖本身可能还有自己的依赖，形成一个复杂的依赖链，难以维护。服务容器缺失： 手动实例化控制器，将无法利用Symfony的服务容器自动注入依赖的强大功能。
而直接使用$client->request()进行HTTP请求时，服务容器会自动创建控制器及其依赖，但此时我们无法在请求发出前对MyService进行Mock。
使用Symfony测试容器进行服务Mock
Symfony提供了一种优雅的方式来解决这个问题：通过在测试环境中将目标服务设置为public，然后在测试用例中创建Mock对象并将其注入到测试容器中，从而覆盖原有的服务实例。
以下是具体的步骤：
1. 配置测试环境，使目标服务可被公开访问
为了能够在测试用例中获取并替换服务容器中的服务实例，我们需要将MyService在测试环境中设置为public。这通过修改config/services_test.yaml文件实现：
# config/services_test.yamlAppServiceMyService: public: true # 将MyService设置为public，以便在测试中访问和替换
说明： 默认情况下，Symfony的服务在容器中是私有的，这意味着你无法直接通过self::$container->get()获取它们。将服务设置为public: true仅影响测试环境，不会影响生产环境或其他环境的服务可见性。
2. 创建Mock对象并定义其行为
在测试用例中，使用PHPUnit的createMock()方法来创建一个MyService的模拟对象，并定义其在特定方法被调用时的预期行为和返回值。
use AppServiceMyService;use SymfonyBundleFrameworkBundleTestWebTestCase;use SymfonyComponentBrowserKitKernelBrowser;class WebhookControllerTest extends WebTestCase{ // ... 其他测试方法或trait public function testNewWebhookWithResourceId(): void { // 确保内核已关闭，以便重新启动并获取干净的服务容器 self::ensureKernelShutdown(); /** @var KernelBrowser $client */ $client = static::createClient(); // 使用static::createClient()创建客户端 $client->enableProfiler(); // 启用Profiler，便于调试 // 1. 创建MyService的Mock对象 $myServiceMock = $this->createMock(MyService::class); // 2. 定义Mock对象的行为：当getInfos方法被调用一次时，返回指定数据 $myServiceMock->expects($this->once()) ->method("getInfos") ->willReturn((object)[ // 返回一个对象以匹配控制器中的 $event->infoId 访问 'infoId' => 'mocked_info_123', 'owners' => ['mocked_owner_id'] ]); // ... 后续步骤 }}
说明：
$this->createMock(MyService::class)：创建MyService类的一个模拟实例。$myServiceMock->expects($this->once())->method(“getInfos”)：配置Mock对象，期望getInfos方法被调用一次。->willReturn((object)[‘infoId’ => ‘mocked_info_123’, ‘owners’ => [‘mocked_owner_id’]])：定义getInfos方法被调用时返回的值。这里返回一个匿名对象，以模拟MyService实际返回的结构，确保控制器中的$event->infoId和$event->owners能够正确访问。
3. 将Mock对象注入到测试容器中
这是关键一步。通过self::$container->set()方法，我们可以将创建的Mock对象替换掉服务容器中原有的MyService实例。
// ... 承接上一步的 testNewWebhookWithResourceId 方法 // 3. 将Mock对象注入到测试容器中，替换掉原有的MyService实例 self::$container->set(MyService::class, $myServiceMock); // ... 后续步骤
说明： self::$container是WebTestCase提供的静态属性，它代表了当前测试运行的Symfony服务容器。set()方法允许你用新的实例覆盖容器中已注册的服务。
4. 发起HTTP请求，触发控制器逻辑
现在，当$client->request()被调用时，Symfony的服务容器会自动解析WebhookController的依赖，并在注入MyService时，会使用我们刚刚设置的Mock对象，而不是真实的MyService实例。
// ... 承接上一步的 testNewWebhookWithResourceId 方法 // 4. 发起HTTP请求，触发控制器逻辑 $client->request('GET', '/webhook/new/?RessourceId=1111'); // 5. 进行断言，验证控制器行为 $this->assertResponseIsSuccessful(); // 进一步断言，例如检查日志、数据库状态或响应内容 // 假设控制器返回JsonResponse，可以检查其内容 $responseContent = json_decode($client->getResponse()->getContent(), true); $this->assertNotNull($responseContent); // 确保返回了有效的JSON // ... 更多针对控制器逻辑的断言 }}
完整测试代码示例：
enableProfiler(); // 启用Profiler，便于调试 // 1. 创建MyService的Mock对象 $myServiceMock = $this->createMock(MyService::class); // 2. 定义Mock对象的行为：当getInfos方法被调用一次时，返回指定数据 // 确保返回的数据结构与控制器中对 $event 对象的访问方式匹配 $myServiceMock->expects($this->once()) ->method("getInfos") ->with(1111) // 假设getInfos接收RessourceId作为参数 ->willReturn((object)[ 'infoId' => 'mocked_info_123', 'owners' => [123] // 假设owner ID是整数 ]); // 3. 将Mock对象注入到测试容器中，替换掉原有的MyService实例 self::$container->set(MyService::class, $myServiceMock); // 4. 发起HTTP请求，触发控制器逻辑 $client->request('GET', '/webhook/new/?RessourceId=1111'); // 5. 进行断言，验证控制器行为 $this->assertResponseIsSuccessful('控制器应成功响应'); // 假设控制器在成功处理后返回空JsonResponse，我们可以验证状态码 $this->assertEquals(200, $client->getResponse()->getStatusCode()); // 如果控制器有其他可观察的副作用（如日志、数据库更新、邮件发送）， // 可以在这里通过检查Profiler或Mock其他服务来断言这些副作用。 // 例如，如果CustomLoggerService也被Mock了，可以断言其info方法被调用 // $customLoggerMock->expects($this->atLeastOnce())->method('info'); // 如果UserMailerService也被Mock了，可以断言其sendAdminEvent方法被调用 // $userMailerMock->expects($this->once())->method('sendAdminEvent'); } public function testNewWebhookWithoutResourceId(): void { self::ensureKernelShutdown(); $client = static::createClient(); $client->enableProfiler(); // 对于不依赖MyService的路径，通常不需要Mock MyService // 但如果控制器中其他路径也依赖，且我们想确保其不被调用，也可以Mock $client->request('GET', '/webhook/new/'); // 不带RessourceId $this->assertResponseIsSuccessful('控制器应成功响应'); $this->assertEquals(200, $client->getResponse()->getStatusCode()); // 在这种情况下，我们可能期望AdminMailer被调用，如果AdminMailer也被Mock了，可以断言 // $adminMailerMock->expects($this->once())->method('sendSimpleMessageToAdmin'); }}
注意事项与最佳实践
self::ensureKernelShutdown()： 在每个测试方法开始时调用此方法，可以确保每次测试都在一个干净的Symfony内核实例上运行，避免测试之间的状态污染。static::createClient()： 使用static::createClient()而不是$this->startClient()。createClient()是WebTestCase的标准方法，用于创建测试客户端。$client->enableProfiler()： 在开发和调试测试时非常有用，它允许你在测试失败后通过Profiler查看请求、响应、日志、数据库查询等详细信息。Mock返回值的匹配： 确保Mock对象返回的数据结构与控制器中对该数据的访问方式（例如$event->infoId）相匹配，避免因类型或结构不匹配导致的运行时错误。隔离性： 这种方法允许你完全隔离控制器，只测试其自身的逻辑，而无需担心外部服务的实际行为。何时考虑重构： 如果一个控制器依赖的服务过多，或者其逻辑过于复杂，这可能是一个信号，表明控制器承担了过多的职责。在这种情况下，可以考虑将部分业务逻辑或副作用（如日志、邮件发送）提取到专门的服务中，使控制器更精简，更易于测试。例如，将日志和邮件发送逻辑封装到独立的业务服务中，控制器只负责协调这些服务。
总结
通过本教程，我们学习了如何在Symfony 4.4项目中，利用services_test.yaml配置和测试容器的set()方法，有效地对控制器中的外部服务依赖进行Mock测试。这种方法不仅解决了传统测试方式中依赖注入的复杂性问题，而且确保了测试的隔离性和可靠性，是编写高质量Symfony应用程序测试用例的关键技术之一。掌握这一技巧，将有助于您构建更健壮、更易于维护的应用程序。
以上就是Symfony控制器中外部服务Mock测试指南的详细内容，更多请关注php中文网其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/1321957.html
微信扫一扫 
支付宝扫一扫 
