Symfony 4、如何实现通用控制器即服务？

我有这个控制器

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 and 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());
    }

}

And 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”。

我不明白这个错误从何而来，也不明白为什么会发生。有人可以帮助我理解为什么会出现这种情况以及如何解决它吗？

好的。回到基础知识。首先为自己准备一个 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());
    }
}

并且不要再排除一般服务人员。

一旦您使用 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 应与实体管理器一起注入。我将把确切的细节留给学生作为练习，因为注入字符串与注入对象有点不同。