Laravel Sanctum 可选身份验证实现指南

本文介绍如何在 Laravel 项目中使用 Sanctum 实现可选身份验证。核心思路是检查请求中是否存在 API Token，如果存在，则尝试使用 Sanctum 身份验证守卫获取用户并将其设置为当前用户。这种方法允许路由在已登录用户和访客之间共享，并根据是否存在有效的 API Token 来判断用户是否已通过身份验证。

实现可选身份验证

在使用 Laravel Sanctum 进行身份验证时，有时我们需要创建一个可以被已登录用户和访客访问的路由。例如，一个展示公开信息的页面，但如果用户已登录，则可以显示一些个性化内容。 直接使用 auth:sanctum 中间件会强制要求所有访问者都提供有效的 API Token，而完全不使用身份验证则无法识别已登录用户。以下是如何实现可选身份验证的步骤：

1. 移除 auth:sanctum 中间件

   首先，确保你的路由没有应用 auth:sanctum 中间件。这是关键的一步，因为它允许未经身份验证的请求访问该路由。

   // 错误示例：不要使用 auth:sanctum 中间件
   // Route::get('optional-auth', function() { ... })->middleware('auth:sanctum');
   
   // 正确示例：不使用任何身份验证中间件
   Route::get('optional-auth', function() {
     // ...
   });

   登录后复制

2. 检查请求中是否存在 Token

   在路由处理函数中，你需要检查请求头中是否存在 API Token。Laravel 提供了 request()->bearerToken() 方法来获取 Bearer Token。

3. 尝试使用 Sanctum 身份验证守卫获取用户

   如果请求中存在 Token，则尝试使用 Auth::guard('sanctum')->user() 方法从 Sanctum 身份验证守卫中获取用户。如果 Token 有效，则会返回已身份验证的用户对象；否则，返回 null。

4. 设置当前用户

   如果成功从 Sanctum 身份验证守卫中获取了用户，则使用 Auth::setUser() 方法将其设置为当前用户。

   

   Blackink AI纹身生成

   创建类似纹身的设计，生成独特纹身

   17

   查看详情

5. 判断用户是否已通过身份验证

   最后，可以使用 Auth::check() 方法来判断用户是否已通过身份验证。如果用户已登录（即存在有效的 API Token），则返回 true；否则，返回 false。

示例代码

以下是一个完整的示例代码，展示了如何在路由中实现可选身份验证：

Route::get('optional-auth', function() {
    if (request()->bearerToken() && $user = Auth::guard('sanctum')->user()) {
        Auth::setUser($user);
    }

    $isAuthenticated = Auth::check(); // false for guest users, true if valid token present

    if ($isAuthenticated) {
        $user = Auth::user();
        // 用户已登录，执行相应的操作
        return response()->json(['message' => 'Authenticated user', 'user' => $user]);
    } else {
        // 用户未登录，执行相应的操作
        return response()->json(['message' => 'Guest user']);
    }
});

代码解释

• request()->bearerToken()：尝试从请求头中获取 Bearer Token。
• Auth::guard('sanctum')->user()：尝试使用 Sanctum 身份验证守卫获取用户。
• Auth::setUser($user)：将获取到的用户设置为当前用户。
• Auth::check()：检查用户是否已通过身份验证。
• Auth::user(): 获取当前认证的用户对象。

注意事项

• 确保你的 Laravel 项目已正确配置 Sanctum。
• 不要忘记移除 auth:sanctum 中间件。
• 在使用 Auth::setUser() 方法设置当前用户之前，必须先检查请求中是否存在 Token。
• 根据实际需求，调整路由处理函数中的逻辑。

总结

通过以上步骤，你可以使用 Laravel Sanctum 实现可选身份验证，从而创建一个可以被已登录用户和访客访问的路由。这种方法灵活且易于实现，可以满足各种不同的身份验证需求。记住，核心在于检查请求中是否存在 Token，并根据 Token 的有效性来判断用户是否已通过身份验证。

以上就是Laravel Sanctum 可选身份验证实现指南的详细内容，更多请关注php中文网其它相关文章！