Symfony API认证：使用安全组件优雅处理请求中断

# app/config/security.yaml
security:
    # ... 其他配置 ...

    providers:
        # 定义一个简单的用户提供者，即使不从数据库加载用户，也需要一个
        in_memory: { memory: ~ }

    firewalls:
        dev:
            pattern: ^/(_(profiler|wdt)|css|images|js)/
            security: false

        main:
            pattern: ^/
            anonymous: true
            guard:
                authenticators:
                    - AppBundle\Security\ApiKeyAuthenticator # 注册你的自定义认证器
                entry_point: AppBundle\Security\ApiKeyAuthenticator # 认证失败时的入口点

    access_control:
        # 保护所有以 /api 开头的路由，要求经过认证
        - { path: ^/api, roles: IS_AUTHENTICATED_FULLY }

// src/AppBundle/Security/ApiKeyAuthenticator.php
namespace AppBundle\Security;

use Doctrine\ORM\EntityManager;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Security\Core\Exception\AuthenticationException;
use Symfony\Component\Security\Core\User\UserProviderInterface;
use Symfony\Component\Security\Guard\Authenticator\AbstractGuardAuthenticator;
use AppBundle\Entity\ApiKey; // 假设你有一个ApiKey实体

class ApiKeyAuthenticator extends AbstractGuardAuthenticator
{
    private $em;

    public function __construct(EntityManager $em)
    {
        $this->em = $em;
    }

    /**
     * 检查请求是否包含认证凭据。
     * 如果返回 false，则跳过此认证器。
     */
    public function supports(Request $request)
    {
        return $request->headers->has('x-auth-token');
    }

    /**
     * 从请求中提取认证凭据（例如API密钥）。
     */
    public function getCredentials(Request $request)
    {
        return [
            'token' => $request->headers->get('x-auth-token'),
        ];
    }

    /**
     * 根据凭据加载用户（或验证凭据本身）。
     * 在这里，我们直接验证API密钥。
     */
    public function getUser($credentials, UserProviderInterface $userProvider)
    {
        $token = $credentials['token'];
        if (null === $token) {
            return null;
        }

        // 从数据库中获取预设的API密钥
        // 注意：在实际应用中，你可能需要更复杂的逻辑，例如根据token查找用户或多个有效密钥
        $apiKeyEntity = $this->em->getRepository(ApiKey::class)->findOneBy(['enabled' => true, 'name' => 'apikey']);

        if (!$apiKeyEntity || $token !== $apiKeyEntity->getApiKey()) {
            return null; // 认证失败
        }

        // 如果认证成功，返回一个表示已认证用户的对象。
        // 对于API密钥认证，这个用户对象可能非常简单，例如一个匿名用户或一个代表API客户端的用户。
        // 这里返回一个简单的匿名用户对象，表示凭据有效。
        // 在实际应用中，你可能需要根据API密钥关联到一个特定的用户实体。
        return new \Symfony\Component\Security\Core\User\User('api_user', null, ['ROLE_API']);
    }

    /**
     * 检查凭据是否有效。
     * 由于我们在getUser中已经完成了密钥验证，这里直接返回true。
     */
    public function checkCredentials($credentials, \Symfony\Component\Security\Core\User\UserInterface $user)
    {
        return true;
    }

    /**
     * 认证成功时调用。
     */
    public function onAuthenticationSuccess(Request $request, TokenInterface $token, $providerKey)
    {
        // 认证成功，请求继续
        return null;
    }

    /**
     * 认证失败时调用。
     */
    public function onAuthenticationFailure(Request $request, AuthenticationException $exception)
    {
        $data = [
            'message' => strtr($exception->getMessageKey(), $exception->getMessageData())
        ];

        return new JsonResponse($data, JsonResponse::HTTP_UNAUTHORIZED);
    }

    /**
     * 当匿名用户尝试访问受保护资源时调用（作为entry_point）。
     */
    public function start(Request $request, AuthenticationException $authException = null)
    {
        $data = [
            'message' => '认证失败，请提供有效的API密钥。'
        ];

        return new JsonResponse($data, JsonResponse::HTTP_UNAUTHORIZED);
    }

    /**
     * 是否记住我功能，API认证通常不需要。
     */
    public function supportsRememberMe()
    {
        return false;
    }
}

# app/config/services.yaml
services:
    # ... 其他服务 ...

    AppBundle\Security\ApiKeyAuthenticator:
        arguments: ['@doctrine.orm.entity_manager']
        tags: ['security.guard_authenticator'] # 可选，但有助于识别