使用 Laravel Sanctum 实现可选身份验证

本文将介绍如何在 Laravel 项目中使用 Sanctum 实现可选的身份验证。通过该方法，你可以创建一个既允许已登录用户（通过 API Token）访问，也允许未登录用户（访客）访问的路由。我们将展示如何检查请求中是否存在 Token，并根据 Token 验证结果来确定当前用户状态，从而灵活地控制访问权限。

实现可选身份验证

在某些场景下，我们需要创建一个允许匿名用户和已认证用户访问的 API 接口。例如，一个展示商品信息的接口，即使未登录的用户也可以查看，但登录用户可以查看更多个性化信息。Laravel Sanctum 默认情况下需要身份验证，但我们可以通过一些技巧来实现可选的身份验证。

核心思路是：

1. 不使用 auth:sanctum 中间件： 避免强制要求身份验证。
2. 检查请求头中的 Token： 判断请求是否携带 API Token。
3. 手动验证 Token 并设置用户： 如果存在 Token，尝试使用 Sanctum 的认证守卫来验证 Token，并手动设置当前用户。

以下是具体的实现步骤：

1. 定义路由

首先，定义一个路由，并确保不使用 auth:sanctum 中间件：

Route::get('optional-auth', function () {
    // 身份验证逻辑
    if (request()->bearerToken() && $user = Auth::guard('sanctum')->user()) {
        Auth::setUser($user);
    }

    return Auth::check(); // false for guest users, true if valid token present
});

2. 实现身份验证逻辑

在路由的回调函数中，添加以下代码：

if (request()->bearerToken() && $user = Auth::guard('sanctum')->user()) {
    Auth::setUser($user);
}

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

这段代码的逻辑如下：

Blackink AI纹身生成

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

17

查看详情

• request()->bearerToken()：检查请求头中是否存在 Bearer Token（API Token）。
• Auth::guard('sanctum')->user()：尝试使用 sanctum 认证守卫来验证 Token 并获取用户。如果 Token 无效，则返回 null。
• Auth::setUser($user)：如果 Token 有效，则手动设置当前用户。
• Auth::check()：返回当前用户是否已认证的状态。如果用户已认证，则返回 true，否则返回 false。

3. 测试

现在，你可以使用以下方式测试你的 API 接口：

• 携带 API Token 的请求： GET /optional-auth，并在请求头中添加 Authorization: Bearer {your_api_token}。Auth::check() 将返回 true。
• 不携带 API Token 的请求： GET /optional-auth。Auth::check() 将返回 false。

完整示例

以下是一个完整的示例，展示了如何使用可选身份验证来获取用户信息：

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

    if (Auth::check()) {
        $user = Auth::user();
        return response()->json([
            'message' => 'Authenticated user',
            'user' => $user,
        ]);
    } else {
        return response()->json([
            'message' => 'Guest user',
        ]);
    }
});

注意事项

• 确保你已经正确配置了 Laravel Sanctum。
• 在实际应用中，你可能需要根据用户是否已认证来执行不同的逻辑。例如，你可以根据用户是否已认证来返回不同的数据。
• 虽然这种方法允许可选的身份验证，但仍然需要确保对敏感数据进行适当的保护。

总结

通过上述方法，你可以轻松地在 Laravel 项目中使用 Sanctum 实现可选的身份验证。这种方法可以让你创建更加灵活和易于使用的 API 接口，从而满足不同的业务需求。记住，不要使用 auth:sanctum 中间件，手动检查 Token 并设置用户。

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