Laravel中使用JWT
本文参考以下两篇文章,记录了在Laravel框架中使用JWT的具体操作过程。
1.JWT文档:http://jwt-auth.readthedocs.io/en/docs/laravel-installation/
2.JWT 完整使用详解:https://laravel-china.org/articles/10885/full-use-of-jwt
具体操作:
- 安装 jwt-auth。
composer require tymon/jwt-auth:1.0.0-rc.2
- 输入以下命令,在config下增加一个jwt.php的配置文件。
php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\LaravelServiceProvider"
- 安装完成后,需要设置一下 JWT 的 secret,这个 secret 很重要,用于最后的签名,更换这个secret 会导致之前生成的所有 token 无效。
php artisan jwt:secret
- 修改 config/auth.php文件,将 api的 driver 改为 jwt。
'guards' => [
'web' => [
'driver' => 'session',
'provider' => 'users',
],
'api' => [
'driver' => 'jwt',
'provider' => 'users',
],
],
- 注册两个 Facade,在config/app.php文件中,添加以下内容。
'aliases' => [
...
// 添加以下两行
'JWTAuth' => 'Tymon\JWTAuth\Facades\JWTAuth',
'JWTFactory' => 'Tymon\JWTAuth\Facades\JWTFactory',
],
- 修改app\Models\User.php文件,用user表来生成token。
<?php
namespace App\Models;
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
public function getJWTIdentifier()
{
return $this->getKey();
}
public function getJWTCustomClaims()
{
return [];
}
}
- 修改route/api.php文件,为需要的路由加上token(在 Laravel 下,route/api.php 中的路由默认都有前缀 api)。
Route::group([
'prefix' => 'auth'
], function ($router) {
Route::post('login', '[email protected]');
Route::post('logout', '[email protected]');
Route::post('refresh', '[email protected]');
Route::post('me', '[email protected]');
});
- 输入以下命令,创建 token 控制器。
php artisan make:controller AuthController
- 复制以下内容替换AuthController.php中内容。
<?php
namespace App\Http\Controllers;
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(Request $request)
{
$credentials = $request->only('email', 'password');
if (! $token = JWTAuth::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
]);
}
}
- 使用 PostMan 模拟请求,验证是否能正确获取 token。