袁来如此的工作笔记
袁来如此的工作笔记
竹杖芒鞋轻胜马,谁怕? 一蓑烟雨任平生。

ThinkPHP6 API开发前后端分离用户信息保存在后端的方法

浏览量:59

Session在开发API的情况下官方是不推荐用的,那么问题来了,用户信息怎么保存呢?下面来记录一下我的写法。

首先我用的是JWT插件对token进行生成及验证,话不多说,撸起袖子搞起来。

首先写登录文件,我的文件创建在app/controller/admin/Login.php,创建完成之后在里面我写了一个login方法,内容如下:

    public function login(Request $request): Response
    {
        //用$data接收前端发送过来的数据
        $data = $request->param();
        //这里我用的是验证器来验证管理员账号密码是否正确
        $result = Validate::rule([
            'username' => 'unique:system_user,username^password'
        ])->check([
            'username' => $data['username'],
            'password' => sha1($data['password'])
        ]);
        //判断账号密码是否正确
        if(!$result){
            //账号密码正确的话,获取账号信息
            $userInfo = SystemUser::where('username',$data['username'])->field('id,username,nickname')->find();
            //将获取到的账号信息进行生成Token数据并保存
            $token = signToken($userInfo);
            //写入日志
            $data['userId'] = $userInfo['id'];
            $data['nickname'] = $userInfo['nickname'];
            这里是写入日志的方法,自行创建就行
            $this->log($data,true);
            return create(['access_token' => $token],'登录成功');
        }else{
            //写入日志
            $this->log($data,false);
            return create([],'账号或密码错误,请重新输入',400);
        }
    }
接下来Token的生成与验证了,我给他写在了公共文件里,需要注意的是我们要先安装JWT插件

安装JWT的方法:

composer require firebase/php-jwt
安装完成之后我们需要引入JWT插件 

use Firebase\JWT\JWT;
use Firebase\JWT\SignatureInvalidException;
use Firebase\JWT\BeforeValidException;
use Firebase\JWT\ExpiredException;
下面就是我在公共方法写的生成与验证的方法

//这里是生成Token的方法,我们接收传来的用户信息
function signToken($userInfo): string
{
    $key = '!@#$%*&';         //这里是自定义的一个随机字串,应该写在config文件中的,解密时也会用,相当    于加密中常用的 盐  salt
    $token = array(
        "iss"=>$key,        //签发者 可以为空
        "aud"=>'',          //面象的用户,可以为空
        "iat"=>time(),      //签发时间
        "nbf"=>time()+3,    //在什么时候jwt开始生效  (这里表示生成100秒后才生效)
        "exp"=> time()+14400, //token 过期时间
        "data"=>[           //记录的userid的信息,这里是自已添加上去的,如果有其它信息,可以再添加数组的键值对
            //token携带的信息,从方法传进来的,如需扩展自定义添加
            'userId'=>$userInfo['id'],    //用户ID
            'username'=>$userInfo['username']    //登录账号
        ]
    );
    return JWT::encode($token, $key, "HS256");  //根据参数生成了 token
}
 
//这里是验证Token的方法
function checkToken($token): array
{
    $key = '!@#$%*&';
    $status = array("code" => 2);
    try {
        JWT::$leeway = 60;//当前时间减去60,把时间留点余地
        $decoded = JWT::decode($token, $key, array('HS256')); //HS256方式,这里要和签发的时候对应
        $arr = (array)$decoded;
        $res['code'] = 1;
        $res['data'] = $arr['data'];
        return $res;
 
    } catch(SignatureInvalidException $e) { //签名不正确
        $status['msg'] = "签名不正确";
        return $status;
    }catch(BeforeValidException $e) { // 签名在某个时间点之后才能用
        $status['msg'] = "token失效";
        return $status;
    }catch(ExpiredException $e) { // token过期
        $status['msg'] = "token过期";
        return $status;
    }catch(Exception $e) { //其他错误
        $status['msg'] = $e;
        return $status;
    }
}
好了,登录与Token的东西都已经搞定了,接下来我们就是要在TP6里面存储我们的用户信息,撸起袖子看代码

第一步,创建登录验证的中间件:app/middleware/LoginCheck.php,代码如下:

<?php
declare (strict_types = 1);
 
namespace app\middleware;
 
use app\BaseController;
use think\Request;
use think\Response;
 
class LoginCheck extends BaseController
{
    /**
     * 处理请求
     *
     * @param Request       $request
     * @param Closure       $next
     * @return Response
     */
    public function handle(Request $request, \Closure $next): Response
    {
        //获取访问用户的token,我这里用的是authorization字段,大家根据自己的项目实况
        $token = $request->header('authorization');
        //因为前后端分离规范的问题,加上JWT校验的格式,提交来的Token前面携带的Bearer我给干掉
        $token = str_replace('Bearer ','',$token);
        //干掉之后就可以丢给JWT去验证这个Token是否有效了
        $result = checkToken($token);
        //验证token是否正确
        if($result['code'] !== 1){
            return create([],'请登录后在进行操作',401);
        }else{
            //验证完成之后我们给返回的用户信息写入到request里面
            $request->userInfo = $result['data'];
            return $next($request);
        }
    }
}
第二步,创建控制器的基类:app/controller/AuthBase.php,里面的代码写法:

<?php
 
namespace app\controller;
use app\BaseController;
use think\App;
use think\facade\Request;
 
class AuthBase extends BaseController
{
    //在基类设置并调用中间件
    protected $middleware = [
        'LoginCheck'
    ];
 
 
    public function __construct(App $app)
    {
        parent::__construct($app);
    }
}
好了,到此所有的代码都撸完了,接下来我们在其他方法如果想调用当前登录的用户信息,只需要调用:

//调用方法
request()->userInfo;
 
//返回的对象
^ {#83
  +"userId": 1
  +"username": "admin"
}
打赏