花了几天时间认真的写了一个 RBAC 模块

模块 · forecho · 于 1个月前 发布 · 219 次阅读

说明

项目地址 https://github.com/yiier/yii2-rbac,有问题欢迎反馈。

安装

先安装 composer,然后在项目根目录执行下面命令安装模块:

php composer.phar require --prefer-dist yiier/yii2-rbac "*"

使用

配置

  • 修改配置文件,比如 修改 config/main.php, 添加:
return [
    'modules' => [
        'rbac' => [
            'class' => 'yiier\rbac\Module',
            // 'ignoreModules' => ['gii', 'debug', 'rbac'],
            // 'menus' => [
            //    'rbac' =>'RBAC',
            //    'permissions' =>'Permissions',
            //    'roles' =>'Roles',
            //    'users' =>'Users',
            //    'rules' =>'Rules',
            // ],
            // 'userClassName' => 'app\models\User',
            // 'idField' => 'id',
            // 'usernameField' => 'shop_name',
            // 'mainLayout' => '@app/views/layout/rbac.php',
            // 'isAdvanced' => true, // 如果使用的是高级模板
            // 'advancedConfigs' = [ //如果你还有其他应用需要加入控制
            //     [
            //           '@common/config/main.php',
            //           '@common/config/main-local.php',
            //           '@frontend/config/main.php',
            //           '@frontend/config/main-local.php',
            //      ],
            //      [
            //           '@common/config/main.php',
            //           '@common/config/main-local.php',
            //           '@api/config/main.php',
            //           '@api/config/main-local.php',
            //      ],
            //      [
            //           '@common/config/main.php',
            //           '@common/config/main-local.php',
            //           '@backend/config/main.php',
            //           '@backend/config/main-local.php',
            //      ],
            //    ],
        ],
    ],
    'components' => [
        'authManager' => [
            'class' => 'yii\rbac\DbManager',
        ],
    ],
];
  • 执行数据库操作,生成表,命令如下:
php yii migrate --migrationPath=@yii/rbac/migrations/
  • 控制访问,修改配置文件,比如 修改 config/main.php,添加:
'components' => [
    // ...
],
'as access' => [
    'class' => 'yiier\rbac\components\AccessControl',
    // 'allowActions' => ['site/login', 'site/error', 'site/captcha', order/*] //白名单
],

可选操作

  • 修改默认参数,修改 config/params.php 添加:
'yiier.rbac.config' => [
    'cacheDuration' => 3600, // 缓存时间,默认是 30 天,单位是秒
    'superManId' => 12 //拥有所有权限
]
  • 使用 rbac 模块的自带菜单
echo  \yii\widgets\Menu::widget(
    [
        'options' => [
            'class' => 'sidebar-menu'
        ],
        'items' => [
            [
                'label' => Yii::t('app', 'Dashboard'),
                'url' => Yii::$app->homeUrl,
                'icon' => 'fa-dashboard',
                'active' => Yii::$app->request->url === Yii::$app->homeUrl
            ],
            \Yii::$app->getModule('rbac')->getInstance()->getItems() // add menu
        ]
    ]
);
  • 使用 \yiier\rbac\helpers\Html::a ,判断是否有权限,如果没有权限自动隐藏链接
<?= \yiier\rbac\helpers\Html::a(Yii::t('rbac', 'Clear Cache'), ['clear-cache']) ?>
  • 使用 yiier\rbac\widgets\Menu::widget ,判断是否有权限,如果没有权限自动隐藏菜单中的链接
echo  yiier\rbac\widgets\Menu::widget(
    [
        'options' => [
            'class' => 'sidebar-menu'
        ],
        'items' => [
            [
                'label' => Yii::t('app', 'Dashboard'),
                'url' => Yii::$app->homeUrl,
                'icon' => 'fa-dashboard',
                'active' => Yii::$app->request->url === Yii::$app->homeUrl
            ],
            \Yii::$app->getModule('rbac')->getInstance()->getItems() // add menu
        ]
    ]
);
  • 使用 yiier\rbac\widgets\SpuerMenu::widget ,判断是否有权限,如果没有权限自动隐藏菜单中的链接,并且能实现自动高亮:
echo  yiier\rbac\widgets\SpuerMenu::widget(
    [
        'options' => [
            'class' => 'sidebar-menu'
        ],
        'items' => [
            [
                'label' => Yii::t('app', 'Dashboard'),
                'url' => Yii::$app->homeUrl,
                'icon' => 'dashboard',
            ],
            [
                'label' => Yii::t('app', 'Create Product'), 
                'icon' => 'plus', 
                'url' => ['/product/create'], 
                'strict' => true
            ],
            \Yii::$app->getModule('rbac')->getInstance()->getItems() // add menu
        ]
    ]
);

界面操作教程

  • 在『权限列表』中勾选你要控制的菜单,不勾选说明不打算加入权限控制

你也可以添加菜单的描述,更方便使用。描述会默认读取对应 actionXXX 方法中注释的 @title 权限列表

另外操作会自动立即保存,无需再点保存。

  • 在『角色管理』中,添加完角色之后再可以分别给角色分配用户和权限。操作的时候点击对应的权限/用户会立即自动保存。

  • 『用户列表』:只能看某个用户拥有的所有角色和所有权限

  • 『规则列表』:

待补充

本文由 forecho 创作,采用 知识共享署名 3.0 中国大陆许可协议 进行许可。 可自由转载、引用,但需署名作者且注明文章出处。

共收到 2 条回复 RBAC
Kittyfamous#127天前 0 个赞

你公司用laravel,怎么还在折腾yii2?

Kittyfamous#227天前 0 个赞

能不能增加一个点击图片放大功能,还可以叉掉的功能 ?

添加回复 (需要登录)
需要 登录 后方可回复, 如果你还没有账号请点击这里 注册