如何在Laravel中实现API认证

laravel中实现api认证的首选方案是使用laravel sanctum,它轻量且适用于spa、移动应用及简单api令牌需求。1. 安装sanctum并发布配置文件和迁移表;2. 在user模型中引入hasapitokens trait;3. 使用auth:sanctum中间件保护api路由;4. 通过createtoken生成带能力的令牌并在客户端请求头中携带;5. 对spa可配置会话cookie认证方式。相比passport,sanctum更简洁,适合多数场景;而jwt、session认证和basic auth则适用于特定用例。

如何在Laravel中实现API认证

在Laravel中实现API认证,最常见也最推荐的方式是使用Laravel Sanctum。它能很好地处理单页面应用(SPA)、移动应用以及简单的API令牌认证需求,轻量且高效。如果你需要更复杂的OAuth2功能,比如允许第三方应用访问你的API,那么Laravel Passport会是你的选择。绝大多数情况下,Sanctum就能满足日常开发所需。

解决方案

要在Laravel中实现API认证,我们通常会选择Laravel Sanctum。它为SPA、移动应用和简单的API令牌提供了简洁的认证系统。

1. 安装与配置Sanctum首先,把Sanctum请到你的项目里:

composer require laravel/sanctum

然后发布其配置文件和运行数据库迁移:

php artisan vendor:publish --provider="LaravelSanctumSanctumServiceProvider"php artisan migrate

这会创建一张 personal_access_tokens 表,用来存储用户的API令牌。

2. 用户模型准备在你的 AppModelsUser 模型中,引入 HasApiTokens trait:

// app/Models/User.phpuse LaravelSanctumHasApiTokens;use IlluminateNotificationsNotifiable;use IlluminateFoundationAuthUser as Authenticatable;class User extends Authenticatable{    use HasApiTokens, Notifiable;    // ... 其他模型内容}

这个trait会为你的用户模型添加管理API令牌的方法。

3. API路由保护routes/api.php 文件中,你可以使用 auth:sanctum 中间件来保护你的API路由:

// routes/api.phpuse IlluminateHttpRequest;use IlluminateSupportFacadesRoute;Route::middleware('auth:sanctum')->get('/user', function (Request $request) {    return $request->user();});Route::post('/logout', function (Request $request) {    $request->user()->currentAccessToken()->delete();    return response()->noContent();})->middleware('auth:sanctum');// 你的其他受保护API路由Route::middleware('auth:sanctum')->group(function () {    Route::get('/projects', function () {        // ...    });    Route::post('/projects', function () {        // ...    });});

任何访问 /user/projects 路由的请求,都需要携带有效的Sanctum令牌或通过会话认证。

4. 令牌的生成与使用对于移动应用或第三方API调用,你需要为用户生成API令牌。这通常在一个认证控制器中完成:

// 例如:app/Http/Controllers/Api/AuthController.phpuse IlluminateHttpRequest;use IlluminateSupportFacadesAuth;use AppModelsUser;use IlluminateSupportFacadesHash;class AuthController extends Controller{    public function login(Request $request)    {        $request->validate([            'email' => 'required|email',            'password' => 'required',            'device_name' => 'required', // 例如:'iPhone 15 Pro'        ]);        $user = User::where('email', $request->email)->first();        if (! $user || ! Hash::check($request->password, $user->password)) {            return response()->json(['message' => '凭据不匹配'], 401);        }        // 创建令牌,可以指定能力(abilities)        $token = $user->createToken($request->device_name, ['server:update', 'server:delete'])->plainTextToken;        return response()->json(['token' => $token]);    }    public function revokeToken(Request $request)    {        // 撤销当前使用的令牌        $request->user()->currentAccessToken()->delete();        return response()->noContent();    }    public function revokeAllTokens(Request $request)    {        // 撤销用户所有令牌        $request->user()->tokens()->delete();        return response()->noContent();    }}

客户端在后续请求中,需要将这个令牌放在 Authorization 请求头的 Bearer 方案中:Authorization: Bearer YOUR_GENERATED_TOKEN

5. SPA认证 (可选但推荐)如果你在构建SPA,Sanctum还能通过会话Cookie提供认证,而无需手动管理令牌。这需要一些额外的配置:

确保你的SPA和API运行在同一个顶级域名下(例如:app.example.comapi.example.com)。在SPA中,使用Axios等HTTP客户端配置 withCredentialstrue,并确保后端CORS配置允许你的SPA域名。配置 sanctum.stateful 数组,将你的SPA域名添加到其中。确保SPA在登录时,向Laravel后端发送POST请求到 /sanctum/csrf-cookie 路由,以获取CSRF令牌,然后进行登录。

Laravel API认证,为什么Sanctum是首选?

我个人觉得,对于绝大多数我们日常会遇到的API认证场景,Sanctum简直是为我们量身定制的。它最大的魅力在于它的简洁性多功能性。你想想看,一个包就能同时搞定SPA的会话认证(就像传统的Web应用那样,用Cookie),又能搞定移动端或者第三方应用需要的API令牌认证,这多省事儿!

跟Passport比起来,Sanctum简直是轻量级的典范。Passport那套OAuth2的玩意儿,虽然强大,但它为的是解决更宏大的问题——比如你要让Google、Facebook这种第三方服务通过OAuth2协议来访问你的API。它涉及客户端管理、授权码、刷新令牌等一系列复杂流程,搭建起来就挺费劲的。而我们平时写个App后端,或者给Vue、React前端提供API,根本用不着那么重型的武器。Sanctum就是那个“小而美”的解决方案,它直接给你一个纯粹的API令牌管理能力,或者利用Laravel自带的Session机制,让SPA感觉就像在用传统的Web应用一样,省去了令牌存储、刷新等一系列前端的心智负担。

所以,除非你明确知道你的API需要支持OAuth2那种复杂的第三方授权流程,否则,直接上Sanctum,它能让你少掉很多头发。

如何在Laravel中安全地管理API令牌?

管理API令牌可不是生成一个扔给前端就完事儿了,这里面学问还挺多的,稍不留神就可能留下安全隐患。

如知AI笔记 如知AI笔记

如知笔记——支持markdown的在线笔记,支持ai智能写作、AI搜索,支持DeepseekR1满血大模型

如知AI笔记 27 查看详情 如知AI笔记

1. 令牌的生命周期与能力生成令牌时,考虑它的生命周期。如果是给一次性任务或者短期使用的,可以设置短一点的过期时间。Sanctum默认是不设过期时间的,但你可以通过在 config/sanctum.php 中设置 expiration 来控制。

更重要的是,利用Sanctum的“能力”(abilities)特性。你可以为每个令牌分配特定的权限,比如一个令牌只能读取数据,另一个才能写入。

$token = $user->createToken('admin-token', ['user:read', 'user:create', 'user:update', 'user:delete'])->plainTextToken;// 另一个令牌可能只有读取权限$readOnlyToken = $user->createToken('guest-token', ['user:read'])->plainTextToken;

然后在你的API路由或控制器中,通过 tokenCan 方法来检查:

