spanbin / think-auth
auth package for thinkphp5
Requires
- php: >=5.4.0
- topthink/framework: ^5.1
This package is auto-updated.
Last update: 2024-09-08 20:01:50 UTC
README
The ThinkPHP5 Auth Package
安装
composer require spanbin/think-auth
配置
公共配置
// auth配置
'auth' => [
'auth_on' => 1, // 权限开关
'auth_type' => 1, // 认证方式,1为实时认证;2为登录认证。
'auth_group' => 'auth_group', // 用户组数据不带前缀表名
'auth_group_access' => 'auth_group_access', // 用户-用户组关系不带前缀表名
'auth_rule' => 'auth_rule', // 权限规则不带前缀表名
'auth_user' => 'auth_user', // 用户信息不带前缀表名
],
导入数据表
tp_
为自定义的数据表前缀
-- ----------------------------
-- Table structure for tp_auth_group
-- ----------------------------
DROP TABLE IF EXISTS `tp_auth_group`;
CREATE TABLE `tp_auth_group` (
`id` mediumint(8) NOT NULL AUTO_INCREMENT COMMENT 'id',
`title` char(100) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT '标题',
`status` tinyint(1) NOT NULL COMMENT '启用',
`rules` text CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT '节点权限规则',
`data_rules` text CHARACTER SET utf8 COLLATE utf8_general_ci COMMENT '数据权限规则',
`sort` decimal(18,2) DEFAULT NULL COMMENT '排序',
`rem` varchar(2000) CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL COMMENT '备注',
PRIMARY KEY (`id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8 COMMENT='角色表';
-- ----------------------------
-- Table structure for tp_auth_group_access
-- ----------------------------
DROP TABLE IF EXISTS `tp_auth_group_access`;
CREATE TABLE `tp_auth_group_access` (
`uid` mediumint(8) NOT NULL COMMENT '用户id',
`group_id` mediumint(8) NOT NULL COMMENT '用户组id',
PRIMARY KEY (`uid`,`group_id`) USING BTREE,
KEY `fk_tp_auth_group_access_tp_auth_group_1` (`group_id`) USING BTREE,
CONSTRAINT `fk_tp_auth_group_access_tp_auth_group_1` FOREIGN KEY (`group_id`) REFERENCES `tp_auth_group` (`id`) ON DELETE CASCADE ON UPDATE CASCADE,
CONSTRAINT `fk_tp_auth_group_access_tp_auth_user_1` FOREIGN KEY (`uid`) REFERENCES `tp_auth_user` (`uid`) ON DELETE CASCADE ON UPDATE CASCADE
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='用户和角色组中间表';
-- ----------------------------
-- Table structure for tp_auth_rule
-- ----------------------------
DROP TABLE IF EXISTS `tp_auth_rule`;
CREATE TABLE `tp_auth_rule` (
`id` mediumint(8) NOT NULL AUTO_INCREMENT COMMENT 'id',
`name` char(80) CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL COMMENT '规则标识',
`title` char(80) CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL COMMENT '规则名称',
`type` tinyint(1) DEFAULT NULL COMMENT '规则类型',
`status` tinyint(1) DEFAULT NULL COMMENT '启用状态',
`condition` char(100) CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL COMMENT '规则表达式',
PRIMARY KEY (`id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=248 DEFAULT CHARSET=utf8 COMMENT='系统路由规则表';
-- ----------------------------
-- Table structure for tp_auth_user
-- ----------------------------
DROP TABLE IF EXISTS `tp_auth_user`;
CREATE TABLE `tp_auth_user` (
`id` int(11) NOT NULL AUTO_INCREMENT COMMENT 'id',
`uid` mediumint(8) DEFAULT NULL COMMENT '用户id',
`user_code` varchar(10) DEFAULT NULL COMMENT '账号',
`user_name` varchar(30) DEFAULT NULL COMMENT '用户名',
`password` varchar(32) DEFAULT NULL COMMENT '密码',
`status` tinyint(1) DEFAULT NULL COMMENT '启用',
`last_login_time` datetime DEFAULT NULL COMMENT '最后登录时间',
`last_login_ip` varchar(20) DEFAULT NULL COMMENT '最后登录ip',
`identity_type` int(11) DEFAULT NULL COMMENT '身份类型',
`identity` int(11) DEFAULT NULL COMMENT '身份',
`client_id` int(11) DEFAULT NULL COMMENT '客户端id',
`secret` varchar(50) DEFAULT NULL COMMENT '凭证密钥',
`rem` varchar(2000) DEFAULT NULL COMMENT '备注',
PRIMARY KEY (`id`) USING BTREE,
UNIQUE KEY `i_tp_auth_user_uid` (`uid`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=6 DEFAULT CHARSET=utf8 COMMENT='用户表';
原理
Auth权限认证是按规则进行认证。 在数据库中我们有
- 规则表(think_auth_rule)
- 用户组表(think_auth_group)
- 用户组明显表(think_auth_group_access)
我们在规则表中定义权限规则, 在用户组表中定义每个用户组有哪些权限规则,在用户组明显表中定义用户所属的用户组。
下面举例说明:
我们要判断用户是否有显示一个操作按钮的权限, 首先定义一个规则, 在规则表中添加一个名为 show_button 的规则。 然后在用户组表添加一个用户组,定义这个用户组有show_button 的权限规则(think_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\Controller;
use think\auth\Auth;
class Base extends Controller
{
public function _initialize()
{
$controller = request()->controller();
$action = request()->action();
$auth = new Auth();
if(!$auth->check($controller . '-' . $action, session('uid'))){
$this->error('你没有权限访问');
}
}
}
这时候我们可以在数据库中添加的节点规则, 格式为: “控制器名称-方法名称”
Auth 类 还可以多个规则一起认证 如:
$auth->check('rule1,rule2',uid);
表示 认证用户只要有rule1的权限或rule2的权限,只要有一个规则的权限,认证返回结果就为true 即认证通过。 默认多个权限的关系是 “or” 关系,也就是说多个权限中,只要有个权限通过则通过。 我们也可以定义为 “and” 关系
$auth->check('rule1,rule2',uid,'and');
第三个参数指定为"and" 表示多个规则以and关系进行认证, 这时候多个规则同时通过认证才有权限。只要一个规则没有权限则就会返回false。
Auth认证,一个用户可以属于多个用户组。 比如我们对 show_button这个规则进行认证, 用户A 同时属于 用户组1 和用户组2 两个用户组 , 用户组1 没有show_button 规则权限, 但如果用户组2 有show_button 规则权限,则一样会权限认证通过。
$auth->getGroups(uid)
通过上面代码,可以获得用户所属的所有用户组,方便我们在网站上面显示。
Auth类还可以按用户属性进行判断权限, 比如 按照用户积分进行判断, 假设我们的用户表 (think_members) 有字段 score 记录了用户积分。 我在规则表添加规则时,定义规则表的condition 字段,condition字段是规则条件,默认为空 表示没有附加条件,用户组中只有规则 就通过认证。 如果定义了 condition字段,用户组中有规则不一定能通过认证,程序还会判断是否满足附加条件。 比如我们添加几条规则:
name
字段:grade1condition
字段:{score}<100
name
字段:grade2condition
字段:{score}>100 and {score}<200
name
字段:grade3condition
字段:{score}>200 and {score}<300
这里 {score}
表示 think_members
表 中字段 score
的值。
那么这时候
$auth->check('grade1', uid) 是判断用户积分是不是0-100
$auth->check('grade2', uid) 判断用户积分是不是在100-200
$auth->check('grade3', uid) 判断用户积分是不是在200-300