ltxlong/thinkphp6-auth

auth package for thinkphp6

1.0.0 2021-08-03 12:51 UTC

This package is not auto-updated.

Last update: 2024-05-08 19:29:47 UTC


README

auth package for thinkphp6

安装

composer require ltxlong/thinkphp6-auth

配置

// auth配置  自定义数据表位置在 ./config/auth.php里面
[
    'auth_on'           => 1, // 权限开关
    'auth_type'         => 1, // 认证方式,1为实时认证;2为登录认证。
    'auth_group'        => 'auth_group', // 用户组数据表(不带前缀表名)
    'auth_group_access' => 'auth_group_access', // 用户-用户组关系表(不带前缀表名)
    'auth_rule'         => 'auth_rule', // 权限规则表(不带前缀表名)
    'auth_user'         => 'user', // 用户信息表(不带前缀表名)
]
// 注意:condition里的变量是用户表(配置auth_user的值的表,通常配置为用户表)的字段
// (当然,不配置auth_user的值为用户表,而是其他表,那也行的!但是,condition里的变量只能是配置的表里面的字段)
// (如配置auth_user的值为integral积分表,那么condition里的变量就只能是integral表里面的字段)
// condition里的变量用花括号括住,如:{score}

// 表的前缀在框架的数据库配置那配置,这里的配置的表都是不带前缀的

导入数据表

