php 利用反射机制完成动态用户权限(RBAC)

傷城~ 2023-02-20 02:21 45阅读 0赞

**关于权限设计的概念，相信在每个做后台开发的都会有所涉及，实现方式也是千差万别，各有各的优缺点。普通基于角色的权限控制，需要后台手动添加权限，当系统庞大的时候，一条条的加无疑是一场灾难…。今天我们使用另一种方式：反射 来做一个小的权限管理Demo**

开始前，我们先做一个小小的案例，让大家理解其中的关系

<?php
    
    /** * demo类 * Class demo *@package app\admin\controller */
    class demo{ 
    
        /** *这是语文课 * @auth true */
        public function yuwen(){ 
            echo '我是语文课';
        }
    
        /** * 这是数学课 * @auth true */
        public function shuxue(){ 
            echo '我是数学课';
        }
    
        /** * 这是英语课 * @auth false * @menu true */
        public function yingyu(){ 
            echo '我是英语课';
        }
    
        private function tiyu(){ 
            echo '我是体育课';
        }
    
    }
    
    $obj = new demo();
    $reflect = new ReflectionClass($obj); //此类为反射类
    
    //获取类的注释
    echo '<pre>';
    //正则匹配获取类名注释
    $class_name =  preg_replace('/^\/\*\*\*(.*?)\*.*?$/', '$1', preg_replace("/\s/", '', $reflect->getDocComment()));
    var_dump($class_name);
    获取类方法的注释的参数
    $methods =  $reflect->getMethods(ReflectionMethod::IS_PUBLIC);
    foreach($methods as $k=>$v){ 
        $action = strtolower($v->getName());
        //正则匹配其方法内的注释参数
        list($node, $comment) = ["{ $action}", preg_replace("/\s/", '', $v->getDocComment())];
         $nodes =  $v->getDocComment();
         $note_param = [
             'auth'  => stripos($comment, '@authtrue') !== false,
             'menu'  => stripos($comment, '@menutrue') !== false,
         ];
        var_dump($nodes);
        var_dump($note_param);
         echo PHP_EOL;
         echo PHP_EOL;
    }

运行后，可以看到类中的注释和打印的数据一一对应  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA_size_16_color_FFFFFF_t_70]  
通过上面的代码，我们大概已经清楚其中的原理，并且能拿到其注释中的一些参数，接下来的权限，原理跟上方是一样的

--------------------

接下来，我们开始实现功能，为了模拟真实项目的环境，我们有一些配置，需要定义在 **.env** 文件下  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA_size_16_color_FFFFFF_t_70 1]

定义好 **.env** 文件中  
我们需要新建一些控制器，其目录结构如下  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA_size_16_color_FFFFFF_t_70 2]  
**重点来了，在控制器代码中，我们需要使用到以下这种方式作为注释**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA_size_16_color_FFFFFF_t_70 3]

接下来，我们在根目录下定义反射类文件，去反射控制器中的注释

