Larave框架通過(guò)sanctum進(jìn)行API鑒權(quán)詳解
目標(biāo)
1.使用laravel框架進(jìn)行用戶的登錄,注冊(cè),認(rèn)證
2.前后端分離的情況下,用戶請(qǐng)求接口,使用API token進(jìn)行認(rèn)證
步驟
安裝啟動(dòng)
composer create-project laravel/laravel example-app
cd example-app
php artisan serve
此時(shí),通過(guò)訪問(wèn)http://127.0.0.1:8000就可以看到訪問(wèn)成功了
安裝擴(kuò)展包
接下來(lái)安裝laravel官方的擴(kuò)展包Sanctum
,以達(dá)到目標(biāo)
composer require laravel/sanctum
接下來(lái),你需要使用 vendor:publish Artisan 命令發(fā)布 Sanctum 的配置和遷移文件。Sanctum 的配置文件將會(huì)保存在 config 文件夾中:
php artisan vendor:publish --provider="Laravel\Sanctum\SanctumServiceProvider"
修改配置文件
然后需要修改.env文件文件里面的數(shù)據(jù)庫(kù)配置,改為:
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=caixin
DB_USERNAME=root
DB_PASSWORD=root
數(shù)據(jù)庫(kù)遷移
最后,您應(yīng)該運(yùn)行數(shù)據(jù)庫(kù)遷移。 Sanctum 將創(chuàng)建一個(gè)數(shù)據(jù)庫(kù)表來(lái)存儲(chǔ) API 令牌:
php artisan migrate
接下來(lái),如果您想利用 Sanctum 對(duì) SPA 進(jìn)行身份驗(yàn)證,您應(yīng)該將 Sanctum 的中間件添加到您應(yīng)用的 app/Http/Kernel.php 文件中的 api 中間件組中:
'api' => [ \Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class, 'throttle:api', \Illuminate\Routing\Middleware\SubstituteBindings::class, ],
此時(shí)查看app/Models/User.php
文件,User 模型應(yīng)使用 Laravel\Sanctum\HasApiTokens trait:
use Laravel\Sanctum\HasApiTokens; class User extends Authenticatable { use HasApiTokens, HasFactory, Notifiable; }
模擬數(shù)據(jù)
此時(shí),在數(shù)據(jù)庫(kù)中的user表中隨便加入一條數(shù)據(jù)
INSERT INTO `users` (`id`, `name`, `email`, `email_verified_at`, `password`, `remember_token`, `created_at`, `updated_at`) VALUES (1, 'java0904', '2954245@qq.com', NULL, '', NULL, NULL, NULL);
添加訪問(wèn)路由
此時(shí)在routes/api.php
中配置路由,來(lái)獲取token
Route::middleware('auth:sanctum')->get('/user', function (Request $request) { return $request->user(); }); Route::post('/tokens/create', function (Request $request) { $user = \App\Models\User::find(1); 模擬登陸,此時(shí),會(huì)將用戶的session存儲(chǔ),但是實(shí)際通過(guò)API認(rèn)證的時(shí)候,此處用不到 // \Illuminate\Support\Facades\Auth::login($user); $token =$user->createToken($user->name); return ['token' => $token->plainTextToken]; })->withoutMiddleware('auth:sanctum');
測(cè)試獲取token
此時(shí)訪問(wèn)http://127.0.0.1:8000/api/tokens/create,就可以拿到了token
curl方式
curl -d '' http://127.0.0.1:8000/api/tokens/create {"token":"7|ZbSuwu7UBDeQjvXx6iNUCcZJKsbSSO6nctmqLjDq"}
postman測(cè)試
測(cè)試其他接口
不帶token
此時(shí),來(lái)訪問(wèn)其他API接口,都需要帶上Authorization token才能訪問(wèn)了,否則,會(huì)出現(xiàn)如下異常
帶上token
此時(shí),把token帶上,效果如下
curl測(cè)試
curl -H 'Authorization: Bearer 7|ZbSuwu7UBDeQjvXx6iNUCcZJKsbSSO6nctmqLjDq' http://local.app.com/api/user {"id":1,"name":"java0904","email":"295424581@qq.com","email_verified_at":null,"created_at":null,"updated_at":null}
postman測(cè)試
知識(shí)點(diǎn)補(bǔ)充1
app/Providers/RouteServiceProvider.php 這個(gè)文件的作用以及核心代碼分析
<?php class RouteServiceProvider extends ServiceProvider { public function boot() { $this->configureRateLimiting(); $this->routes(function () { //routes/api.php這個(gè)路由文件里面的路由,默認(rèn)都會(huì)使用api中間件,并且路由前綴是/api Route::prefix('api') // ->middleware(['api'])//這里是默認(rèn)的中間件,默認(rèn)只有一個(gè) //這里我加上了auth:sanctum這個(gè)中間件,作為全局使用,就不用為每個(gè)路由加上這個(gè)中間件了,但是獲取token的路由,需要排除這個(gè)中間件 ->middleware(['api','auth:sanctum']) ->namespace($this->namespace) ->group(base_path('routes/api.php')); //'routes/web.php'這個(gè)文件里面的路由,默認(rèn)都會(huì)使用web這個(gè)中間件 Route::middleware('web') ->namespace($this->namespace) ->group(base_path('routes/web.php')); }); } }
上面的代碼提到了兩個(gè)自帶的中間件api
和web
,他們的定義在app/Http/Kernel.php
文件中,它的核心代碼如下:
protected $middlewareGroups = [ //web中間件 'web' => [ \App\Http\Middleware\EncryptCookies::class, \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class, \Illuminate\Session\Middleware\StartSession::class, // \Illuminate\Session\Middleware\AuthenticateSession::class, \Illuminate\View\Middleware\ShareErrorsFromSession::class, //這里需要格外注意,所有/route/web.php中的路由,如果是post請(qǐng)求,都會(huì)有csrfToken的驗(yàn)證,當(dāng)然也可以手動(dòng)給排除一些路由 \App\Http\Middleware\VerifyCsrfToken::class, \Illuminate\Routing\Middleware\SubstituteBindings::class, ], //api中間件 'api' => [ \Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class, 'throttle:api', \Illuminate\Routing\Middleware\SubstituteBindings::class, ], ];
注意看web中間件中有 \App\Http\Middleware\VerifyCsrfToken::class,
這行,他的作用是所有/route/web.php中的路由,如果是post請(qǐng)求,都會(huì)有csrfToken的驗(yàn)證,當(dāng)然也可以手動(dòng)給排除一些路由
知識(shí)點(diǎn)補(bǔ)充2
/route/api.php
<?php use Illuminate\Http\Request; use Illuminate\Support\Facades\Route; /* |-------------------------------------------------------------------------- | API Routes |-------------------------------------------------------------------------- | | Here is where you can register API routes for your application. These | routes are loaded by the RouteServiceProvider within a group which | is assigned the "api" middleware group. Enjoy building your API! | */ Route::middleware('auth:sanctum')->get('/user', function (Request $request) { return $request->user(); }); Route::post('/tokens/create', function (Request $request) { $user = \App\Models\User::find(1); 模擬登陸,此時(shí),會(huì)將用戶的session存儲(chǔ),但是實(shí)際通過(guò)API認(rèn)證的時(shí)候,此處用不到 // \Illuminate\Support\Facades\Auth::login($user); $token = $user->createToken($user->name); return ['token' => $token->plainTextToken]; })->withoutMiddleware('auth:sanctum'); Route::post('/tokens/create2', function (Request $request) { //這里可以寫(xiě)自己的一些驗(yàn)證邏輯 //用戶來(lái)獲取token,必須攜帶用戶名和密碼 $password = $request->get("password"); $username = $request->get("username"); $user = \App\Models\User::where('password', $password)->where('username', $username)->first(); if (!$user) { return [ 'code' => 500, 'msg' => '用戶名密碼錯(cuò)誤' ]; } $token = $user->createToken($user->name); return ['token' => $token->plainTextToken]; })->withoutMiddleware('auth:sanctum'); //用來(lái)寫(xiě)使用session,不是前后端分離的用戶登陸 Route::post('/login', function (Request $request) { //laravel內(nèi)部的驗(yàn)證方式 if (\Illuminate\Support\Facades\Auth::attempt([ 'username' => $request->get("name"), 'password' => $request->get("password")])) { //登陸成功 //保存session } else { //登陸失敗 } })->withoutMiddleware('auth:sanctum');
代碼倉(cāng)庫(kù)
https://github.com/silk-java/laravel-sanctum-learn
到此這篇關(guān)于Larave框架通過(guò)sanctum進(jìn)行API鑒權(quán)詳解的文章就介紹到這了,更多相關(guān)Larave sanctum內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- 詳解Laravel制作API接口
- Laravel如何實(shí)現(xiàn)適合Api的異常處理響應(yīng)格式
- 在 Laravel 中動(dòng)態(tài)隱藏 API 字段的方法
- Laravel實(shí)現(xiàn)ApiToken認(rèn)證請(qǐng)求
- laravel框架 api自定義全局異常處理方法
- laravel dingo API返回自定義錯(cuò)誤信息的實(shí)例
- Laravel框架實(shí)現(xiàn)調(diào)用百度翻譯API功能示例
- PHP使Laravel為JSON REST API返回自定義錯(cuò)誤的問(wèn)題
- 讓Laravel API永遠(yuǎn)返回JSON格式響應(yīng)的方法示例
相關(guān)文章
PHP開(kāi)發(fā)的文字水印,縮略圖,圖片水印實(shí)現(xiàn)類(lèi)與用法示例
這篇文章主要介紹了PHP開(kāi)發(fā)的文字水印,縮略圖,圖片水印實(shí)現(xiàn)類(lèi)與用法,結(jié)合完整實(shí)例形式分析了php文字水印、縮略圖操作類(lèi)定義與簡(jiǎn)單使用方法,需要的朋友可以參考下2019-04-04PHP Ajax跨域問(wèn)題解決方案代碼實(shí)例
這篇文章主要介紹了PHP Ajax跨域問(wèn)題解決方案代碼實(shí)例,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-08-08PHP實(shí)現(xiàn)將瀏覽歷史頁(yè)面網(wǎng)址保存到cookie的方法
這篇文章主要介紹了PHP實(shí)現(xiàn)將瀏覽歷史頁(yè)面網(wǎng)址保存到cookie的方法,涉及php對(duì)cookie的讀取、字符串轉(zhuǎn)化及保存等技巧,需要的朋友可以參考下2015-01-01PHP導(dǎo)出MySQL數(shù)據(jù)到Excel文件(fputcsv)
經(jīng)常會(huì)碰到需要從數(shù)據(jù)庫(kù)中導(dǎo)出數(shù)據(jù)到Excel文件,用一些開(kāi)源的類(lèi)庫(kù),比如PHPExcel,確實(shí)比較容易實(shí)現(xiàn),但對(duì)大量數(shù)據(jù)的支持很不好,很容易到達(dá)PHP內(nèi)存使用上限。2011-07-07從MySQL數(shù)據(jù)庫(kù)表中取出隨機(jī)數(shù)據(jù)的代碼
這個(gè)例子是用于一個(gè)簡(jiǎn)單的應(yīng)用開(kāi)發(fā)了,意思就是把現(xiàn)在表中的所有數(shù)據(jù)我們隨機(jī)讀出來(lái)一次之后再進(jìn)行隨機(jī)保存到另一個(gè)表,從而達(dá)到了記錄隨機(jī)的功能2007-09-09