----------------------------------------------------------------------------
-- auth_rule,规则表,
-- id:主键,
-- name:规则唯一标识, title:规则中文名称 status 状态:为1正常,为0禁用
-- name 可以自定义名称,也可以是模块/控制器/方法、模块_控制器_方法、控制器/方法、控制器_方法、控制器-方法
-- condition:规则表达式,为空表示存在就验证,不为空表示按照条件验证
-- condition 简单来说,如果字段为空,则只验证name就行;如果字段不为空,则在验证了name的基础上,还要验证字段里面的条件
-- condition 条件,是user表的字段条件(准确来说,是auth_user配置的表),如 {score} > 10
----------------------------------------------------------------------------
DROP TABLE IF EXISTS `auth_rule`;
CREATE TABLE `auth_rule` (
    `id` mediumint(8) unsigned NOT NULL AUTO_INCREMENT,
    `name` varchar(80) NOT NULL DEFAULT '',
    `title` varchar(20) NOT NULL DEFAULT '',
    `status` tinyint(1) NOT NULL DEFAULT 1,
    `condition` varchar(100) NOT NULL DEFAULT '',
    PRIMARY KEY (`id`),
    UNIQUE KEY `name` (`name`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
----------------------------------------------------------------------------
-- auth_group 用户组表,
-- id:主键, title:用户组中文名称, rules:用户组拥有的规则id, 多个规则","隔开,status 状态:为1正常,为0禁用
----------------------------------------------------------------------------
DROP TABLE IF EXISTS `auth_group`;
CREATE TABLE `auth_group` (
    `id` mediumint(8) unsigned NOT NULL AUTO_INCREMENT,
    `title` varchar(100) NOT NULL DEFAULT '',
    `status` tinyint(1) NOT NULL DEFAULT 1,
    `rules` varchar(80) NOT NULL DEFAULT '',
    PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
----------------------------------------------------------------------------
-- auth_group_access 用户-用户组关系表
-- uid:用户id,group_id:用户组id
----------------------------------------------------------------------------
DROP TABLE IF EXISTS `auth_group_access`;
CREATE TABLE `auth_group_access` (
    `uid` mediumint(8) unsigned NOT NULL,
    `group_id` mediumint(8) unsigned NOT NULL,
    UNIQUE KEY `uid_group_id` (`uid`,`group_id`),
    KEY `uid` (`uid`),
    KEY `group_id` (`group_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

原理

Auth权限认证是按规则进行认证。 在数据库中我们有

  • 规则表(auth_rule)
  • 用户组表 (auth_group)
  • 用户-用户组关系表(auth_group_access)

我们在规则表中定义权限规则, 在用户组表中定义每个用户组有哪些权限规则,在用户组明显表中定义用户所属的用户组。

下面举例说明:

我们要判断用户是否有显示一个操作按钮的权限, 首先定义一个规则, 在规则表中添加一个名为 show_button 的规则。 然后在用户组表添加一个用户组,定义这个用户组有show_button 的权限规则(auth_group表中rules字段存得时规则ID,多个以逗号隔开), 然后在用户组明细表定义 UID 为1 的用户 属于刚才这个的这个用户组。

使用

判断权限方法

// 引入类库
use think\auth\Auth;

// 获取auth实例
$auth = Auth::instance();

// 检测权限
if ($auth->check('show_button', 1)) { // 第一个参数是规则名称, 第二个参数是用户UID
	//有显示操作按钮的权限
} else {
	//没有显示操作按钮的权限
}

Auth类也可以对节点进行认证,我们只要将规则名称,定义为节点名称就行了。 可以在自定义的公共控制器Base中定义_initialize方法

<?php

use think\auth\Auth;
use app\BaseController;

class adminBaseController extends BaseController
{
    public function _initialize()
	  {
        parent::initialize();
        $controller = request()->controller();
        $action = request()->action();
        $auth = new Auth();
        if(!$auth->check($controller . '/' . $action, session('uid'))){
          $this->error('你没有权限访问');
        }
    }
}

这时候我们可以在数据库中添加的节点规则, 格式为: “控制器名称/方法名称”

使用了多应用的情况下,如果想获取当前模块名称,可以这样:

$module = app('http')->getName();

Auth 类 还可以多个规则一起认证 如:

$auth->check(['rule1', 'rule2'], uid); 

或者

$auth->check('rule1,rule2', uid); 

表示 认证用户只要有rule1的权限或rule2的权限,只要有一个规则的权限,认证返回结果就为true 即认证通过。 默认多个权限的关系是 “or” 关系,也就是说多个权限中,只要有个权限通过则通过。

我们也可以定义为 “and” 关系

$auth->check(['rule1', 'rule2'], uid, 'and'); 

或者

$auth->check('rule1,rule2', uid, 'and'); 

Auth认证,一个用户可以属于多个用户组。 比如我们对 show_button这个规则进行认证, 用户A 同时属于 用户组1 和用户组2 两个用户组 , 用户组1 没有show_button 规则权限, 但如果用户组2 有show_button 规则权限,则一样会权限认证通过。

$auth->getGroups(uid)

通过上面代码,可以获得用户所属的所有用户组,方便我们在网站上面显示。

Auth类还可以按用户属性进行判断权限, 比如 按照用户积分进行判断, 假设我们的用户表 (user) 有字段 score 记录了用户积分。 我在规则表添加规则时,定义规则表的condition 字段,condition字段是规则条件,默认为空 表示没有附加条件,用户组中只有规则 就通过认证。 如果定义了 condition字段,用户组中有规则不一定能通过认证,程序还会判断是否满足附加条件。 比如我们添加几条规则:

name字段:grade1 condition字段:{score}<100

name字段:grade2 condition字段:{score}>100 && {score}<200

name字段:grade3 condition字段:{score}>200 && {score}<300

这里 {score} 表示 user 表 中字段 score 的值。

那么这时候

$auth->check('grade1', uid) 是判断用户积分是不是0-100

$auth->check('grade2', uid) 判断用户积分是不是在100-200

$auth->check('grade3', uid) 判断用户积分是不是在200-300

condition 支持的运算符号:

>= > <= < && == || !=

注意:condition表达式不支持括号(),不支持单引号'',也不支持双引号""

复杂点的condition:

{score}<50 && {score}<100 || {name}!=abc

最后

因为觉得eval()函数不安全,所以自己写了个简单的函数来运算condition