<?php
    /** * Created by PhpStorm. * User: Administrator * Date: 2020-06-23 * Time: 10:41 */
    
    
    /** * 加载 .env文件 * @param $path * @return null */
    function env($path){ 
        $env =  parse_ini_file($_SERVER['DOCUMENT_ROOT'].'/reflect/.env',true);
    
        return isset($env[$path]) ? $env[$path] :null;
    }
    
    class NodeService
    { 
    
        /** * 获取授权节点列表 * @param array $checkeds * @return array * @throws \ReflectionException */
        public static function getAuthTree($checkeds = [])
        { 
            static $nodes = [];
            if (count($nodes) > 0) return $nodes;
            foreach (self::getAuthList() as $node => $title) { 
                $pnode = substr($node, 0, strripos($node, '/'));
                $nodes[$node] = ['node' => $node, 'title' => $title, 'pnode' => $pnode, 'checked' => in_array($node, $checkeds)];
            }
            foreach (self::getClassList() as $node => $title){ 
                foreach (array_keys($nodes) as $key) { 
                    if (stripos($key, "{ $node}/") !== false) { 
                        $pnode = substr($node, 0, strripos($node, '/'));
                        $nodes[$node] = ['node' => $node, 'title' => $title, 'pnode' => $pnode, 'checked' => in_array($node, $checkeds)];
                        $nodes[$pnode] = ['node' => $pnode, 'title' => ucfirst($pnode), 'checked' => in_array($pnode, $checkeds)];
                    }
                }
            }
            return $nodes = self::arr2tree($nodes, 'node', 'pnode', '_sub_');
        }
    
        /** * 获取授权节点列表 * @return array * @throws \ReflectionException */
        public static function getAuthList()
        { 
            static $nodes = [];
            foreach (self::getMethodList() as $key => $node) { 
                if ($node['auth']) $nodes[$key] = $node['title'];
            }
            return $nodes;
        }
    
    
        /** * 获取控制器节点列表 * @return array * @throws \ReflectionException */
        public static function getClassList()
        { 
            $nodes = [];
            self::eachController(function (\ReflectionClass $reflection, $prenode) use (&$nodes) { 
                list($node, $comment) = [trim($prenode, ' / '), $reflection->getDocComment()];
                $nodes[$node] = preg_replace('/^\/\*\*\*(.*?)\*.*?$/', '$1', preg_replace("/\s/", '', $comment));
                if (stripos($nodes[$node], '@') !== false) $nodes[$node] = '';
            });
            return $nodes;
        }
    
        /** * 获取方法节点列表 * @return array * @throws \ReflectionException */
        public static function getMethodList()
        { 
            $nodes = [];
            self::eachController(function (\ReflectionClass $reflection, $prenode) use (&$nodes) { 
                foreach ($reflection->getMethods(\ReflectionMethod::IS_PUBLIC) as $method) { 
                    $action = strtolower($method->getName());
                    list($node, $comment) = ["{ $prenode}{ $action}", preg_replace("/\s/", '', $method->getDocComment())];
                    $nodes[$node] = [
                        'auth'  => stripos($comment, '@authtrue') !== false,
                        'menu'  => stripos($comment, '@menutrue') !== false,
                        'title' => preg_replace('/^\/\*\*\*(.*?)\*.*?$/', '$1', $comment),
                    ];
                    if (stripos($nodes[$node]['title'], '@') !== false) $nodes[$node]['title'] = '';
                }
            });
            return $nodes;
        }
    
    
        /** * 控制器扫描回调 * @param callable $callable * @throws \ReflectionException */
        public static function eachController($callable)
        { 
    
            foreach (self::scanPath(env('app_path') . "*/controller/") as $file) { 
                if (!preg_match("|/(\w+)/controller/(.+)\.php$|", $file, $matches)) continue;
                list($module, $controller) = [$matches[1], strtr($matches[2], '/', '.')];
                //这里需要注意，.env文件下的app_namespace配置需要跟控制器的命名空间开头一致，而控制器命名空间也需要一一对应
                if (class_exists($class = substr(strtr(env('app_namespace') . $matches[0], '/', '\\'), 0, -4))) { 
                    call_user_func($callable, new \ReflectionClass($class), self::parseString("{ $module}/{ $controller}/"));
                }
            }
        }
    
    
        /** * 驼峰转下划线规则 * @param string $node 节点名称 * @return string */
        public static function parseString($node)
        { 
            if (count($nodes = explode('/', $node)) > 1) { 
                $dots = [];
                foreach (explode('.', $nodes[1]) as $dot) { 
                    $dots[] = trim(preg_replace("/[A-Z]/", "_\\0", $dot), "_");
                }
                $nodes[1] = join('.', $dots);
            }
            return strtolower(join('/', $nodes));
        }
    
        /** * 获取所有PHP文件 * @param string $dirname 扫描目录 * @param array $data 额外数据 * @param string $ext 有文件后缀 * @return array */
        private static function scanPath($dirname, $data = [], $ext = 'php')
        { 
            foreach (glob("{ $dirname}*") as $file) { 
                if (is_dir($file)) { 
                    $data = array_merge($data, self::scanPath("{ $file}/"));
                } elseif (is_file($file) && pathinfo($file, 4) === $ext) { 
                    $data[] = str_replace('\\', '/', $file);
                }
            }
            return $data;
        }
    
        /** * 一维数据数组生成数据树 * @param array $list 数据列表 * @param string $id 父ID Key * @param string $pid ID Key * @param string $son 定义子数据Key * @return array */
        public static function arr2tree($list, $id = 'id', $pid = 'pid', $son = 'sub')
        { 
            list($tree, $map) = [[], []];
            foreach ($list as $item) $map[$item[$id]] = $item;
            foreach ($list as $item) if (isset($item[$pid]) && isset($map[$item[$pid]])) { 
                $map[$item[$pid]][$son][] = &$map[$item[$id]];
            } else $tree[] = &$map[$item[$id]];
            unset($map);
            return $tree;
        }
    }

