Lumen用户认证JWT,源码解读

了不起的厂长 2019-06-27

最近的一个PHP项目,上一个项目是采用ThinkPHP来弄的,因为很早就听说过Laravel的大名,所以进了Laravel的官网,意外发现了Lumen,正好我项目是提供API的,所以选择了Lumen,因为是Laravel的精简版,看了几天的Laravel文档,也总结出了自己的一些经验,不权威:
1、Larave的核心是服务容器,服务容器的主要功能是依赖注入
2、Laravel的各部分功能以组件形式提供,需要什么注入什么
下面进入正题JWT认证,感谢学习 Lumen 用户认证 (二) —— 使用 jwt-auth 插件这篇文章对我的帮助。

如何做用户认证?
根据Laravel文档描述,Laravel提供用户认证的接口,他的核心是看守器(Guard)提供器(Provider),看守器定义怎么认证用户,提供器定义怎么检索用户。

首先创建项目lumen new jwt-demo,然后进入jwt-demo目录,执行composer require tymon/jwt-auth:1.0.0-rc.2,在项目根目录下创建config文件夹,并将vender/laravel中的auth.php拷贝到config目录下,auth.php文件内容如下:

Lumen用户认证JWT,源码解读

然后修改boostrap/app.php文件,添加如下配置

Lumen用户认证JWT,源码解读

修改路由文件routers/web.php

Lumen用户认证JWT,源码解读

一定要使用jwt.auth中间件,然后在Controllers目录下新建App/AuthController.php文件,文件内容如下:

Lumen用户认证JWT,源码解读

修改app/Exceptions/Handler.php文件

Lumen用户认证JWT,源码解读

然后浏览器访问域名/auth/home,结果如下:

Lumen用户认证JWT,源码解读


那么现在从源码看一下401是怎么来的?

Lumen用户认证JWT,源码解读

这里定义了这个路由,要经过jwt.auth这个中间件,下一步这个中间件在哪里定义的呢,

Lumen用户认证JWT,源码解读

可以看到在LumenServiceProvider中有$this->app->routeMiddleware($this->middlewareAlias)这么一句,

Lumen用户认证JWT,源码解读

可以看到在这里是定义了一个名为jwt.auth的路由中间件,对应Tymon\JWTAuth\Http\Middleware\Authenticate这个类,看一下这个类的实现

Lumen用户认证JWT,源码解读

可以看到是通过$this->authenticate这个方法进行验证的,那么现在看下这个方法的实现

Lumen用户认证JWT,源码解读

可以看到这里有两个方法,checkForToken用来验证是否存在token,如果不存在则抛出异常,如果存在则进入$this->auth->parseToken()->authenticate()用来验证token是否合法,怎么验证token是否存在这里不做讨论,我们来看下他是怎么验证token是否合法的,跟踪代码发现执行的事JWTAuth类的下面方法

Lumen用户认证JWT,源码解读

可以看到首先从payload中获得id值,然后通过id检索用户,如果检索成功,返回false,token不合法,否则返回检索到的用户,token合法,那么跟踪一下检索用户的代码,最终进入的是JWTGuard类的如下方法

Lumen用户认证JWT,源码解读

$this->provider就是我们在config/auth.php中配置的

Lumen用户认证JWT,源码解读

eloquent,对应的类是EloquentUserProvider,我们看下它的retrieveById方法,实现如下

Lumen用户认证JWT,源码解读

这里就已经在从数据库中查找用户,在实际研发中对于数据库的查找我们可能有自己的逻辑,那么我们只能去实现我们自己的Provider然后去替换掉JWTGuard中的Provider,那么这一步该怎么做呢?
bootstrap/app.php有这么一句$app->register(Tymon\JWTAuth\Providers\LumenServiceProvider::class);,我们可以看下LumenServiceProvider的源码,

Lumen用户认证JWT,源码解读

可以看到有这么一个方法,我们可以去看下他的实现,

Lumen用户认证JWT,源码解读

可以看到这里传入了Provider,那么我们看一下AuthManager的createUserProvider方法

Lumen用户认证JWT,源码解读

程序会先去读取Provider的配置信息,也就是auth.php中的

Lumen用户认证JWT,源码解读

这么一部分,然后判断customProviderCreators中是否存在对应的Guard的驱动,如果存在则根据驱动创建用户自定义Provider,否则判断driver是否为datebase或者eloquent,如果也不成立则抛出异常,否则创建DatebaseProvider或者EloquentProvider,那么根据这么一段代码,我们只需要在auth.php配置好自己的驱动,然后将我们自己的Provider实现类注入到customProviderCreators去就可以了,那么怎么注入呢,在AuthManager中有这么一个方法

Lumen用户认证JWT,源码解读

至此如何自定义Provider就解决了,现在就来实战一下,自定义的Provider代码如下,

Lumen用户认证JWT,源码解读

参照EloquentUserProviderDatebaseUserProvider可知需要实现UserProvider接口,为了方便,我就直接继承DatebaseUserProvider了,重写了retrieveById方法,默认返回true,首先修改auth.php中的provider的drivermy,然后就是注入MyJWTUserProvider了,在app/Jwt目录下新建一个MyLumenServiceProvider,代码如下

Lumen用户认证JWT,源码解读

最后将boostrap/app.php中register的LumenServiceProvider改为MyLumenServiceProvider

至此JWT还剩下一个生成用户验证返回token的过程

相关推荐