if ($request->user()->tokenCan('user:create')) {    // 允许创建用户}

这比简单的“有权限”或“没权限”要精细得多。

2. 客户端令牌存储前端拿到令牌后,怎么存是个大问题。

Web端(SPA): 尽量避免直接存在 localStorage 里,因为它容易受到XSS攻击。更安全的做法是使用 HttpOnlyCookie。Sanctum在SPA模式下就是这么干的,它利用了Laravel的Session机制,并将Session ID存在HttpOnly Cookie中,前端无需直接操作令牌。移动端: 存储在设备的安全存储区域,比如iOS的Keychain或Android的Keystore,而不是明文存在应用沙盒里。

3. 令牌的撤销机制用户退出登录时,务必撤销当前使用的令牌。Sanctum提供了 currentAccessToken()->delete() 方法来撤销正在使用的令牌。如果用户设备丢失,或者怀疑令牌泄露,你应该提供一个接口让用户可以撤销所有已颁发的令牌($user->tokens()->delete())。这就像你手机丢了,可以在电脑上远程抹掉所有数据一样。

4. 令牌的安全性Sanctum会将令牌的哈希值存储在数据库中,而不是明文。这是基本要求。确保你的数据库连接是安全的,并且数据库本身也受到保护。

5. 速率限制对API接口进行速率限制(Rate Limiting)是防止暴力破解令牌的有效手段。Laravel自带的速率限制中间件非常好用,可以限制每个IP或每个用户在特定时间内的请求次数。

// routes/api.phpRoute::middleware(['auth:sanctum', 'throttle:60,1'])->group(function () {    Route::get('/user', function (Request $request) {        return $request->user();    });});

这表示每分钟只能请求 /user 60次。

除了Sanctum,Laravel还有哪些API认证方案,各自适用场景是什么?

除了Sanctum,Laravel生态里还有几种常见的API认证方案,每种都有它最适合的场景。

1. Laravel Passport (OAuth2)

是什么? Laravel官方提供的OAuth2服务器实现。它完全遵循OAuth2协议,可以让你轻松地为自己的API提供完整的OAuth2认证流程,包括授权码、隐式、客户端凭据和密码授权等多种模式。适用场景: 当你的API需要被第三方应用访问时,Passport是首选。比如,你想构建一个开放平台,允许其他开发者注册他们的应用,并通过OAuth2协议来获取用户授权,进而访问你的API数据。它提供了客户端管理、作用域(scopes)定义等高级功能,适合构建大型、开放的API平台。如果你只是为自己的前端或移动应用提供API,Passport可能会显得过于复杂。

2. 基于Session的认证 (Web认证)

是什么? 这是Laravel默认的Web认证方式,依赖于HTTP Session和Cookie。用户登录后,服务器会创建一个Session,并在Cookie中存储Session ID。后续请求带着这个Cookie,服务器就能识别用户。适用场景: 主要用于传统的Web应用,即前后端不分离或弱分离的项目。当你用Blade模板渲染页面,或者Vue/React应用和Laravel后端在同一个域名下,且前端每次请求都带上Cookie时,这种方式是自然的。但对于纯粹的、无状态的API(尤其是跨域或移动应用),Session认证就不太合适了,因为API通常需要无状态,不依赖服务器Session。

3. Basic Auth (HTTP基本认证)

是什么? 一种非常简单的HTTP认证方式,通过在HTTP请求头中发送用户名和密码的Base64编码字符串进行认证。适用场景: 通常用于内部API调试低安全性要求的场景。它简单易实现,但因为每次请求都发送明文(虽然是Base64编码,但很容易解码)的用户名和密码,所以必须在HTTPS环境下使用,否则极不安全。不适合公开或高安全性的API。

4. 第三方JWT包 (如 tymondesigns/jwt-auth)

是什么? JSON Web Token(JWT)是一种开放标准(RFC 7519),定义了一种紧凑且自包含的方式,用于在各方之间安全地传输信息作为JSON对象。Laravel本身没有内置JWT认证,但有非常流行的第三方包如 tymondesigns/jwt-auth适用场景: 在Sanctum出现之前,JWT在无状态API认证中非常流行。它适用于需要完全无状态的API,并且可能需要跨多个服务共享认证状态的场景。JWT令牌包含用户身份信息,并经过签名,服务器无需查询数据库即可验证令牌的有效性。然而,JWT的令牌撤销相对复杂(因为它是无状态的),通常需要额外的黑名单机制。Sanctum的API令牌模式在很多方面可以替代JWT,并且与Laravel的集成度更高。

选择哪种方案,最终还是要看你的项目需求和安全考量。Sanctum的出现,确实让大多数Laravel API认证变得简单而高效,但理解其他方案的特点,能帮助你在遇到特定场景时做出更明智的决策。

以上就是如何在Laravel中实现API认证的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/425900.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年11月7日 11:35:34
下一篇 2025年11月7日 11:35:48

相关推荐

  • Uniapp 中如何不拉伸不裁剪地展示图片?

    灵活展示图片:如何不拉伸不裁剪 在界面设计中,常常需要以原尺寸展示用户上传的图片。本文将介绍一种在 uniapp 框架中实现该功能的简单方法。 对于不同尺寸的图片,可以采用以下处理方式: 极端宽高比:撑满屏幕宽度或高度,再等比缩放居中。非极端宽高比:居中显示,若能撑满则撑满。 然而,如果需要不拉伸不…

    2025年12月24日
    400
  • PC端H5项目如何实现适配:流式布局、响应式设计和两套样式?

    PC端的适配方案及PC与H5兼顾的实现方案探讨 在开发H5项目时,常用的屏幕适配方案是postcss-pxtorem或postcss-px-to-viewport,通常基于iPhone 6标准作为设计稿。但对于PC端网项目,处理不同屏幕大小需要其他方案。 PC端屏幕适配方案 PC端屏幕适配一般采用流…

    2025年12月24日
    300
  • 如何让小说网站控制台显示乱码,同时网页内容正常显示?

    如何在不影响用户界面的情况下实现控制台乱码? 当在小说网站上下载小说时,大家可能会遇到一个问题:网站上的文本在网页内正常显示,但是在控制台中却是乱码。如何实现此类操作,从而在不影响用户界面(UI)的情况下保持控制台乱码呢? 答案在于使用自定义字体。网站可以通过在服务器端配置自定义字体,并通过在客户端…

    2025年12月24日
    800
  • 如何在地图上轻松创建气泡信息框?

    地图上气泡信息框的巧妙生成 地图上气泡信息框是一种常用的交互功能,它简便易用,能够为用户提供额外信息。本文将探讨如何借助地图库的功能轻松创建这一功能。 利用地图库的原生功能 大多数地图库,如高德地图,都提供了现成的信息窗体和右键菜单功能。这些功能可以通过以下途径实现: 高德地图 JS API 参考文…

    2025年12月24日
    400
  • 如何使用 scroll-behavior 属性实现元素scrollLeft变化时的平滑动画?

    如何实现元素scrollleft变化时的平滑动画效果? 在许多网页应用中,滚动容器的水平滚动条(scrollleft)需要频繁使用。为了让滚动动作更加自然,你希望给scrollleft的变化添加动画效果。 解决方案:scroll-behavior 属性 要实现scrollleft变化时的平滑动画效果…

    2025年12月24日
    000
  • 如何为滚动元素添加平滑过渡,使滚动条滑动时更自然流畅?

    给滚动元素平滑过渡 如何在滚动条属性(scrollleft)发生改变时为元素添加平滑的过渡效果? 解决方案:scroll-behavior 属性 为滚动容器设置 scroll-behavior 属性可以实现平滑滚动。 html 代码: click the button to slide right!…

    2025年12月24日
    500
  • 如何选择元素个数不固定的指定类名子元素?

    灵活选择元素个数不固定的指定类名子元素 在网页布局中,有时需要选择特定类名的子元素,但这些元素的数量并不固定。例如,下面这段 html 代码中,activebar 和 item 元素的数量均不固定: *n *n 如果需要选择第一个 item元素,可以使用 css 选择器 :nth-child()。该…

    2025年12月24日
    200
  • 使用 SVG 如何实现自定义宽度、间距和半径的虚线边框?

    使用 svg 实现自定义虚线边框 如何实现一个具有自定义宽度、间距和半径的虚线边框是一个常见的前端开发问题。传统的解决方案通常涉及使用 border-image 引入切片图片,但是这种方法存在引入外部资源、性能低下的缺点。 为了避免上述问题,可以使用 svg(可缩放矢量图形)来创建纯代码实现。一种方…

    2025年12月24日
    100
  • 如何让“元素跟随文本高度,而不是撑高父容器?

    如何让 元素跟随文本高度,而不是撑高父容器 在页面布局中,经常遇到父容器高度被子元素撑开的问题。在图例所示的案例中,父容器被较高的图片撑开,而文本的高度没有被考虑。本问答将提供纯css解决方案,让图片跟随文本高度,确保父容器的高度不会被图片影响。 解决方法 为了解决这个问题,需要将图片从文档流中脱离…

    2025年12月24日
    000
  • 为什么 CSS mask 属性未请求指定图片?

    解决 css mask 属性未请求图片的问题 在使用 css mask 属性时,指定了图片地址,但网络面板显示未请求获取该图片,这可能是由于浏览器兼容性问题造成的。 问题 如下代码所示: 立即学习“前端免费学习笔记(深入)”; icon [data-icon=”cloud”] { –icon-cl…

    2025年12月24日
    200
  • 如何使用 vue-color 创建交互式颜色渐变页面?

    如何创建交互式颜色渐变页面? 实现交互式颜色渐变页面可以通过利用第三方库来简化开发流程。 推荐解决方案: vue-color 立即学习“前端免费学习笔记(深入)”; vue-color是一个vue.js库,提供了一个功能强大的调色板组件。它允许你轻松创建和管理颜色渐变。 特性: 颜色选择器:选择单一…

    2025年12月24日
    200
  • 如何利用 CSS 选中激活标签并影响相邻元素的样式?

    如何利用 css 选中激活标签并影响相邻元素? 为了实现激活标签影响相邻元素的样式需求,可以通过 :has 选择器来实现。以下是如何具体操作: 对于激活标签相邻后的元素,可以在 css 中使用以下代码进行设置: li:has(+li.active) { border-radius: 0 0 10px…

    2025年12月24日
    100
  • 如何模拟Windows 10 设置界面中的鼠标悬浮放大效果?

    win10设置界面的鼠标移动显示周边的样式(探照灯效果)的实现方式 在windows设置界面的鼠标悬浮效果中,光标周围会显示一个放大区域。在前端开发中,可以通过多种方式实现类似的效果。 使用css 使用css的transform和box-shadow属性。通过将transform: scale(1.…

    2025年12月24日
    200
  • 为什么我的 Safari 自定义样式表在百度页面上失效了?

    为什么在 Safari 中自定义样式表未能正常工作? 在 Safari 的偏好设置中设置自定义样式表后,您对其进行测试却发现效果不同。在您自己的网页中,样式有效,而在百度页面中却失效。 造成这种情况的原因是,第一个访问的项目使用了文件协议,可以访问本地目录中的图片文件。而第二个访问的百度使用了 ht…

    2025年12月24日
    000
  • 如何用前端实现 Windows 10 设置界面的鼠标移动探照灯效果?

    如何在前端实现 Windows 10 设置界面中的鼠标移动探照灯效果 想要在前端开发中实现 Windows 10 设置界面中类似的鼠标移动探照灯效果,可以通过以下途径: CSS 解决方案 DEMO 1: Windows 10 网格悬停效果:https://codepen.io/tr4553r7/pe…

    2025年12月24日
    000
  • 使用CSS mask属性指定图片URL时,为什么浏览器无法加载图片?

    css mask属性未能加载图片的解决方法 使用css mask属性指定图片url时,如示例中所示: mask: url(“https://api.iconify.design/mdi:apple-icloud.svg”) center / contain no-repeat; 但是,在网络面板中却…

    2025年12月24日
    000
  • 如何用CSS Paint API为网页元素添加时尚的斑马线边框?

    为元素添加时尚的斑马线边框 在网页设计中,有时我们需要添加时尚的边框来提升元素的视觉效果。其中,斑马线边框是一种既醒目又别致的设计元素。 实现斜向斑马线边框 要实现斜向斑马线间隔圆环,我们可以使用css paint api。该api提供了强大的功能,可以让我们在元素上绘制复杂的图形。 立即学习“前端…

    2025年12月24日
    000
  • 图片如何不撑高父容器?

    如何让图片不撑高父容器? 当父容器包含不同高度的子元素时,父容器的高度通常会被最高元素撑开。如果你希望父容器的高度由文本内容撑开,避免图片对其产生影响,可以通过以下 css 解决方法: 绝对定位元素: .child-image { position: absolute; top: 0; left: …

    2025年12月24日
    000
  • 如何利用 vue-color 库打造交互式色彩渐变页面?

    打造交互性前端:色彩渐变页面的制作方法 在前端开发中,色彩渐变页面和交互式元素深受设计师和开发人员的欢迎。本文将探讨如何利用 vue-color 库轻松实现这样的页面。 使用 vue-color 库构建调色板 vue-color 是一个 vue.js 库,可用于创建可定制的调色板。其基本功能包括: …

    2025年12月24日
    300
  • 如何使用前端技术创建交互式颜色渐变页面?

    如何创建交互式颜色渐变页面? 当您希望在前端界面实现颜色渐变效果并实现交互功能时,可以使用以下方法: 解决方案: 1. 使用 vue-color 库 vue-color 库是一个功能强大的 vue.js 库,可用于创建色板和处理颜色操作。它可以帮助您轻松实现颜色渐变效果,如下所示: 立即学习“前端免…

    好文分享 2025年12月24日
    000

发表回复

登录后才能评论
关注微信