最后，我们在项目根目录下定义好一个运行文件 笔者这里是 **run.php**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA_size_16_color_FFFFFF_t_70 4]

我们运行一下代码，看看效果

获取控制器节点列表：NodeService::getClassList()  
![!\[在这里插入图片描述\](https://img-blog.csdnimg.cn/20200623170702461.png][https_img-blog.csdnimg.cn_20200623170702461.png]  
上面打印的信息，我们可以看到，对应着我们的 **模块/类名 => xx管理**

获取方法节点列表：NodeService::getMethodList()  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA_size_16_color_FFFFFF_t_70 5]  
这里注意，如果我们是注释里面的  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA_size_16_color_FFFFFF_t_70 6]  
这我们作为权限判断的凭据，如果不需要时，则为false

获取授权节点列表：NodeService::getAuthTree()  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA_size_16_color_FFFFFF_t_70 7]  
我们拿到了其树状结构的结果集，只需要遍历上面的数组，就很清晰的展示出一个权限权限面板  
下图是笔者拿到结果集遍历的权限面板，这里就不提供模板了…  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA_size_16_color_FFFFFF_t_70 8]

总结：通过反射来实现权限，步骤跟传统的有所不同

*  传统的权限实现方法是**通过页面手动添加 权限-控制器-方法** 在进行分配权限之前必须有一个curd的过程，而分配时又有一个curd的过程，这种形式，如果是模块少还好，维护成本低，但如果是大项目，比如有一百个控制器的话，则非常难进行管理，维护成本极大
 *  而笔者这种方式呢，是先通过反射进行渲染列表，相当于免去了**通过页面手动添加 权限-控制器-方法** 。这个步骤，减少了一个分配权限之前必须有一个curd的过程，先采集数据，然后进行curd，但此类方法也有不足的地方，比如控制器类中的add upd del 方法如何去做到统一规范，避免控制器1和控制2的方法不一致，是可以通过interface 接口类去实现一个规范，但如果有人修改了控制器内的注释，导致了数据库中的数据不一样，这种方法如何去避免？获取在分配页面加个刷新权限，逐步同步到数据库也算是一个解决方案， 但需要完善的地方还有很多…

通过反射来实现权限的展示效果我们已经拿到了结果集，剩下的分配权限，只是入库的的问题了，下面是笔者项目中的负责权限的四张表供大家参考，结构如下  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA_size_16_color_FFFFFF_t_70 9]  
![在这里插入图片描述][20200623172536140.png]

![在这里插入图片描述][20200623172611292.png]

![在这里插入图片描述][20200623172646192.png]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200624094020897.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/2020062316513483.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200623165409745.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20200623165637276.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20200623170528431.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA==,size_16,color_FFFFFF,t_70
[https_img-blog.csdnimg.cn_20200623170702461.png]: https://img-blog.csdnimg.cn/20200623171014820.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20200623171447926.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA_size_16_color_FFFFFF_t_70 6]: https://img-blog.csdnimg.cn/20200623171552263.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA_size_16_color_FFFFFF_t_70 7]: https://img-blog.csdnimg.cn/20200623175808180.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA_size_16_color_FFFFFF_t_70 8]: https://img-blog.csdnimg.cn/20200623221425685.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA_size_16_color_FFFFFF_t_70 9]: https://img-blog.csdnimg.cn/20200623172509828.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMyMDkwMA==,size_16,color_FFFFFF,t_70
[20200623172536140.png]: https://img-blog.csdnimg.cn/20200623172536140.png
[20200623172611292.png]: https://img-blog.csdnimg.cn/20200623172611292.png
[20200623172646192.png]: https://img-blog.csdnimg.cn/20200623172646192.png