Laravel6通过jwt(tymon/jwt-auth)实现API用户无感刷新TOKEN

最新推荐文章于 2024-07-01 10:27:42 发布
最新推荐文章于 2024-07-01 10:27:42 发布
阅读量4.9k 收藏 15
点赞数 5
分类专栏： laravel php 文章标签： php
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xiayu204575/article/details/106076154
版权
php 同时被 2 个专栏收录
40 篇文章 0 订阅
订阅专栏
laravel
27 篇文章 0 订阅
订阅专栏

Laravel6通过jwt实现API用户无感刷新TOKEN

1、TOKEN是什么

TOKEN翻译为令牌，就是鉴别身份的凭据，类似于身份证；
TOKEN本质就是一大串字符串，最常用的场景就是接口对接的鉴权。
TOKEN通过一次登录验证，得到一个鉴权字符串，随后其它的请求每次都携带这个鉴权字符串，即可完成鉴权。

2、jwt是什么

​ jwt 全称json web token（翻译为数据网络令牌）
​ jwt 是一种规范化的 token，让数据在网络中安全传输。
​ jwt 使用场景：
​ 1.无状态的 RESTful API
​ 2.SSO 单点登录

3、jwt安装&配置

3.1、通过composer安装

composer require tymon/jwt-auth

3.2、发布配置

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

会自动生成一个配置文件：config/jwt.php

3.3、生成加密密钥

jwt-auth 已经预先定义好了一个 Artisan 命令方便你生成 Secret，你只需要在你的 shell 中运行如下命令即可：

php artisan jwt:secret

.env 文件下生成一个加密密钥

3.4、修改 auth.php

'guards' => [
        'web' => [
            'driver' => 'session',
            'provider' => 'users',
        ],

        'api' => [
            'driver' => 'jwt', // 原来是 token 改成jwt
            'provider' => 'users'
        ],
    ],

3.5、更改User模型

  1. 这里为了以后开发方便，把app\user.php 移动到 app\Models\user.php，并全局搜索 App\User 修改为 App\Models\User
  2. 让user模型实现JWTSubject接口，实现getJWTIdentifier()和getJWTCustomClaims()方法
<?php

namespace App\Models;

use Tymon\JWTAuth\Contracts\JWTSubject;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable implements JWTSubject
{

	use Notifiable;
    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'name', 'password',
    ];

    /**
     * The attributes that should be hidden for arrays.
     *
     * @var array
     */
    protected $hidden = [
        'password',
    ];

    public function getJWTIdentifier()
    {
        return $this->getKey();
    }

    public function getJWTCustomClaims()
    {
        return [];
    }
}

4、自定义认证中间件&&异常

4.1、接口统一返回

新建统一返回trait ApiResponse

<?php

namespace App\Http\Helpers\Api;

use Symfony\Component\HttpFoundation\Response as FoundationResponse;

trait ApiResponse
{
    /**
     * @var int
     */
    protected $statusCode = FoundationResponse::HTTP_OK;
    protected $token = '';

    /**
     * @return mixed
     */
    public function getStatusCode()
    {
        return $this->statusCode;
    }

    /**
     * @param $statusCode
     * @return $this
     */
    public function setStatusCode($statusCode,$httpCode=null)
    {
        $httpCode = $httpCode ?? $statusCode;
        $this->statusCode = $statusCode;
        return $this;
    }

    /**
     * @param $statusCode
     * @param null $httpCode
     * @return $this
     */
    public function setToken($token)
    {
        $this->token = $token;
        return $this;
    }

    /**
     * @param $data
     * @param array $header
     * @return mixed
     */
    public function respond($data)
    {
        $response = response()->json($data, $this->getStatusCode());
        if($this->token) {
            $response->headers->set('Authorization', 'Bearer '.$this->token);
        }
        return $response;
    }

    /**
     * @param $status
     * @param array $data
     * @param null $code
     * @param array $header
     * @return mixed
     */
    public function status($status, array $data, $code = null)
    {
        if ($code){
            $this->setStatusCode($code);
        }
        $status = [
            'status' => $status,
            'code' => $this->statusCode
        ];

        $data = array_merge($status,$data);
        return $this->respond($data);
    }

    /**
     * @param $message
     * @param int $code
     * @param string $status
     * @return mixed
     */
    /*
     * 格式
     * data:
     *  code:422
     *  message:xxx
     *  status:'error'
     */
    public function failed($message, $code = FoundationResponse::HTTP_BAD_REQUEST,$status = 'error')
    {
        return $this->setStatusCode($code)->message($message,$status);
    }

    /**
     * @param $message
     * @param string $status
     * @return mixed
     */
    public function message($message, $status = "success")
    {
        if(!is_array($message)) {
            $message = [$message];
        }
        return $this->status($status,[
            'message' => $message
        ]);
    }

    /**
     * @param string $message
     * @return mixed
     */
    public function internalError($message = "Internal Error!")
    {
        return $this->failed($message,FoundationResponse::HTTP_INTERNAL_SERVER_ERROR);
    }

    /**
     * @param string $message
     * @return mixed
     */
    public function created($message = "created")
    {
        return $this->setStatusCode(FoundationResponse::HTTP_CREATED)
            ->message($message);
    }

    /**
     * @param $data
     * @param string $status
     * @param array $header
     * @return mixed
     */
    public function success($data, $status = "success")
    {
        return $this->status($status,compact('data'));
    }

    /**
     * @param string $message
     * @return mixed
     */
    public function notFond($message = 'Not Fond!')
    {
        return $this->failed($message,Foundationresponse::HTTP_NOT_FOUND);
    }
}

4.2、创建中间件

用户提供账号密码前来登录。如果登录成功，那么接口返回前端一个 TOKEN， 如果用户的TOKEN如果过期了，可以暂时通过此次请求，并在此次请求中刷新该用户的 TOKEN，最后在响应头中将新的 token 返回给前端，这样子可以无痛的刷新TOKEN，用户可以获得一个很良好的体验。
生成中间件：

php artisan make:middleware Api/RefreshTokenMiddleware

代码如下：

<?php

namespace App\Http\Middleware\Api;

use Illuminate\Support\Facades\Auth;
use Closure;
use Tymon\JWTAuth\Exceptions\JWTException;
use Tymon\JWTAuth\Http\Middleware\BaseMiddleware;
use Tymon\JWTAuth\Exceptions\TokenExpiredException;
use Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException;

// 注意，我们要继承的是 jwt 的 BaseMiddleware
class RefreshTokenMiddleware extends BaseMiddleware
{
    /**
     * @param $request
     * @param Closure $next
     * @return \Illuminate\Http\JsonResponse|\Illuminate\Http\Response|mixed
     * @throws JWTException
     */
    public function handle($request, Closure $next)
    {
        // 检查此次请求中是否带有 token，如果没有则抛出异常。
        $this->checkForToken($request);
//         使用 try 包裹，以捕捉 token 过期所抛出的 TokenExpiredException  异常
        try {
            // 检测用户的登录状态，如果正常则通过
            if ($this->auth->parseToken()->authenticate()) {
                return $next($request);
            }
            throw new UnauthorizedHttpException('jwt-auth', '未登录');
        } catch (TokenExpiredException $exception) {
            // 此处捕获到了 token 过期所抛出的 TokenExpiredException 异常，我们在这里需要做的是刷新该用户的 token 并将它添加到响应头中
            try {
                // 刷新用户的 token
                $token = $this->auth->refresh();
                // 使用一次性登录以保证此次请求的成功
                Auth::guard('api')->onceUsingId($this->auth->manager()->getPayloadFactory()->buildClaimsCollection()->toPlainArray()['sub']);
            } catch (JWTException $exception) {
                // 如果捕获到此异常，即代表 refresh 也过期了，用户无法刷新令牌，需要重新登录。
                throw new UnauthorizedHttpException('jwt-auth', $exception->getMessage());
            }
        }

        // 在响应头中返回新的 token
        return $this->setAuthenticationHeader($next($request), $token);
    }
}

4.2、异常处理

4.2.1、创建异常集合

创建异常集合文件App\Http\Helpers\Api\ExceptionReport.php

<?php

namespace App\Http\Helpers\Api;

use Exception;
use Illuminate\Auth\Access\AuthorizationException;
use Illuminate\Auth\AuthenticationException;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Database\QueryException;
use Illuminate\Http\Request;
use Illuminate\Validation\ValidationException;
use Symfony\Component\HttpKernel\Exception\MethodNotAllowedHttpException;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException;
use Tymon\JWTAuth\Exceptions\TokenInvalidException;

class ExceptionReport
{
    use ApiResponse;

    /**
     * @var Exception
     */
    public $exception;
    /**
     * @var Request
     */
    public $request;

    /**
     * @var
     */
    protected $report;

    /**
     * ExceptionReport constructor.
     * @param Request $request
     * @param Exception $exception
     */
    function __construct(Request $request, Exception $exception)
    {
        $this->request = $request;
        $this->exception = $exception;
    }

    /**
     * @var array
     */
    //当抛出这些异常时，可以使用我们定义的错误信息与HTTP状态码
    //可以把常见异常放在这里
    public $doReport = [
        AuthenticationException::class => ['未授权', 401],
        ModelNotFoundException::class => ['该模型未找到', 404],
        AuthorizationException::class => ['没有此权限', 403],
        ValidationException::class => [],
        UnauthorizedHttpException::class => ['未登录或登录状态失效', 422],
        TokenInvalidException::class => ['token不正确', 400],
        NotFoundHttpException::class => ['没有找到该页面', 404],
        MethodNotAllowedHttpException::class => ['访问方式不正确', 405],
        QueryException::class => ['参数错误', 401],
    ];

    public function register($className, callable $callback)
    {

        $this->doReport[$className] = $callback;
    }

    /**
     * @return bool
     */
    public function shouldReturn()
    {
        //只有请求包含是json或者ajax请求时才有效
//        if (! ($this->request->wantsJson() || $this->request->ajax())){
//
//            return false;
//        }
        foreach (array_keys($this->doReport) as $report) {
            if ($this->exception instanceof $report) {
                $this->report = $report;
                return true;
            }
        }

        return false;

    }

    /**
     * @param Exception $e
     * @return static
     */
    public static function make(Exception $e)
    {

        return new static(\request(), $e);
    }

    /**
     * @return mixed
     */
    public function report()
    {
        if ($this->exception instanceof ValidationException) {
//            $error = array_key_first($this->exception->errors());
            return $this->failed(current($this->exception->errors()), $this->exception->status);
        }
        $message = $this->doReport[$this->report];
        return $this->failed($message[0], $message[1]);
    }

    public function prodReport()
    {
        return $this->failed('服务器错误', '500');
    }
}

4.2.2、异常处理

app/Exceptions/Handler.php 中的 render方法，自定义处理一些异常。

<?php

namespace App\Exceptions;

use App\Http\Helpers\Api\ExceptionReport;
use Exception;
use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;

class Handler extends ExceptionHandler
{
    /**
     * A list of the exception types that are not reported.
     *
     * @var array
     */
    protected $dontReport = [
        //
    ];

    /**
     * A list of the inputs that are never flashed for validation exceptions.
     *
     * @var array
     */
    protected $dontFlash = [
        'password',
        'password_confirmation',
    ];

    /**
     * Report or log an exception.
     *
     * @param  \Exception  $exception
     * @return void
     *
     * @throws \Exception
     */
    public function report(Exception $exception)
    {
        parent::report($exception);
    }

    /**
     * Render an exception into an HTTP response.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Exception  $exception
     * @return \Symfony\Component\HttpFoundation\Response
     *
     * @throws \Exception
     */
    public function render($request, Exception $exception)
    {
        if($request->is("api/*")){
            // 将方法拦截到自己的ExceptionReport
            $reporter = ExceptionReport::make($exception);
            if ($reporter->shouldReturn()){
                return $reporter->report();
            }
            if(env('APP_DEBUG')){
                //开发环境，则显示详细错误信息
                return parent::render($request, $exception);
            }else{
                //线上环境,未知错误，则显示500
                return $reporter->prodReport();
            }
        }
        return parent::render($request, $exception);
    }
}

5、控制器&&路由

5.1、创建控制器

  1. 创建接口控制器 Api/Controller.php
php artisan make:controller Api/Controller

然后增加如下方法

<?php

namespace App\Http\Controllers\Api;

use App\Http\Helpers\Api\ApiResponse;
use App\Http\Controllers\Controller as BaseController;

class Controller extends BaseController
{

    use ApiResponse;
    // 其他通用的Api帮助函数
}
  1. 创建接口控制器 Api/UserController.php
php artisan make:controller Api/UserController

然后增加如下方法

<?php

namespace App\Http\Controllers\Api;

use App\Models\User;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;

class UserController extends Controller
{
    /**
     * @param Request $request
     * @return mixed
     */
    public function login(Request $request){
        $token = Auth::guard('api')->attempt(['name'=>$request->name,'password'=>$request->password]);
        if($token) {
            return $this->setStatusCode(201)->success(['token' => 'bearer ' . $token]);
        }
        return $this->failed('账号或密码错误',400);
    }

    /**
     * @return mixed
     */
    public function loginOut(){
        Auth::guard('api')->logout();
        return $this->success('退出成功...');
    }


    /**
     * 返回当前登录用户信息
     * @param Request $request
     * @return mixed
     */
    public function info(Request $request){

        $user = $request->user();
        return $this->success($user);
    }

    /**
     * @param Request $request
     * @return mixed
     * @throws \Exception
     */
    public function register(Request $request)
    {
        $member = [
            'name' => $request->name,
            'password' => $request->password,
        ];
        User::create($member);
        return $this->setStatusCode(201)->success('用户注册成功');
    }

    /**
     * @param Request $request
     * @return mixed
     */
    public function changePw(Request $request)
    {
        $user = $request->user();
        $user->update(['password' => $request->password]);
        $token = Auth::guard('api')->refresh();
        return $this->setStatusCode(201)->setToken($token)->success('修改密码成功');
    }

}

5.2、路由

routes\api.php 新增如下代码：

Route::prefix('user/')->group(function() {
        //用户注册
        Route::post('register', 'UserrController@register')->name('user.register');
        //用户登录
        Route::post('login', 'UserrController@login')->name('user.login');

        Route::middleware('api.refresh')->group(function() {
            //当前用户信息
            Route::get('info', 'UserrController@info')->name('user.info');
            Route::post('changepw', 'UserrController@changePw')->name('user.changepw');
            //用户退出
            Route::post('logout', 'UserrController@logout')->name('users.logout');
        });
    });

5.3、前端TOKEN更新

前端监测返回的header是否包含TOKEN ，有的话就替换本地TOKEN，从而实现API用户无感刷新TOKEN。

