已从CSDN搬家到简书
jwt-auth 最新版本是 1.0.0 rc.1 版本,已经支持了 Laravel 5.5。如果你使用的是 Laravel 5.5 版本,可以使用如下命令安装。
如果你是 Laravel 5.5 以下版本,也推荐使用最新版本,RC.1 前的版本都存在多用户token认证的安全问题。
composer require tymon/jwt-auth 1.0.0-rc.1
添加服务提供商
将下面这行添加至 config/app.php
文件 providers
数组中:
Tymon\JWTAuth\Providers\LaravelServiceProvider::class,
将下面这行添加至 config/app.php
文件 aliases数组中:
'JWTAuth'=> Tymon\JWTAuth\Facades\JWTAuth::class,
'JWTFactory'=> Tymon\JWTAuth\Facades\JWTFactory::class,
在你的 shell 中运行如下命令发布 配置文件:
php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\LaravelServiceProvider"
此命令会在 config
目录下生成一个 jwt.php
配置文件,你可以在此进行自定义配置。
生成密钥
php artisan jwt:secret
此命令会在你的 .env
文件中新增一行 JWT_SECRET=secret
。
配置 Auth guard
'defaults' => [
'guard' => 'api', // 修改为api
'passwords' => 'users',
],
'guards' => [
'api' => [
'driver' => 'jwt', // JWTGuard 实现,源码中为 token,我这改成 jwt 了
'provider' => 'users',
],
],
'providers' => [
'users' => [
'driver' => 'eloquent',
'model' => App\Models\User::class, // 根据你model的位置更改
],
],
更改 Model
<?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
{
use Notifiable;
protected $table = 'users';
protected $fillable = ['name', 'password', 'mobile'];
#定义是否默认维护时间,默认是true.改为false,则以下时间相关设定无效
public $timestamps = true;
protected $hidden = [
'password',
];
/**
* 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 [];
}
}
用户提供账号密码前来登录。如果登录成功,那么我会给前端颁发一个 access _token
执行如下命令以新建一个中间件:
php artisan make:middleware ApiAuth
中间件代码 ApiAuth.php 如下:
<?php
namespace App\Http\Middleware;
use Closure;
use Tymon\JWTAuth\Exceptions\JWTException;
use Tymon\JWTAuth\Exceptions\TokenExpiredException;
use Tymon\JWTAuth\Exceptions\TokenInvalidException;
use JWTAuth;
class ApiAuth
{
public function handle($request, Closure $next)
{
try {
if (! $user = JWTAuth::parseToken()->authenticate()) { //获取到用户数据,并赋值给$user
return response()->json([
'errcode' => 1004,
'errmsg' => 'user not found'
], 404);
}
return $next($request);
} catch (TokenExpiredException $e) {
return response()->json([
'errcode' => 1003,
'errmsg' => 'token 过期' , //token已过期
]);
} catch (TokenInvalidException $e) {
return response()->json([
'errcode' => 1002,
'errmsg' => 'token 无效', //token无效
]);
} catch (JWTException $e) {
return response()->json([
'errcode' => 1001,
'errmsg' => '缺少token' , //token为空
]);
}
}
}
在app\Http\Kernel.php下添加如下代码
protected $routeMiddleware = [
'api.auth' => \App\Http\Middleware\ApiAuth::class,
];
现在,我们可以在 routes/api.php
路由文件中路由来测试一下
Route::post('login', 'IndexController@login');
Route::post('register', 'IndexController@register');
控制器代码如下:
use JWTAuth;
public function login(Request $request)
{
// 验证规则,由于业务需求,这里我更改了一下登录的用户名,使用手机号码登录
$rules = [
'mobile' => ['required'],
'password' => 'required|string|min:6|max:20',
];
// 验证参数,如果验证失败,则会抛出 ValidationException 的异常
$params = $this->validate($request, $rules);
// 使用 Auth 登录用户,如果登录成功,则返回 201 的 code 和 token,如果登录失败则返回
$token = JWTAuth::attempt($params);
if ($token) {
return $this->responseData(['access_token' => $token]);
} else {
$this->responseError('账号或密码错误');
}
}
public function register(RegisterRequest $request)
{
$mobile = $request->input('mobile');
$password = $request->input('password');
// 注册用户
$user = User::create([
'mobile' => $mobile,
'password' => bcrypt($password),
'nickname' => encryptedPhoneNumber($mobile)
]);
// 获取token
$token = JWTAuth::fromUser($user);
if (!$token) {
return $this->responseError('注册失败,请重试');
}
return $this->responseData([
'access_token' => $token,
'user' => $user
]);
}
测试截图如下: