在此文章中，我们将学习如何使用 JWT 身份验证在 Laravel 中构建 restful API 。 JWT 代表 JSON Web Tokens 。 我们还将使用 API 为用户产品创建功能齐全的 CRUD 应用。
在使用跨平台应用程序时， API 是一个非常不错的选择。 除了网站，您的产品可能还有 Android 和 iOS 应用程序。 在这种情况下， API 也是同样出色的，因为您可以在不更改任何后端代码的情况下编写不同的前端。 使用 API 时，只需使用一些参数点击 GET ， POST 或其他类型的请求，服务器就会返回 JSON (JavaScript Object Notation) 格式的一些数据，这些数据由客户端应用程序处理。
说明
我们先写下我们的应用程序详细信息和功能。 我们将使用 JWT 身份验证在 laravel 中使用 restful API 构建基本用户产品列表。
A User 将会使用以下功能
- 注册并创建一个新帐户
- 登录到他们的帐户
- 注销和丢弃 token 并离开应用程序
- 获取登录用户的详细信息
- 检索可供用户使用的产品列表
- 按 ID 查找特定产品
- 将新产品添加到用户产品列表中
- 编辑现有产品详细信息
- 从用户列表中删除现有产品
A User 必填
- name
- 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:secretLaravel 版本低于 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