laravel安裝jwt-auth及驗證（實例）

laravel 安裝jwt-auth及驗證

1、使用composer安裝jwt，cmd到項目文件夾中；

composer require tymon/jwt-auth 1.0.*（這裡版本號根據自己的需要寫）

安裝jwt ，參考官方文檔https://jwt-auth.readthedocs.io/en/docs/laravel-installation/

2、如果laravel版本低於5.4

打開根目錄下的config/app.php

在'providers'數組裡加上Tymon\JWTAuth\Providers\LaravelServiceProvider::class,

'providers' => [ ... Tymon\JWTAuth\Providers\LaravelServiceProvider::class,]

3、在 config 下增加一個 jwt.php 的配置文件

php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\LaravelServiceProvider"

4、在 .env 文件下生成一個加密密鑰，如：JWT_SECRET=foobar

php artisan jwt:secret

5、在user模型中寫入下列代碼

<?php
namespace App\Model;
use Tymon\JWTAuth\Contracts\JWTSubject;
use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;
class User extends Authenticatable implements JWTSubject
{
 // Rest omitted for brevity
 protected $table="user";
 public $timestamps = false;
 public function getJWTIdentifier()
 {
 return $this->getKey();
 }
 public function getJWTCustomClaims()
 {
 return [];
 }
}

6、註冊兩個 Facade

config/app.php

'aliases' => [
 ...
 // 添加以下兩行
 'JWTAuth' => 'Tymon\JWTAuth\Facades\JWTAuth',
 'JWTFactory' => 'Tymon\JWTAuth\Facades\JWTFactory',
],

7、修改 auth.php

config/auth.php

'guards' => [
 'web' => [
 'driver' => 'session',
 'provider' => 'users',
 ],
 'api' => [
 'driver' => 'jwt',      // 原來是 token 改成jwt
 'provider' => 'users',
 ],
],

8、註冊路由

Route::group([
 'prefix' => 'auth'
], function ($router) {
 $router->post('login', 'AuthController@login');
 $router->post('logout', 'AuthController@logout');
});

9、創建token控制器

php artisan make:controller AuthController

代碼如下：

<?php
namespace App\Http\Controllers;
use App\Model\User;
use Illuminate\Http\Request;
use Tymon\JWTAuth\Facades\JWTAuth;
class AuthController extends Controller
{
 /**
 * Create a new AuthController instance.
 *
 * @return void
 */
 public function __construct()
 {
 $this->middleware('auth:api', ['except' => ['login']]);
 }
 /**
 * Get a JWT via given credentials.
 *
 * @return \Illuminate\Http\JsonResponse
 */
 public function login()
 {
 $credentials = request(['email', 'password']);
 if (! $token = auth('api')->attempt($credentials)) {
 return response()->json(['error' => 'Unauthorized'], 401);
 }
 return $this->respondWithToken($token);
 }
 /**
 * Get the authenticated User.
 *
 * @return \Illuminate\Http\JsonResponse
 */
 public function me()
 {
 return response()->json(JWTAuth::parseToken()->touser());
 }
 /**
 * Log the user out (Invalidate the token).
 *
 * @return \Illuminate\Http\JsonResponse
 */
 public function logout()
 {
 JWTAuth::parseToken()->invalidate();
 return response()->json(['message' => 'Successfully logged out']);
 }
 /**
 * Refresh a token.
 *
 * @return \Illuminate\Http\JsonResponse
 */
 public function refresh()
 {
 return $this->respondWithToken(JWTAuth::parseToken()->refresh());
 }
 /**
 * Get the token array structure.
 *
 * @param  string $token
 *
 * @return \Illuminate\Http\JsonResponse
 */
 protected function respondWithToken($token)
 {
 return response()->json([
 'access_token' => $token,
 'token_type' => 'bearer',
 'expires_in' => JWTAuth::factory()->getTTL() * 60
 ]);
 }
}

註意：attempt 一直返回false，是因為password被加密了，使用bcrypt或者password_hash加密後就可以了

10、驗證token獲取用戶信息

有兩種使用方法：

加到 url 中：?token=你的token

加到 header 中，建議用這種，因為在 https 情況下更安全：Authorization:Bearer 你的token

11、首先使用artisan命令生成一個中間件，我這裡命名為RefreshToken.php，創建成功後，需要繼承一下JWT的BaseMiddleware

代碼如下：

<?php
namespace App\Http\Middleware;
use Auth;
use Closure;
use Tymon\JWTAuth\Exceptions\JWTException;
use Tymon\JWTAuth\Http\Middleware\BaseMiddleware;
use Tymon\JWTAuth\Exceptions\TokenExpiredException;
use Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException;
// 註意，我們要繼承的是 jwt 的 BaseMiddleware
class RefreshToken extends BaseMiddleware
{
 /**
 * Handle an incoming request.
 *
 * @ param  \Illuminate\Http\Request $request
 * @ param  \Closure $next
 *
 * @ throws \Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException
 *
 * @ return mixed
 */
 public function handle($request, Closure $next)
 {
 // 檢查此次請求中是否帶有 token，如果沒有則拋出異常。
 $this->checkForToken($request);
 // 使用 try 包裹，以捕捉 token 過期所拋出的 TokenExpiredException  異常
 try {
 // 檢測用戶的登錄狀態，如果正常則通過
 if ($this->auth->parseToken()->authenticate()) {
 return $next($request);
 }
 throw new UnauthorizedHttpException('jwt-auth', '未登錄');
 } catch (TokenExpiredException $exception) {
 // 此處捕獲到了 token 過期所拋出的 TokenExpiredException 異常，我們在這裡需要做的是刷新該用戶的 token 並將它添加到響應頭中
 try {
 // 刷新用戶的 token
 $token = $this->auth->refresh();
 // 使用一次性登錄以保證此次請求的成功
 Auth::guard('api')->onceUsingId($this->auth->manager()->getPayloadFactory()->buildClaimsCollection()->toPlainArray()['sub']);
 } catch (JWTException $exception) {
 // 如果捕獲到此異常，即代表 refresh 也過期了，用戶無法刷新令牌，需要重新登錄。
 throw new UnauthorizedHttpException('jwt-auth', $exception->getMessage());
 }
 }
 // 在響應頭中返回新的 token
 return $this->setAuthenticationHeader($next($request), $token);
 }
}

這裡主要需要說的就是在token進行刷新後，不但需要將token放在返回頭中，最好也將請求頭中的token進行置換，因為刷新過後，請求頭中的token就已經失效了，如果介面內的業務邏輯使用到了請求頭中的token，那麼就會產生問題。

這裡使用

$request->headers->set('Authorization','Bearer '.$token);

將token在請求頭中刷新。

創建並且寫完中間件後，只要將中間件註冊，並且在App\Exceptions\Handler.php內加上一些異常處理就ok了。

12、kernel.php文件中

$routeMiddleware 添加中間件配置

'RefreshToken' => \App\Http\Middleware\RefreshToken::class,

13、添加路由

Route::group(['prefix' => 'user'],function($router) {
 $router->get('userInfo','UserController@userInfo')->middleware('RefreshToken');
});

在控制器中通過 JWTAuth::user();就可以獲取用戶信息

更多PHP內容請訪問：

騰訊T3-T4標準精品PHP架構師教程目錄大全，只要你看完保證薪資上升一個臺階（持續更新）