dh2y/think-auth

为 thinkphp5 提供认证和身份管理

2.4 2021-01-12 13:02 UTC

This package is auto-updated.

Last update: 2024-09-12 20:54:48 UTC


README

ThinkPHP5 认证和身份管理

安装

一、执行以下命令进行安装

composer require dh2y/think-auth

或者

二、使用 require 安装

2-1、 5.0 版本安装

"require": {
        "dh2y/think-auth":"1.*"
},

2-2、 5.1 版本安装

"require": {
        "dh2y/think-auth":"2.*"
},

或者

三、按照 psr-4 标准进行自动加载安装

   a) 进入vendor/dh2y目录 (没有dh2y目录 mkdir dh2y)
   b) git clone 
   c) 修改 git clone下来的项目名称为think-auth
   d) 添加下面配置
   "autoload": {
        "psr-4": {
            "think\\auth\\": "vendor/dh2y/think-auth/src"
        }
    },
    e) php composer.phar update

配置

公共配置

// 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' => 'admin', // 用户信息表
    'menu' =>'menu'
],

导入数据表

think_ 为自定义的数据表前缀

------------------------------
-- think_auth_rule,规则表,
-- id:主键,name:规则唯一标识, title:规则中文名称 status 状态:为1正常,为0禁用,condition:规则表达式,为空表示存在就验证,不为空表示按照条件验证
------------------------------
 DROP TABLE IF EXISTS `think_auth_rule`;
CREATE TABLE `think_auth_rule` (  
    `id` mediumint(8) unsigned NOT NULL AUTO_INCREMENT,
      `name` char(80) NOT NULL DEFAULT '',
      `title` char(20) NOT NULL DEFAULT '',
      `status` tinyint(1) NOT NULL DEFAULT '1',
      `condition` char(100) NOT NULL DEFAULT '',
      `mid` int(8) NOT NULL,
      PRIMARY KEY (`id`),
      UNIQUE KEY `name` (`name`) USING BTREE
) ENGINE=MyISAM  DEFAULT CHARSET=utf8;
------------------------------
-- think_auth_group 用户组表, 
-- id:主键, title:用户组中文名称, rules:用户组拥有的规则id, 多个规则","隔开,status 状态:为1正常,为0禁用
------------------------------
 DROP TABLE IF EXISTS `think_auth_group`;
CREATE TABLE `think_auth_group` ( 
   `id` mediumint(8) unsigned NOT NULL AUTO_INCREMENT,
     `title` char(100) NOT NULL DEFAULT '',
     `status` tinyint(1) NOT NULL DEFAULT '1',
     `rules` char(80) NOT NULL DEFAULT '',
     PRIMARY KEY (`id`)
) ENGINE=MyISAM  DEFAULT CHARSET=utf8;
------------------------------
-- think_auth_group_access 用户组明细表
-- uid:用户id,group_id:用户组id
------------------------------
DROP TABLE IF EXISTS `think_auth_group_access`;
CREATE TABLE `think_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=MyISAM DEFAULT CHARSET=utf8;

CREATE TABLE `think_auth__menu` (
  `id` smallint(6) NOT NULL AUTO_INCREMENT,
  `pid` smallint(6) NOT NULL DEFAULT '0',
  `title` varchar(20) NOT NULL COMMENT '菜单名称',
  `link` varchar(50) DEFAULT NULL COMMENT '链接',
  `icon` varchar(50) DEFAULT NULL COMMENT '字体图标',
  `sort` smallint(6) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=MyISAM AUTO_INCREMENT=28 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 字段:grade1 condition 字段:{score}<100
name 字段:grade2 condition 字段:{score}>100 and {score}<200
name 字段:grade3 condition 字段:{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