Laravel 6.0 JWT教學

• 首先可以參考此篇建立Laravel 6 專案

Laravel 6 專案建置教學與使用

• 安裝JWT
  請先確認進入到專案之根目錄底下。注意！ tymondesigns/jwt-auth套件本為1.0.0-rc.5，該版本為更新支援至laravel 6。

composer require tymon/jwt-auth "1.0.0-rc.5"

都準備好之後，就可以進入JWT建置的章節了！

此篇教學參照該套件 tymondesigns/jwt-auth 之官方文件網站，來建置並使用Postman來戳API。

• 新增服務提供者(Service Provider)
  新增 service provider 至 config/app.php 檔案中之 providers 陣列當中。

'providers' => [
...
/*
* Package Service Providers...
*/
+  Tymon\JWTAuth\Providers\LaravelServiceProvider::class,
]

• 發行此服務提供設定 (Publish the config)

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

這時候應該會新增一個 config/jwt.php 的檔案，裡面放置jwt的基本設定。

• 產生私鑰(Generate secret key)

php artisan jwt:secret

做完後會更新 .env 檔案，並新增或修改 JWT_SECRET=secret_code_here

上面的基本設定都完成以後，接下來就是快速的開始：

• 更新使用者模型(User model)

這邊的話，我們將在 app/Users.php 來實作 Tymon\JWTAuth\Contracts\JWTSubject 並實作該介面之 getJWTIdentifier() 和 getJWTCustomClaims() 。

<?php
namespace App;
+  use Tymon\JWTAuth\Contracts\JWTSubject;
use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;
-  class User extends Authenticatable
+  class User extends Authenticatable implements JWTSubject
{
...
    /**
     * Get the identifier that will be stored in the subject claim of the JWT.
     *
     * @return mixed
     */
    public function getJWTIdentifier()
    {
        return $this->getKey();
    }
    /**
     * Return a key value array, containing any custom claims to be added to the JWT.
     *
     * @return array
     */
    public function getJWTCustomClaims()
    {
        return [];
    }
}

• 設定認證(Configure Auth guard)

在 config/auth.php 檔案當中，將認證的部分改為jwt的認證方式。

'defaults' => [
-   'guard' => 'web',
+   'guard' => 'api',
    'passwords' => 'users',
],
...
'guards' => [
    'api' => [
-       'driver' => 'token',
+       'driver' => 'jwt',
        'provider' => 'users',
-       'hash' => false,
    ],
],

• 新增基本的認證Routes (Add some basic authentication routes)

首先，在 routes/api.php 檔案中加入以下：

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

• 建立 AuthController

php artisan make:controller AuthController

並在 app/Http/Controllers/AuthController 檔案中加入以下：

<?php
namespace App\Http\Controllers;
use Illuminate\Support\Facades\Auth;
use App\Http\Controllers\Controller;
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()->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()->user());
    }
/**
     * Log the user out (Invalidate the token).
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function logout()
    {
        auth()->logout();
return response()->json(['message' => 'Successfully logged out']);
    }
/**
     * Refresh a token.
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function refresh()
    {
        return $this->respondWithToken(auth()->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()->factory()->getTTL() * 60
        ]);
    }
}

那我們就能夠使用 Postman 來戳API囉！
用在資料表 users 中所建立的會員資料來使用。

使用Postman來 POST http://localhost/api/auth/login 並在 Headers 中加入 Content-Type: application/json

在 body 中使用 raw 加入：

{
 "email": "your_users_table's_email",
 "password": "your_users_table's_decoded_password"
}

接下來按下 Send 按鈕就會得到以下Token內容：

到這邊為止，已經成功用JWT產生Token囉！

官方文件中有幾個功能可以來使用你產生的 access_token ，例如 POST http://localhost/api/auth/me 。我們先使用POST http://localhost/api/auth/login 產生的 access_token 用在Postman工具中。

在Postman工具中之 authorization 設定 Header Type 為 Bearer 並在Token中放入產生的 access_token 。

就會回傳Token內的資訊囉！

官方文件中除了 login 和 me 以外，還有 refresh 和 logout 來做使用，用下就依照你們的需求來使用。

希望此篇文章對剛接觸的人有幫助。