使用Laravel集成JWT認證開發RestfulApi

本文轉載自查看原文 2020-05-09 15:18 960 php/ Laravel

在使用跨平台應用程序時， API 是一個非常不錯的選擇。除了網站，您的產品可能還有 Android 和 iOS 應用程序。在這種情況下， API 也是同樣出色的，因為您可以在不更改任何后端代碼的情況下編寫不同的前端。使用 API 時，只需使用一些參數點擊 GET ， POST 或其他類型的請求，服務器就會返回 JSON (JavaScript Object Notation) 格式的一些數據，這些數據由客戶端應用程序處理。

說明

我們先寫下我們的應用程序詳細信息和功能。我們將使用 JWT 身份驗證在 laravel 中使用 restful API 構建基本用戶產品列表。

A User 將會使用以下功能

注冊並創建一個新帳戶
登錄到他們的帳戶
注銷和丟棄 token 並離開應用程序
獲取登錄用戶的詳細信息
檢索可供用戶使用的產品列表
按 ID 查找特定產品
將新產品添加到用戶產品列表中
編輯現有產品詳細信息
從用戶列表中刪除現有產品

A User 必填

name
email
password

A Product 必填

name
price
quantity

創建新的項目

通過運行下面的命令，我們就可以開始並創建新的 Laravel 項目。

composer create-project --prefer-dist laravel/laravel jwt

這會在名為 jwt 的目錄下創建一個新的 Laravel 項目。

配置 JWT 擴展包

我們會使用 tymondesigns/jwt-auth 擴展包來讓我們在 Laravel 中使用 JWT。

安裝 tymon/jwt-auth 擴展包

讓我們在這個 Laravel 應用中安裝這個擴展包。如果您正在使用 Laravel 5.5 或以上版本，請運行以下命令來獲取 dev-develop 版本的 JWT 包：

composer require tymon/jwt-auth:dev-develop --prefer-source

如果您正在使用 Laravel 5.4 或以下版本，那么要運行下面這條命令：

composer require tymon/jwt-auth

對於 Laravel 版本低於 5.5 的應用，您還要在 config/app.php 文件中設置服務提供者和別名。

'providers' => [
 ....
 Tymon\JWTAuth\Providers\JWTAuthServiceProvider::class,
 ....
],
'aliases' => [
 ....
 'JWTAuth' => Tymon\JWTAuth\Facades\JWTAuth::class,
 'JWTFactory' => 'Tymon\JWTAuth\Facades\JWTFactory',
 ....
],

如果您的 Laravel 版本為 5.5 或以上，Laravel 會進行「包自動發現」。

發布配置文件

對於 5.5 或以上版本的 Laravel，請使用下面這條命令來發布配置文件：

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

對於之前之前版本的 Laravel，那么應該運行下面這條命令：

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

上面的命令會生成 config/jwt.php 配置文件。除去注釋部分，配置文件會像這樣：

<?php
return [
 'secret' => env('JWT_SECRET'),
 'keys' => [
 'public' => env('JWT_PUBLIC_KEY'),
 'private' => env('JWT_PRIVATE_KEY'),
 'passphrase' => env('JWT_PASSPHRASE'),
 ],
 'ttl' => env('JWT_TTL', 60),
 'refresh_ttl' => env('JWT_REFRESH_TTL', 20160),
 'algo' => env('JWT_ALGO', 'HS256'),
 'required_claims' => [
 'iss',
 'iat',
 'exp',
 'nbf',
 'sub',
 'jti',
 ],
 'persistent_claims' => [
 // 'foo',
 // 'bar',
 ],
 'lock_subject' => true,
 'leeway' => env('JWT_LEEWAY', 0),
 'blacklist_enabled' => env('JWT_BLACKLIST_ENABLED', true),
 'blacklist_grace_period' => env('JWT_BLACKLIST_GRACE_PERIOD', 0),
 'decrypt_cookies' => false,
 'providers' => [
 'jwt' => Tymon\JWTAuth\Providers\JWT\Lcobucci::class,
 'auth' => Tymon\JWTAuth\Providers\Auth\Illuminate::class,
 'storage' => Tymon\JWTAuth\Providers\Storage\Illuminate::class,
 ],
];

