Laravel 8 路由多重认证（OR 逻辑）的实现：使用自定义认证守卫

本文详细探讨了在 Laravel 8 中为路由实现多重认证（即“或”逻辑）的正确方法。通过将不同的认证机制定义为独立的认证守卫（Guards），并利用 `auth` 中间件的逗号分隔语法，开发者可以轻松地让路由同时支持多种认证方式，用户只需通过其中任意一种认证即可访问受保护的资源，避免了直接在中间件数组中尝试“或”逻辑的误区。

在 Laravel 应用程序开发中，我们经常会遇到需要为同一组路由提供多种认证方式的场景，例如，一个 API 接口可能既支持基于 Sanctum 的 Token 认证，又支持传统的 HTTP Basic 认证。许多开发者在初次尝试时，可能会直观地在路由中间件数组中尝试使用逻辑“或”操作符，例如 ['auth:sanctum'|'auth.basic.once'] 或 ['auth:sanctum|auth.basic.once']。然而，这种做法在 Laravel 中是无效的，因为它不符合框架对认证中间件的处理机制，通常会导致错误或无法达到预期的“任一认证成功即可”的效果。

理解 Laravel 的认证守卫（Guards）

Laravel 的认证系统设计非常灵活，其核心概念之一就是“认证守卫”（Authentication Guards）。守卫是负责实际用户认证逻辑的组件，例如检查会话、验证 API Token、处理 HTTP Basic 认证等。Laravel 默认提供了 web、api 等守卫，并且允许开发者定义自己的自定义守卫。

当您在路由中使用 auth 中间件并指定一个或多个参数时，实际上是在告诉 Laravel 使用哪个（或哪些）守卫来尝试认证用户。例如，auth:sanctum 表示使用 sanctum 守卫进行认证。

实现多重认证的正确姿势

要实现路由的多重认证（“或”逻辑），关键在于将每种认证机制配置为一个独立的认证守卫，然后在 auth 中间件中以逗号分隔的方式指定这些守卫。Laravel 的 auth 中间件在接收到多个守卫名称时，会尝试按顺序使用每个守卫进行认证，只要其中任何一个守卫成功认证了用户，请求就会被允许通过。

1. 定义自定义认证守卫

首先，确保您的每种认证机制都已在 config/auth.php 中定义为独立的守卫。例如，如果您需要 sanctum 认证和 basic 认证，它们应该在 guards 数组中配置。

AI-Text-Classifier

OpenAI官方出品，可以区分人工智能书写的文本和人类书写的文本

59

查看详情

// config/auth.php
'guards' => [
    'web' => [
        'driver' => 'session',
        'provider' => 'users',
    ],
    'api' => [
        'driver' => 'token', // 示例，通常会是 Sanctum 或 Passport
        'provider' => 'users',
        'input_key' => 'api_token',
    ],
    'sanctum' => [ // Sanctum 守卫通常已由包自动配置
        'driver' => 'sanctum',
        'provider' => 'users',
    ],
    'basic' => [ // 假设您已配置好一个基于 HTTP Basic 的守卫
        'driver' => 'basic', // 或您自定义的驱动
        'provider' => 'users',
    ],
],

// 确保您的 'providers' 也已正确配置
'providers' => [
    'users' => [
        'driver' => 'eloquent',
        'model' => App\Models\User::class,
    ],
],

如果您需要自定义认证驱动，可以参考 Laravel 官方文档中关于“添加自定义守卫”的部分。例如，一个简单的 HTTP Basic 认证守卫通常可以直接使用 Laravel 内置的 basic 驱动，或者通过 Auth::viaRequest 方法创建。

2. 在路由中使用多重守卫

一旦您的认证守卫配置妥当，您就可以在路由定义中使用它们了。在 Route::group 或单个路由的 middleware 属性中，将 auth 中间件的参数设置为逗号分隔的守卫名称列表。

// routes/api.php
use App\Http\Controllers\ImageController;
use Illuminate\Support\Facades\Route;

Route::group(['middleware' => 'auth:sanctum,basic'], function () {
   Route::get('/images', [ImageController::class, 'index']);
});

在上述示例中，当请求访问 /images 路由时，Laravel 会首先尝试使用 sanctum 守卫进行认证。如果 sanctum 认证失败（例如，没有有效的 Sanctum Token），它会接着尝试使用 basic 守卫进行认证。只要其中任何一个认证成功，请求就会继续处理；如果所有指定的守卫都认证失败，则会返回未认证的响应（通常是 401 Unauthorized）。

注意事项与总结

• 守卫顺序： auth:guard1,guard2 中的守卫顺序可能会影响性能，因为 Laravel 会按顺序尝试。通常将最常用或性能开销最小的守卫放在前面。
• 错误处理： 如果所有守卫都失败，Laravel 会抛出 AuthenticationException，通常会被 App\Exceptions\Handler 捕获并转换为 401 响应。您可以根据需要自定义此行为。
• 清晰的职责： 将认证逻辑抽象为守卫，使得认证机制的添加、修改和管理更加模块化和清晰。
• 不要混淆： auth 中间件的逗号分隔参数是用于指定多个“守卫”进行“或”逻辑认证，而不是在中间件数组中直接尝试复杂的逻辑操作。

通过上述方法，您可以在 Laravel 8 应用程序中优雅且高效地实现路由的多重认证需求，提升 API 的灵活性和用户体验。

以上就是Laravel 8 路由多重认证（OR 逻辑）的实现：使用自定义认证守卫的详细内容，更多请关注php中文网其它相关文章！