Symfony项目中LexikJWTAuthentication空字段异常自定义问询

针对请求中未提供邮箱或密码的场景，这里提供两种可行的实现方式，优先推荐第一种前置拦截的方式，逻辑更直接：

方法一：请求前置拦截（推荐） #

在认证流程启动前直接校验请求参数，抛出自定义异常，避免进入后续认证逻辑。

1. 创建自定义异常类 #

在src/Exception目录下新建MissingCredentialsException.php，继承Symfony的认证异常类：

<?php

namespace App\Exception;

use Symfony\Component\Security\Core\Exception\AuthenticationException;

class MissingCredentialsException extends AuthenticationException
{
    public function getMessageKey(): string
    {
        return '邮箱或密码不能为空';
    }
}

2. 编写请求监听类拦截参数校验 #

创建src/EventListener/CredentialsValidationListener.php，指定高优先级确保在认证前执行：

<?php

namespace App\EventListener;

use App\Exception\MissingCredentialsException;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\RequestEvent;
use Symfony\Component\HttpKernel\KernelEvents;

class CredentialsValidationListener implements EventSubscriberInterface
{
    public static function getSubscribedEvents(): array
    {
        return [
            KernelEvents::REQUEST => ['validateCredentials', 255], // 高优先级确保先执行
        ];
    }

    public function validateCredentials(RequestEvent $event): void
    {
        $request = $event->getRequest();

        // 只针对Lexik的登录校验接口，替换成你的实际路由
        if ($request->getPathInfo() !== '/api/login_check') {
            return;
        }

        // 解析请求参数（根据你的请求格式调整，这里以JSON为例）
        $data = $request->toArray();
        // Lexik默认用`username`字段对应邮箱，若你配置成`email`则替换
        $email = $data['username'] ?? null;
        $password = $data['password'] ?? null;

        if (empty($email) || empty($password)) {
            throw new MissingCredentialsException();
        }
    }
}

3. 统一异常响应格式（可选） #

如果需要自定义异常返回的JSON结构，可配置Lexik的异常处理器：
在config/packages/lexik_jwt_authentication.yaml中添加：

lexik_jwt_authentication:
    # 保留原有配置...
    exception_handler: App\Handler\CustomAuthenticationFailureHandler

然后创建处理器类src/Handler/CustomAuthenticationFailureHandler.php：

<?php

namespace App\Handler;

use Lexik\Bundle\JWTAuthenticationBundle\Response\JWTAuthenticationFailureResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Security\Core\Exception\AuthenticationException;

class CustomAuthenticationFailureHandler implements \Lexik\Bundle\JWTAuthenticationBundle\Handler\AuthenticationFailureHandlerInterface
{
    public function onAuthenticationFailure(Request $request, AuthenticationException $exception): JWTAuthenticationFailureResponse
    {
        $responseData = [
            'code' => 400,
            'message' => $exception->getMessageKey(),
            'details' => '请检查请求中是否包含邮箱和密码参数'
        ];

        return new JWTAuthenticationFailureResponse($responseData, 400);
    }
}

方法二：通过认证失败事件替换异常 #

如果希望在认证失败流程中处理，可监听Lexik的认证失败事件，判断原异常是否为空字段导致，替换成自定义异常。

1. 创建自定义异常类（同方法一） #

2. 编写认证失败事件监听器 #

创建src/EventListener/AuthenticationFailureListener.php：

<?php

namespace App\EventListener;

use App\Exception\MissingCredentialsException;
use Lexik\Bundle\JWTAuthenticationBundle\Event\AuthenticationFailureEvent;
use Symfony\Component\Security\Core\Exception\BadCredentialsException;

class AuthenticationFailureListener
{
    public function onAuthenticationFailure(AuthenticationFailureEvent $event): void
    {
        $originalException = $event->getException();

        // 判断是否为Symfony默认抛出的空凭证异常
        if ($originalException instanceof BadCredentialsException && str_contains($originalException->getMessage(), 'Bad credentials')) {
            $request = $event->getRequest();
            $data = $request->toArray();
            $email = $data['username'] ?? null;
            $password = $data['password'] ?? null;

            // 确认是字段为空导致的异常，替换为自定义异常
            if (empty($email) || empty($password)) {
                $event->setException(new MissingCredentialsException());
            }
        }
    }
}

3. 注册监听器 #

在config/services.yaml中添加监听器标签：

services:
    # 保留原有服务配置...
    App\EventListener\AuthenticationFailureListener:
        tags:
            - { name: kernel.event_listener, event: lexik_jwt_authentication.on_authentication_failure, method: onAuthenticationFailure }

内容的提问来源于stack exchange，提问作者Skyshufeu