生成 JWT 密鑰

JWT 令牌通過一個加密的密鑰來簽發。對於 Laravel 5.5 或以上版本，運行下面的命令來生成密鑰以便用於簽發令牌。

php artisan jwt:secret

Laravel 版本低於 5.5 的則運行：

php artisan jwt:generate

這篇教程使用 Laravel 5.6。教程中接下來的步驟只在 5.5 和 5.6 中測試過。可能不適用於 Laravel 5.4 或以下版本。您可以閱讀針對舊版本 Laravel 的文檔。

注冊中間件

JWT 認證擴展包附帶了允許我們使用的中間件。在 app/Http/Kernel.php 中注冊 auth.jwt 中間件：

protected $routeMiddleware = [
 ....
 'auth.jwt' => \Tymon\JWTAuth\Http\Middleware\Authenticate::class,
];

這個中間件會通過檢查請求中附帶的令牌來校驗用戶的認證。如果用戶未認證，這個中間件會拋出 UnauthorizedHttpException 異常。

設置路由

開始之前，我們將為所有本教程討論的點設置路由。打開 routes/api.php 並將下面的路由復制到您的文件中。

Route::post('login', 'ApiController@login');
Route::post('register', 'ApiController@register');
Route::group(['middleware' => 'auth.jwt'], function () {
 Route::get('logout', 'ApiController@logout');
 Route::get('user', 'ApiController@getAuthUser');
 Route::get('products', 'ProductController@index');
 Route::get('products/{id}', 'ProductController@show');
 Route::post('products', 'ProductController@store');
 Route::put('products/{id}', 'ProductController@update');
 Route::delete('products/{id}', 'ProductController@destroy');
});

更新 User 模型

JWT 需要在 User 模型中實現 Tymon\JWTAuth\Contracts\JWTSubject 接口。此接口需要實現兩個方法 getJWTIdentifier 和 getJWTCustomClaims。使用以下內容更新 app/User.php 。

<?php
namespace App;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Tymon\JWTAuth\Contracts\JWTSubject;
class User extends Authenticatable implements JWTSubject
{
 use Notifiable;
 /**
 * The attributes that are mass assignable.
 *
 * @var array
 */
 protected $fillable = [
 'name', 'email', 'password',
 ];
 /**
 * The attributes that should be hidden for arrays.
 *
 * @var array
 */
 protected $hidden = [
 'password', 'remember_token',
 ];
 /**
 * 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 [];
 }
}

JWT 身份驗證邏輯

讓我們使用 JWT 身份驗證在 laravel 中寫 Restful API 的邏輯。

用戶注冊時需要姓名，郵箱和密碼。那么，讓我們創建一個表單請求來驗證數據。通過運行以下命令創建名為 RegisterAuthRequest 的表單請求：

php artisan make:request RegisterAuthRequest

它將在 app/Http/Requests 目錄下創建 RegisterAuthRequest.php 文件。將下面的代碼黏貼至該文件中。

<?php
namespace App\Http\Requests;
use Illuminate\Foundation\Http\FormRequest;
class RegisterAuthRequest extends FormRequest
{
 /**
 * 確定是否授權用戶發出此請求
 *
 * @return bool
 */
 public function authorize()
 {
 return true;
 }
 /**
 * 獲取應用於請求的驗證規則
 *
 * @return array
 */
 public function rules()
 {
 return [
 'name' => 'required|string',
 'email' => 'required|email|unique:users',
 'password' => 'required|string|min:6|max:10'
 ];
 }
}

運行以下命令創建一個新的 ApiController :

php artisan make:controller ApiController

這將會在 app/Http/Controllers 目錄下創建 ApiController.php 文件。將下面的代碼黏貼至該文件中。

