laravel JWTAuth實現api接口鑒權(基礎篇)

本文轉載自查看原文 2019-06-05 14:37 3830 laravel

官網：https://jwt-auth.readthedocs.io
參考：https://learnku.com/articles/10885/full-use-of-jwt#99529f

1、token是什么

token 翻譯為令牌，就是鑒別身份的憑據，類似於身份證；
token 本質就是一大串字符串，最常用的場景就是接口對接的鑒權。
token 通過一次登錄驗證，得到一個鑒權字符串，隨后其它的請求每次都攜帶這個鑒權字符串，即可完成鑒權。

2、jwt是什么

jwt 全稱json web token（翻譯為數據網絡令牌）
jwt 是一種規范化的 token，讓數據在網絡中安全傳輸。
jwt 使用場景：

無狀態的 RESTful API
SSO 單點登錄

3、jwt安裝&配置

3.1、通過composer安裝

//安裝1.0以上版本

composer require tymon/jwt-auth 1.*@rc

3.2、配置

添加配置（config/app.php）

//providers元素中添加：
Tymon\JWTAuth\Providers\LaravelServiceProvider::class,

//aliases元素中添加：
'JWTAuth' => Tymon\JWTAuth\Facades\JWTAuth::class,
'JWTFactory' => Tymon\JWTAuth\Facades\JWTFactory::class,

發布配置

php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\LaravelServiceProvider"
//會自動生成一個配置文件：config/jwt.php

3.3、生成加密密鑰

php artisan jwt:secret
//.env 文件下生成一個加密密鑰

3.4、更新生成token模型

如果使用默認的 User 表來生成 token，app\user.php

實現JWTSubject接口，實現getJWTIdentifier()和getJWTCustomClaims()方法

use Tymon\JWTAuth\Contracts\JWTSubject;

class User extends Authenticatable implements JWTSubject
{
    ...
    public function getJWTIdentifier()
    {
        return $this->getKey();
    }
    
    public function getJWTCustomClaims()
    {
        return [];
    }
}

3.5.修改 auth.php

config/auth.php

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

4、jwt准備

4.1、新建控制器

php artisan make:controller AuthController

4.2、控制器添加方法

官方案例：

login登錄，me獲取用戶信息，logout退出登錄，refresh刷新token，respondWithToken返回token

<?php
namespace App\Http\Controllers;

class AuthController extends Controller
{
    /**
     * Create a new AuthController instance.
     * 要求附帶email和password（數據來源users表）
     * @return void
     */
    public function __construct()
    {
        // 這里額外注意了：官方文檔樣例中只除外了『login』
        // 這樣的結果是，token 只能在有效期以內進行刷新，過期無法刷新
        // 如果把 refresh 也放進去，token 即使過期但仍在刷新期以內也可刷新
        // 不過刷新一次作廢
        $this->middleware('auth:api', ['except' => ['login']]);
        // 另外關於上面的中間件，官方文檔寫的是『auth:api』
        // 但是我推薦用 『jwt.auth』，效果是一樣的，但是有更加豐富的報錯信息返回
    }

    /**
     * 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(auth('api')->user());
    }

    /**
     * Log the user out (Invalidate the token).
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function logout()
    {
        auth('api')->logout();

        return response()->json(['message' => 'Successfully logged out']);
    }

    /**
     * Refresh a token.
     * 刷新token，如果開啟黑名單，以前的token便會失效。
     * 值得注意的是用上面的getToken再獲取一次Token並不算做刷新，兩次獲得的Token是並行的，即兩個都可用。
     * @return \Illuminate\Http\JsonResponse
     */
    public function refresh()
    {
        return $this->respondWithToken(auth('api')->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' => auth('api')->factory()->getTTL() * 60
        ]);
    }
}

4.3、添加路由

routes/api.php

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

4.4、添加users表數據

可以注冊是如何添加的，看一下密碼的加密方式

App\Http\Controllers\Auth\RegisterController

...
protected function create(array $data)
{
    return User::create([
        'name' => $data['name'],
        'email' => $data['email'],
        'password' => Hash::make($data['password']),
    ]);
}

添加一條用戶數據

routes/web.php

Route::get('/register', function(){
    \App\User::create([
        'name' => 'bb',
        'email' => 'test@bb.com',
        'password' => \Illuminate\Support\Facades\Hash::make('123456'),
    ]);
});