
本文介绍如何在 Laravel Sanctum 中实现可选认证,允许游客和已登录用户访问同一路由。通过检查请求中是否存在令牌,并尝试使用 Sanctum 认证守卫获取用户,我们可以根据是否存在有效的 API 令牌来判断用户是否已登录,从而实现对路由的灵活访问控制。
在某些场景下,我们需要创建一个既能被已登录用户访问,也能被游客访问的 API 路由。对于已登录用户,我们希望能够通过 API 令牌进行身份验证,并获取用户的信息。对于游客,我们则允许他们无需认证即可访问该路由。 Laravel Sanctum 默认的认证中间件 auth:sanctum 会强制要求用户进行身份验证,因此无法满足我们的需求。
下面介绍一种实现可选认证的方法,该方法的核心思想是在路由处理函数中手动检查请求中是否存在 API 令牌,并尝试使用 Sanctum 认证守卫获取用户。
实现步骤:
移除 auth:sanctum 中间件: 不要在需要可选认证的路由上使用 auth:sanctum 中间件。
在路由处理函数中进行认证检查: 在路由处理函数中,首先检查请求头中是否存在 API 令牌。如果存在,则尝试使用 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});
代码解释:
request()->bearerToken(): 获取请求头中的 Bearer Token (API 令牌)。Auth::guard(‘sanctum’)->user(): 使用 Sanctum 认证守卫尝试获取已认证的用户。如果 API 令牌有效,则返回用户对象;否则返回 null。Auth::setUser($user): 将获取到的用户对象设置为当前用户。Auth::check(): 检查当前用户是否已认证。如果用户已认证,则返回 true;否则返回 false。
示例:
假设我们有一个名为 optional-auth 的路由,用于获取用户信息。如果用户已登录,则返回用户 ID;如果用户未登录,则返回 null。
Route::get('optional-auth', function () { if (request()->bearerToken() && $user = Auth::guard('sanctum')->user()) { Auth::setUser($user); } if (Auth::check()) { return Auth::id(); // 返回用户 ID } else { return null; // 返回 null }});
注意事项:
确保已正确配置 Laravel Sanctum,并生成了 API 令牌。该方法只适用于 API 路由。如果需要更复杂的权限控制,可以结合使用 Laravel 的授权功能。bearerToken() 方法需要 Authorization 请求头,格式为 Bearer {token}。
总结:
通过手动检查请求中的 API 令牌,并使用 Sanctum 认证守卫获取用户,我们可以轻松实现 Laravel Sanctum 中的可选认证。这种方法允许我们创建既能被已登录用户访问,也能被游客访问的 API 路由,从而满足不同的业务需求。
以上就是Laravel Sanctum 实现可选认证:允许游客和登录用户访问同一路由的详细内容,更多请关注创想鸟其它相关文章!
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1322025.html
微信扫一扫
支付宝扫一扫