第Larave框架通過sanctum進行API鑒權(quán)詳解目錄目標(biāo)步驟安裝啟動安裝擴展包修改配置文件數(shù)據(jù)庫遷移模擬數(shù)據(jù)添加訪問路由測試獲取tokenpostman測試測試其他接口知識點補充1知識點補充2代碼倉庫

目標(biāo)

1.使用laravel框架進行用戶的登錄，注冊，認證

2.前后端分離的情況下，用戶請求接口，使用APItoken進行認證

步驟

安裝啟動

composercreate-projectlaravel/laravelexample-app

cdexample-app

phpartisanserve

此時，通過訪問:8000就可以看到訪問成功了

安裝擴展包

接下來安裝laravel官方的擴展包Sanctum，以達到目標(biāo)

composerrequirelaravel/sanctum

接下來，你需要使用vendor:publishArtisan命令發(fā)布Sanctum的配置和遷移文件。Sanctum的配置文件將會保存在config文件夾中：

phpartisanvendor:publish--provider=Laravel\Sanctum\SanctumServiceProvider

修改配置文件

然后需要修改.env文件文件里面的數(shù)據(jù)庫配置，改為：

DB_CONNECTION=mysql

DB_HOST=

DB_PORT=3306

DB_DATABASE=caixin

DB_USERNAME=root

DB_PASSWORD=root

數(shù)據(jù)庫遷移

最后，您應(yīng)該運行數(shù)據(jù)庫遷移。Sanctum將創(chuàng)建一個數(shù)據(jù)庫表來存儲API令牌：

phpartisanmigrate

接下來，如果您想利用Sanctum對SPA進行身份驗證，您應(yīng)該將Sanctum的中間件添加到您應(yīng)用的app/Http/Kernel.php文件中的api中間件組中：

'api'=[

\Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class,

'throttle:api',

\Illuminate\Routing\Middleware\SubstituteBindings::class,

此時查看app/Models/User.php文件，User模型應(yīng)使用Laravel\Sanctum\HasApiTokenstrait：

useLaravel\Sanctum\HasApiTokens;

classUserextendsAuthenticatable

useHasApiTokens,HasFactory,Notifiable;

模擬數(shù)據(jù)

此時，在數(shù)據(jù)庫中的user表中隨便加入一條數(shù)據(jù)

INSERTINTO`users`(`id`,`name`,`email`,`email_verified_at`,`password`,`remember_token`,`created_at`,`updated_at`)

VALUES

(1,'java0904','2954245@',NULL,'',NULL,NULL,NULL);

添加訪問路由

此時在routes/api.php中配置路由，來獲取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);

模擬登陸,此時，會將用戶的session存儲，但是實際通過API認證的時候，此處用不到

//\Illuminate\Support\Facades\Auth::login($user);

$token=$user-createToken($user-name);

return['token'=$token-plainTextToken];

})-withoutMiddleware('auth:sanctum');

測試獲取token

此時訪問:8000/api/tokens/create，就可以拿到了token

curl方式

curl-d'':8000/api/tokens/create

{"token":"7|ZbSuwu7UBDeQjvXx6iNUCcZJKsbSSO6nctmqLjDq"}

postman測試

測試其他接口

不帶token

此時，來訪問其他API接口，都需要帶上Authorizationtoken才能訪問了，否則，會出現(xiàn)如下異常

帶上token

此時，把token帶上，效果如下

curl測試

curl-H'Authorization:Bearer7|ZbSuwu7UBDeQjvXx6iNUCcZJKsbSSO6nctmqLjDq'/api/user

{"id":1,"name":"java0904","email":"295424581@","email_verified_at":null,"created_at":null,"updated_at":null}

postman測試

知識點補充1

app/Providers/RouteServiceProvider.php這個文件的作用以及核心代碼分析

php

classRouteServiceProviderextendsServiceProvider

publicfunctionboot()

$this-configureRateLimiting();

$this-routes(function(){

//routes/api.php這個路由文件里面的路由，默認都會使用api中間件，并且路由前綴是/api

Route::prefix('api')

//-middleware(['api'])//這里是默認的中間件，默認只有一個

//這里我加上了auth:sanctum這個中間件，作為全局使用，就不用為每個路由加上這個中間件了，但是獲取token的路由，需要排除這個中間件

-middleware(['api','auth:sanctum'])

-namespace($this-namespace)

-group(base_path('routes/api.php'));

//'routes/web.php'這個文件里面的路由，默認都會使用web這個中間件

Route::middleware('web')

-namespace($this-namespace)

-group(base_path('routes/web.php'));

}

上面的代碼提到了兩個自帶的中間件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請求，都會有csrfToken的驗證，當(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中間件中有\(zhòng)App\Http\Middleware\VerifyCsrfToken::class,

這行，他的作用是所有/route/web.php中的路由，如果是post請求，都會有csrfToken的驗證，當(dāng)然也可以手動給排除一些路由

知識點補充2

/route/api.php

php

useIlluminate\Http\Request;

useIlluminate\Support\Facades\Route;

|--------------------------------------------------------------------------

|APIRoutes

|--------------------------------------------------------------------------

|HereiswhereyoucanregisterAPIroutesforyourapplication.These

|routesareloadedbytheRouteServiceProviderwithinagroupwhich

|isassignedthe"api"middlewaregroup.EnjoybuildingyourAPI!

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);

模擬登陸,此時，會將用戶的session存儲，但是實際通過API認證的時候，此處用不到

//\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){

//這里可以寫自己的一些驗證邏輯

//用戶來獲取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'='用戶名密碼錯誤'

$token=$user-createToken($user-name);

return['token'=$token-plainTextToken];

})-withoutMiddleware('auth:sanctum');

//用來寫使用session，不是前后端分離的用戶登陸

Route::post('/login',function(Request$requ