hyperf的96qbhy/hyperf-auth组件使用记录

最近项目使用hyperf框架，以前没接触过，写个文章记录下过程，若有错误，请大佬们指正。

关于96qbhy/hyperf-auth组件，文档上的介绍：参考 laravel 的 auth 组件设计，支持 jwt 和 session驱动，更轻巧更好用

github地址：https://github.com/qbhy/hyperf-auth

首先安装：composer require 96qbhy/hyperf-auth

开始使用：
一，新建用户表user

图片.png

创建user模型

php bin/hyperf.php gen:model user

user模型继承Authenticatable接口类

namespace App\Model;
use Hyperf\DbConnection\Model\Model;
use Qbhy\HyperfAuth\Authenticatable;
class User extends Model implements Authenticatable

在user实现接口类的2的方法,在权限认证的时候要用到，我们先不写具体逻辑

    public function getId()
    {
        // TODO: Implement getId() method.
    }
 
    public static function retrieveById($key): ?Authenticatable
    {
        // TODO: Implement retrieveById() method.
    }

二、发布配置，发布成功会在config/autoload目录下生成auth.php配置文件

php bin/hyperf.php vendor:publish 96qbhy/hyperf-auth

可在config/autoload/auth.php修改有效期、缓存驱动等或者自定义自己的guard也可以

图片.png

default：是默认配置，可在这边修改默认采用配置
default.provider 默认用户表配置
在配置最下方有个providers.users.model配置，若使用其他用户模型，需要修改对于的模型类

图片.png

guards.jwt.secret没有默认值，需要在env添加值，或者增加默认值。下面采用增加默认值写法

/*
 * 以下是 simple-jwt 配置
* 必填
* jwt 服务端身份标识
*/
'secret' => env('SIMPLE_JWT_SECRET', 'jwt_server'),

三、实现用户模型里的getId()与retrieveById()

public function getId()
    {
        // 返回用户id
        return $this->id;
    }

    public static function retrieveById($key): ?Authenticatable
    {
        // 通过id查找用户
        return self::query()->find($key);
    }
}

四、使用
在IndexController控制器下创建方法login

    public function login()
    {
        // 获取指定用户对象，不存在则插入并返回用户对象
        $user = User::query()->firstOrCreate(['name' => 'test']);
        // auth('guard') || auth()->guard('session'); 不设置guard，则使用默认的配置
        $token = auth()->login($user);

        return [
            'token' => $token,
            'test' => auth()->ttl,
            'date' => date('Y-m-d H:i:s')
        ];
    }
    // 推出登录，token失效
    public function logout()
    {
        auth()->logout();
        return 'logout ok';
    }

    public function user()
    {
        $user = auth()->user();
//        var_dump($user);
        return 'hello '.$user->name;
    }
    // 刷新token，旧token就会失效
    public function retrieve()
    {
        $token = auth()->refresh();
        return [
            'token' => $token,
            'date' => date('Y-m-d H:i:s')
        ];
    }

Auth 可通过注解、中间件用法、全局函数等方法获取，具体可以查看github上的用例
添加登录验证中间件

php ./bin/hyperf.php gen:middleware Auth

编辑Auth中间件

增加以下路由信息

Router::addRoute(['GET', 'POST', 'HEAD'], '/login', 'App\Controller\IndexController@login');
Router::addGroup('',function (){
    Router::addRoute(['GET', 'POST', 'HEAD'], '/logout', 'App\Controller\IndexController@logout');
    Router::addRoute(['GET', 'POST', 'HEAD'], '/user', 'App\Controller\IndexController@user');
    Router::addRoute(['GET', 'POST', 'HEAD'], '/retrieve', 'App\Controller\TestController@retrieve');
},['middleware' => [\App\Middleware\Auth::class]]);

启动/重启服务，访问登录拿到路由http://127.0.0.1:9501/login

图片.png

获取用户信息，在headers里。添加参数Authorization，值="Bearer "+token，注意Bearer后面有个空格

图片.png