如何在 Cakephp 4 中正确抛出 UnauthenticatedException？

Question

我在 cakephp 4 中使用插件 Authentication 2。

当用户未登录时以及在 ajax 请求的情况下，我想抛出一个 UnauthenticatedException。 目标是在 JSON 中捕获异常。

这是我的服务器代码：

// in src/Controller/Admin/AdminController.php
use Authentication\Authenticator\UnauthenticatedException;

class AdminController extends AppController {

    public function initialize(): void
    {
        parent::initialize();
        $this->loadComponent('Authentication.Authentication');
    }

    public function beforeFilter(EventInterface $event)
    {
        parent::beforeFilter($event);

        // The server receives an ajax request and the user is not logged in (any more), an UnauthenticatedException is thrown
        if ($this->request->is('ajax') && $this->request->getAttribute('identity') === null) {
            throw new UnauthenticatedException('Please log in');
        }
    }

}

这是我来自客户端的代码：

$.ajax({
    dataType: 'json';
    type: 'POST',
    data: $(form).serialize(),
    // [...]
})
// [...]
.fail(function (jqXHR, textStatus, errorThrown) {
    console.log(jqXHR.responseJSON); // There's no responseJSON in jqXHR...
    alert("(" + errorThrown + ")" + jqXHR.responseJSON.message);
    if (errorThrown == 'Unauthenticated') {
        location.reload();
    }
});

问题是jqXHR 中没有responseJSON。

为什么任何其他异常（例如我之前使用的UnauthorizedException）在返回中生成responseJSON 而不是UnauthenticatedException？

如何使它与UnauthenticatedException 一起工作？

Answer 1

默认情况下，身份验证中间件会重新引发未经身份验证的异常，即除非您配置 unauthenticatedRedirect 选项，否则它将相应地将这些异常转换为重定向。

如果您需要同时支持 HTML 和 JSON 请求/响应，那么您可以例如动态配置，分别不根据当前请求配置unauthenticatedRedirect 选项，例如在您的@ 987654323@ 方法做一些类似的事情：

$service = new AuthenticationService();

$accepts = array_map('trim', explode(',', $request->getHeaderLine('Accept')));
$isJsonRequest = in_array('application/json', $accepts, true);

if (!$isJsonRequest) {
    // service config for non-JSON requests
    $service->setConfig([
        'unauthenticatedRedirect' => /* ...*/,
        'queryParam' => 'redirect',
    ]);
}

作为手动评估标头的替代方法，要求 request 是 \Cake\Http\ServerRequest 的实例并使用其 is() 方法：

assert($request instanceof \Cake\Http\ServerRequest);
if (!$request->is('json')) {
    $service->setConfig([
        'unauthenticatedRedirect' => [/* ...*/],
        'queryParam' => 'redirect',
    ]);
}

另请注意，默认情况下，身份验证组件将要求身份存在并相应地引发异常，您不必自己这样做。