lionvc1
关注
专栏目录
Laravel6.0 使用 Jwt-auth 实现多用户接口认证
huangdj321的博客
03-17 1568
后台管理员认证 (admins表) 首先创建数据库和表(admins)，在 routes/api.php 中，写上如下路由并创建对应控制器和方法。 Route::namespace('Api')->group(function () { /*** * 管理员后台接口路由 */ Route::prefix('admin')->namespace('Ad...
laravel整合 tymon/jwt-auth
weixin_51191714的博客
09-02 395
修改 config/auth.php 配置文件。修改 Models/User.php 如下。
laravel7+tymon/jwt-auth实现无痛刷新
gztrljh
10-27 472
https://blog.csdn.net/xiayu204575/article/details/106076154?utm_medium=distribute.pc_relevant.none-task-blog-BlogCommendFromMachineLearnPai2-2.edu_weight&depth_1-utm_source=distribute.pc_relevant.none-task-blog-BlogCommendFromMachineLearnPai2-2.edu_wei
Laravel Auth 调用 tymon/jwt-auth 源码分析
最新发布
weetch的博客
07-01 426
捕获该异常，这也是为什么不管是。这里省略安装步骤，直接写使用过程。请求过来后使用了中间件，会调用。在请求通过路由时执行中间件，中间件的错误提示一直是。实例，失败则统一抛出。时，会导致一直未认证。
lumen8 tymon/jwt-auth过期token更新
vn700的专栏
11-16 533
tymon/jwt-auth token过期时生成新token给客户端，同时使用旧token完成最后一次请求。
laravel jwt 无感刷新token
wsyh12345678的博客
05-18 1192
为保证和前端交互过程中，用户可以自动刷新token，该代码是基于laravel的
Laravel使用Dingo API+JWT实现认证机制 无痛刷新Token
Hannnnnnnnnnnnn的博客
12-09 1474
安装Dingo API 和 JWT 执行composer命令 composer require dingo/api composer require tymon/jwt-auth 修改config/app.php添加配置 'providers' => [ Tymon\JWTAuth\Providers\LaravelServiceProvider::class, ] 'aliases' => [ 'JWTAuth' => Tymon\JWTAuth\Facades\.
laravel使用jwt-token(六)
LiYi
12-08 1120
laravel使用jwt-token（六） 在第五‘骗’学习中我们了解了几个jwt的常用方法，其实这些方法我们没必要去死记硬背，我们只要知道它在哪里， 以及它在那里是怎么实现的。那么我们再次来理解的时候就轻松多了 我们首先找到源码位置tymon/jwt-auth/JWT.php 1. 在这里我们可以看到它定义了四个受保护的变量 protected $manager; protected $par...
JWT-auth的原理以及laravel中tymon/jwt-auth的安装使用
热门推荐
caozhennan824的博客
06-20 1万+
引言 最近后端准备用laravel来编写一个微信小程序的后端，那么首先涉及到的就是用户登录授权访问后端api的逻辑实现，之前还自己封装点token验证的类来处理登录状态，但是一接触laravel，就知道了tymon/jwt-auth的鼎鼎大名。那就必须来探究和学习一下了。 一.JWT auth知识及原理 想在laravel中使用tymon/jwt-auth之前，有些概念我们必须要学习。下面我将用自己的语言来描述一下。 1.什么是所谓的token？ 我们都知道http协议是无状态的协议，unstate，这
laravel tymon/jwt-auth在用户是多表情况下的授权验证
caozhennan824的博客
06-21 1519
导语 接上一篇文章末尾抛出的问题，在多表用户的情况下，一个守卫对应的一个资源提供者势必不能够满足要求了。这个时候最直观的操作就是增加守卫及其对应的资源提供者，用来覆盖这个需要验证用户的新数据表。 接下来是很重要的一段话，请仔细阅读： 当两个守卫（本文以user和admin为例）所对应的资源提供者不同时（分别对应Model\User,\Model\admin），假设分别以两表中id为1的记录生成token,分别为token-user,token-admin。 在版本为0.5.*的tymon/jwt-auth下
tymon/jwt-auth文档
gztrljh
10-27 5146
JWT JSON Web Token（JWT）是目前最流行的跨域身份验证解决方案 JWT的原则是在服务器身份验证之后，将生成一个JSON对象并将其发送回用户 通过composer安装 运行以下命令以获取最新版本： composer require tymon/jwt-auth 添加服务提供商（Laravel 5.4或更低版本） 将服务提供程序添加到配置文件中的providers数组，config/app.php如下所示： 'providers' => [ ... Tymon
laravel_jwt_demo:Laravel 6.0 结合 jwt 多用户模型认证案例
05-06
Laravel 6.0 结合 jwt 认证案例。 项目中实现了多用户模型，User 与 Admin，各自生成token，各自认证自己的功能模块。
laravel-jwt:Laravel的无缝JWT实现
04-16
Laravel JWT 拉拉维尔：6 PHP ：7.2+ 执照：麻省理工学院 作者：Ollie Read 作者主页： : Laravel JWT提供了无缝的JWT（JSON Web令牌）实现，该实现直接与Laravels身份验证库集成，从而允许无状态API身份验证。 目录 客户确认 用法 提供令牌 获取令牌 例子 避免XSS 大事记 代币 未来 正在安装 要安装此软件包，只需运行以下命令。 composer require sprocketbox/laravel-jwt 该软件包使用自动发现来注册服务提供商，但是如果您愿意手动进行注册，则该服务提供商为： Sprocketbox\JWT\JWTServiceProvider 配置中 不需要额外的配置文件，但是在config/auth.php中config/auth.php防护时，有一些额外的选项。 这是JWT防护的示
Laravel (Lumen) 解决JWT-Auth刷新token的问题
10-16
今天小编就为大家分享一篇Laravel (Lumen) 解决JWT-Auth刷新token的问题，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
Laravel 5.5 使用 Jwt-Auth 实现 API 用户认证、刷新令牌(一)
woqianduo的博客
11-16 9726
需求： 新项目，采用前后端分离的模式，前端使用 Vue.js，后端使用 Laravel 5.5构建 Api 服务，用户认证的包使用 jwt-auth 。 概述： JWT（JSON Web Token）是一个非常轻巧的规范。这个规范允许我们使用JWT在用户和服务器之间传递安全可靠的信息。一个JWT实际上就是一个字符串，它由三部分组成，头部、载荷与签名。 更详细讲解地址：https://laravel...
【laralve项目】@15 再次分析JWT的自动刷新
咔咔博客
07-11 600
在之前的操作里，只是把这个jwt的自动刷新写出来了，但是一直都没有进行实际项目的使用，那么今天就来结合实际项目在来解释一次，就当自己重温了 执行步骤 路由 在route里边定义了俩个路由，一个是login，一个是member login路由用来登录 member是会员中心页面 login路由中的check.brower中间件作用 由于项目的特殊，此项目是一个存在微信端的。所以需要检测是需要账号密...
Laravel 5.5 使用 Jwt-Auth 实现 API 用户认证以及无痛刷新访问令牌
weixin_34257076的博客
12-27 428
最近在做一个公司的项目，前端使用 Vue.js，后端使用 Laravel 构建 Api 服务，用户认证的包本来是想用 Laravel Passport 的，但是感觉有点麻烦，于是使用了 jwt-auth 。 安装 jwt-auth 最新版本是 1.0.0 rc.1 版本，已经支持了 Laravel 5.5。如果你使用的是 Lara...
laravel可刷新token
gztrljh
12-12 316
https://www.cnblogs.com/daizhongxing/p/11424343.html
php7+jwt+token+刷新,laravel 使用jwt一些坑，token过期？刷新返回前端？问题多多！...
weixin_34472954的博客
03-17 565
在使用laravel时候 摒弃了自带的Auth和passport。主要原因是项目前后端分离，后端写api接口，另外email不做登录选项，password和用户信息存储分开存。在使用JWT过程中遇到很多的坑。坑1 不能用JWTAuth静态调用直接public function xxx (JWTAuth $jwt){$jwt->xxx;}这里的JWTAuth是use Tymon\JWTAut...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值