symfony - Symfony 4，如何将通用控制器实现为服务？

Question

我有这个控制器

Controller1.php

<?php


namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Annotation\Route;

class file1Controller extends AbstractController
{
    /**
     * @Route("/Some/URI", methods={"GET"})
     * @param Request $request
     * @return JsonResponse
     */
    public function list(Request $request)
    {
        if (empty($request->headers->get('api-key'))) {
            return new JsonResponse(['error' => 'Please provide an API_key'], 401);
        }

        if ($request->headers->get('api-key') !== $_ENV['API_KEY']) {
            return new JsonResponse(['error' => 'Invalid API key'], 401);
        }

        return new JsonResponse($this->getDoctrine()->getRepository('App:Something')->findAll());
    }
}

这完全符合预期（使用 Postman 和我的浏览器进行了测试）。我想概括一下，将通用控制器作为服务，并为每个控制器使用该服务Controller1.php，Controller2.php并且Controller3.php所有内容都相同，除了方法@route和Something内部getRepository。

这是我的尝试：

GeneralService.php

<?php


namespace Service;

use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Annotation\Route;


class GeneralService
{
    /**
     * @param Request $request
     * @param String $entity
     * @return JsonResponse
     */
    public function list(Request $request, String $entity)
    {
        if (empty($request->headers->get('api-key'))) {
            return new JsonResponse(['error' => 'Please provide an API_key'], 401);
        }

        if ($request->headers->get('api-key') !== $_ENV['API_KEY']) {
            return new JsonResponse(['error' => 'Invalid API key'], 401);
        }

        return new JsonResponse($this->getDoctrine()->getRepository('App:{$entity}')->findAll());
    }

}

然后Controller1.php更改为SubscriptionController.php：

<?php


namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\JsonResponse;
use Service\GeneralService;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Annotation\Route;

class SubscriptionController extends AbstractController
{
    /**
     * @Route("/Some/Uri", methods={"GET"})
     * @param GeneralService $generalService
     * @param Request $request
     * @return JsonResponse
     */
    public function AuthenticateAPI(GeneralService $generalService, Request $request)
    {
        $AuthenticatorObject = $generalService->list($request ,'Something');
        return $AuthenticatorObject;
    }

}

不幸的是，这不起作用并产生以下错误：

无效参数异常

无法确定“App\Controller\Controller1::AuthenticateAPI()”的控制器参数：$generalService 参数使用不存在的类或接口进行类型提示：“Service\GeneralService”。

我不知道这个错误来自哪里，也不知道为什么会发生。有人可以帮助我理解为什么会出现这种情况以及如何解决吗？

标签： symfonysymfony4

Answer 1

好的。回到基础。首先让自己拥有一个 IDE，例如 PHPStorm。它将突出显示各种语法错误以及其他错误。特别是，IDE 将帮助解决服务命名空间问题以及各种其他问题。

依赖注入背后的基本概念是给定类所需的依赖项应该被注入。您的 GeneralService 类需要实体管理器。在您之前的相同问题中，您有 GeneralService 扩展 AbstractController 因为 AbstractController 有一个 getDoctrine 方法。它仍然行不通，因为 getDoctrine 又需要服务容器。当然，在您当前的代码中，GeneralService 根本没有 getDoctrine 方法。

无论如何，由于 GeneralService 需要实体管理器然后注入它：

# src/Service/GeneralService.php
namespace App\Service; # NOTE App\Service not just Service

use Doctrine\ORM\EntityManagerInterface;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;

class GeneralService
{
    private $entityManager;

    // Let Symfony inject whatever dependencies are needed
    public function __construct(EntityManagerInterface $entityManager)
    {
        $this->entityManager = $entityManager;
    }
    public function list(Request $request, String $entityClass) : JsonResponse
    {
        if (!$request->headers->has('api-key')) {
            return new JsonResponse(['error' => 'Please provide an API_key'], 401);
        }

        if (!$request->headers->get('api-key') !== $_ENV['API_KEY']) {
            return new JsonResponse(['error' => 'Invalid API key'], 401);
        }

        return new JsonResponse($this->entityManager->getRepository($entityClass)->findAll());
    }
}

并且不再排除 GeneralService。

一旦您使用 IDE 消除所有小的语法错误，您的控制器类就非常好：

namespace App\Controller;

use App\Service\GeneralService;
use App\Entity\SomeEntity;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Request;

class SubscriptionClass extends AbstractController
{
    public function AuthenticateAPI(Request $request, GeneralService $generalService)
    {
        $AuthenticatorObject = $generalService->list($request,SomeEntity::class);
        return $AuthenticatorObject;
    }

}

我实际上并没有测试上面的代码，尽管它应该让你至少更进一步。

最后一点：不要直接访问任何超级全局变量，即 $_ENV['API_KEY'] 是不可以的。api_key 应该与实体管理器一起注入。我将把确切的细节留给学生练习，因为注入字符串与注入对象有点不同。