<?php
namespace App\Http\Controllers;
use App\Http\Requests\RegisterAuthRequest;
use App\User;
use Illuminate\Http\Request;
use JWTAuth;
use Tymon\JWTAuth\Exceptions\JWTException;
class ApiController extends Controller
{
 public $loginAfterSignUp = true;
 public function register(RegisterAuthRequest $request)
 {
 $user = new User();
 $user->name = $request->name;
 $user->email = $request->email;
 $user->password = bcrypt($request->password);
 $user->save();
 if ($this->loginAfterSignUp) {
 return $this->login($request);
 }
 return response()->json([
 'success' => true,
 'data' => $user
 ], 200);
 }
 public function login(Request $request)
 {
 $input = $request->only('email', 'password');
 $jwt_token = null;
 if (!$jwt_token = JWTAuth::attempt($input)) {
 return response()->json([
 'success' => false,
 'message' => 'Invalid Email or Password',
 ], 401);
 }
 return response()->json([
 'success' => true,
 'token' => $jwt_token,
 ]);
 }
 public function logout(Request $request)
 {
 $this->validate($request, [
 'token' => 'required'
 ]);
 try {
 JWTAuth::invalidate($request->token);
 return response()->json([
 'success' => true,
 'message' => 'User logged out successfully'
 ]);
 } catch (JWTException $exception) {
 return response()->json([
 'success' => false,
 'message' => 'Sorry, the user cannot be logged out'
 ], 500);
 }
 }
 public function getAuthUser(Request $request)
 {
 $this->validate($request, [
 'token' => 'required'
 ]);
 $user = JWTAuth::authenticate($request->token);
 return response()->json(['user' => $user]);
 }
}

讓我解釋下上面的代碼發生了什么。

在 register 方法中，我們接收了 RegisterAuthRequest 。使用請求中的數據創建用戶。如果 loginAfterSignUp 屬性為 true ，則注冊后通過調用 login 方法為用戶登錄。否則，成功的響應則將伴隨用戶數據一起返回。

在 login 方法中，我們得到了請求的子集，其中只包含電子郵件和密碼。以輸入的值作為參數調用 JWTAuth::attempt() ，響應保存在一個變量中。如果從 attempt 方法中返回 false ，則返回一個失敗響應。否則，將返回一個成功的響應。

在 logout 方法中，驗證請求是否包含令牌驗證。通過調用 invalidate 方法使令牌無效，並返回一個成功的響應。如果捕獲到 JWTException 異常，則返回一個失敗的響應。

在 getAuthUser 方法中，驗證請求是否包含令牌字段。然后調用 authenticate 方法，該方法返回經過身份驗證的用戶。最后，返回帶有用戶的響應。

身份驗證部分現在已經完成。

構建產品部分

要創建產品部分，我們需要 Product 模型，控制器和遷移文件。運行以下命令來創建 Product 模型，控制器和遷移文件。

php artisan make:model Product -mc

它會在 database/migrations 目錄下創建一個新的數據庫遷移文件 create_products_table.php，更改 up 方法。

public function up()
{
 Schema::create('products', function (Blueprint $table) {
 $table->increments('id');
 $table->integer('user_id');
 $table->string('name');
 $table->integer('price');
 $table->integer('quantity');
 $table->timestamps();
 $table->foreign('user_id')
 ->references('id')
 ->on('users')
 ->onDelete('cascade');
 });
}

向 Product 模型中添加 fillable 屬性。在 app 目錄下打開 Product.php 文件並添加屬性。

protected $fillable = [
 'name', 'price', 'quantity'
];

現在在 .env 文件中設置數據庫憑證，並通過運行以下命令遷移數據庫。

php artisan migrate

現在，我們必須在 User 模型中添加一個關系來檢索相關產品。在 app/User.php 中添加以下方法。

public function products()
{
 return $this->hasMany(Product::class);
}

在 app/Http/Controllers 目錄下打開 ProductController.php 文件。在文件開頭添加 use 指令覆蓋上一個。

use App\Product;
use Illuminate\Http\Request;
use JWTAuth;

現在我們將實現五個方法。

index, 為經過身份認證的用戶獲取所有產品列表

show, 根據 ID 獲取特定的產品

store, 將新產品存儲到產品列表中

update, 根據 ID 更新產品詳情

destroy, 根據 ID 從列表中刪除產品

添加一個構造函數來獲取經過身份認證的用戶，並將其保存在 user 屬性中。

protected $user;
public function __construct()
{
 $this->user = JWTAuth::parseToken()->authenticate();
}

parseToken 將解析來自請求的令牌， authenticate 通過令牌對用戶進行身份驗證。

讓我們添加 index 方法。

public function index()
{
 return $this->user
 ->products()
 ->get(['name', 'price', 'quantity'])
 ->toArray();
}

上面的代碼非常簡單，我們只是使用 Eloquent 的方法獲取所有的產品，然后將結果組成一個數組。最后，我們返回這個數組。Laravel 將自動將其轉換為 JSON ，並創建一個為 200 成功的響應碼。

繼續實現 show 方法。

public function show($id)
{
 $product = $this->user->products()->find($id);
 if (!$product) {
 return response()->json([
 'success' => false,
 'message' => 'Sorry, product with id ' . $id . ' cannot be found'
 ], 400);
 }
 return $product;
}

這個也非常容易理解。我們只需要根據 ID 找到該產品。如果產品不存在，則返回 400 故障響應。否則，將返回產品數組。

接下來是 store 方法

public function store(Request $request)
{
 $this->validate($request, [
 'name' => 'required',
 'price' => 'required|integer',
 'quantity' => 'required|integer'
 ]);
 $product = new Product();
 $product->name = $request->name;
 $product->price = $request->price;
 $product->quantity = $request->quantity;
 if ($this->user->products()->save($product))
 return response()->json([
 'success' => true,
 'product' => $product
 ]);
 else
 return response()->json([
 'success' => false,
 'message' => 'Sorry, product could not be added'
 ], 500);
}

在 store 方法中，驗證請求中是否包含名稱，價格和數量。然后，使用請求中的數據去創建一個新的產品模型。如果，產品成功的寫入數據庫，會返回成功響應，否則返回自定義的 500 失敗響應。

實現 update 方法

public function update(Request $request, $id)
{
 $product = $this->user->products()->find($id);
 if (!$product) {
 return response()->json([
 'success' => false,
 'message' => 'Sorry, product with id ' . $id . ' cannot be found'
 ], 400);
 }
 $updated = $product->fill($request->all())
 ->save();
 if ($updated) {
 return response()->json([
 'success' => true
 ]);
 } else {
 return response()->json([
 'success' => false,
 'message' => 'Sorry, product could not be updated'
 ], 500);
 }
}

在 update 方法中，我們通過 id 取得產品。如果產品不存在，返回一個 400 響應。然后，我們把請求中的數據使用 fill 方法填充到產品詳情。更新產品模型並保存到數據庫，如果記錄成功更新，返回一個 200 成功響應，否則返回 500 內部服務器錯誤響應給客戶端。

現在，讓我們實現 destroy 方法。

public function destroy($id)
{
 $product = $this->user->products()->find($id);
 if (!$product) {
 return response()->json([
 'success' => false,
 'message' => 'Sorry, product with id ' . $id . ' cannot be found'
 ], 400);
 }
 if ($product->delete()) {
 return response()->json([
 'success' => true
 ]);
 } else {
 return response()->json([
 'success' => false,
 'message' => 'Product could not be deleted'
 ], 500);
 }
}

在 destroy 方法中，我們根據 ID 獲取產品，如果產品不存在，則返回 400 響應。然后我們刪除產品后並根據刪除操作的成功狀態返回適當的響應。

控制器代碼現在已經完成，完整的控制器代碼在這。

測試

我們首先來測試身份認證。我們將使用 serve 命令在開發機上啟動 Web 服務，你也可以使用虛擬主機代替。運行以下命令啟動 Web 服務。