Rbac-Laravel 拓展包,轻松搞定权限控制!

众所周知,RBAC是一套权限控制规范,全称是Role-Based Access Control,翻译过来就是基于角色的访问控制。在实际应用中,许多场景都可以使用这套规范,最常见的比如管理后台。Rbac-Laravel作为一个开源的拓展包,帮助你在Laravel应用中轻松实现Rbac。以下为使用教程。

关于Rbac-Laravel

Rbac-Laravel是一个基于Laravel框架的RBAC拓展包,RBAC(Role-Based Access Control)是指基于角色的访问控制。该拓展包为Laravel框架提供了RBAC模型的实现,并且提供了诸多操作RBAC的便捷方法。

版本信息

Rbac Laravel PHP
1.0.x 5.3.* >=5.6.4

安装方法

使用composer来快速安装拓展包:

$ composer require huang-yi/rbac-laravel:1.0.*

或者编辑项目根目录的composer.json文件,在require属性里面添加一项:

{
    "require": {
        "huang-yi/rbac-laravel": "1.0.*"
    }
}

然后执行composer update

配置信息

首先往Laravel应用中注册ServiceProvider,打开文件config/app.php,在providers中添加一项:

[
    'providers' => [
        HuangYi\Rbac\RbacServiceProvider::class,
    ]
]

然后发布拓展包的配置文件,使用如下命令:

$ php artisan vendor:publish

这时候config/目录下会出现rbac.php文件,该配置文件中有两个配置选项:

第一个为connection属性,用于配置RBAC模块使用的数据库连接名。

第二个为user属性,用于配置Laravel应用中使用的用户模型。默认为App\User

上述配置文件中所配置的user模型类必须use HuangYi\Rbac\RbacTrait

namespace App;

use HuangYi\Rbac\RbacTrait;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    use RbacTrait;

}

数据迁移

执行以下命令创建拓展包必须依赖的数据库表:

$ php artisan migrate

使用方法

Permission

1、权限有三个属性:nameslugdescription

2、创建一个权限:HuangYi\Rbac\Managers\PermissionManager::create(array $attributes)

$permissionManager = new \HuangYi\Rbac\Managers\PermissionManager();

$permission = $permissionManager->create([
    'name' => 'Create product',
    'slug' => 'product.create',
    'description' => 'Create a new product.',
]);

3、删除一个权限:HuangYi\Rbac\Managers\PermissionManager::delete($ID)

$permissionManager = new \HuangYi\Rbac\Managers\PermissionManager();

$deleted = $permissionManager->delete(1);

删除权限时会自动解绑已绑定的角色。

4、更新一个权限:HuangYi\Rbac\Managers\PermissionManager::update($ID, array $attributes)

$permissionManager = new \HuangYi\Rbac\Managers\PermissionManager();

$updated = $permissionManager->update(1, [
    'description' => 'Blabla...',
]);

5、查询一个权限:HuangYi\Rbac\Managers\PermissionManager::find($ID)

$permissionManager = new \HuangYi\Rbac\Managers\PermissionManager();

$permission = $permissionManager->find(1);

Role

1、角色有三个属性:nameslugdescription

2、创建一个角色:HuangYi\Rbac\Managers\RoleManager::create(array $attributes)

$roleManager = new \HuangYi\Rbac\Managers\RoleManager();

$role = $roleManager->create([
    'name' => 'Administrator',
    'slug' => 'admin',
    'description' => 'Can do anything.',
]);

3、删除一个角色:HuangYi\Rbac\Managers\RoleManager::delete($ID)

$roleManager = new \HuangYi\Rbac\Managers\RoleManager();

$deleted = $roleManager->delete(1);

删除角色时会自动解绑已绑定的用户和权限。

4、更新一个角色:HuangYi\Rbac\Managers\RoleManager::update($ID, array $attributes)

$roleManager = new \HuangYi\Rbac\Managers\RoleManager();

$updated = $roleManager->update(1, [
    'description' => 'Blabla...',
]);

5、查询一个角色:HuangYi\Rbac\Managers\RoleManager::find($ID)

$roleManager = new \HuangYi\Rbac\Managers\RoleManager();

$role = $roleManager->find(1);

6、为角色绑定权限:HuangYi\Rbac\Managers\RoleManager::attachPermissions($permissionIDs)

$roleManager = new \HuangYi\Rbac\Managers\RoleManager();

// 绑定一个权限
$roleManager->attachPermissions(1);

// 同时绑定多个权限
$roleManager->attachPermissions([1, 2, 3]);

7、为角色解绑权限:HuangYi\Rbac\Managers\RoleManager::detachPermissions($permissionIDs)

$roleManager = new \HuangYi\Rbac\Managers\RoleManager();

// 解绑一个权限
$roleManager->detachPermissions(1);

// 同时绑定多个权限
$roleManager->detachPermissions([1, 2, 3]);

User

1、为用户绑定角色:HuangYi\Rbac\RbacTrait::attachRoles($roleIDs)

$user = \App\User::find(1);

// 绑定一个角色
$user->attachRoles(1);

// 同时绑定多个角色
$user->attachRoles([1, 2, 3]);

2、为用户解绑角色:HuangYi\Rbac\RbacTrait::detachRoles($roleIDs)

$user = \App\User::find(1);

// 解绑一个角色
$user->detachRoles(1);

// 同时解绑多个角色
$user->detachRoles([1, 2, 3]);

3、判断用户是否为某些角色,若需要判断多个角色请使用|间隔:HuangYi\Rbac\RbacTrait::hasRole($roles)

$user = \App\User::find(1);

// 判断一个角色
$user->hasRole('admin');

// 判断多个角色
$user->hasRole('seller|operator');

4、判断用户是否拥有某些权限,若需要判断多个权限请使用|间隔:HuangYi\Rbac\RbacTrait::hasPermission($permissions)

$user = \App\User::find(1);

// 判断一个权限
$user->hasPermission('product.create');

// 判断多个权限
$user->hasPermission('product.create|product.update');

Middleware

Rbac-Laravel为开发人员提供了便利的Middleware,如果需要使用请将HuangYi\Rbac\RbacMiddleware注入到app/Http/Kernel.php中的路由中间件里:

protected $routeMiddleware = [
    'rbac' => \HuangYi\Rbac\RbacMiddleware::class,
];

配置好后即可在路由中使用:

Route::get('/do/something', [
    'uses' => 'SomeController@action',
    'middleware' => 'rbac:role,roleSlug1|roleSlug2',
]);

Route::get('/do/something', [
    'uses' => 'SomeController@action',
    'middleware' => 'rbac:permission,permissionSlug1|permissionSlug2',
]);

在视图中使用

@ifHasRole('roleSlug1|roleSlug2')
<p>You can see this.</p>
@endIfHasRole

@ifHasPermission('permission1|permission2')
<p>You can see this too.</p>
@endIfHasPermission

支持

Bugs和问题可提交至Github,或者请联系作者黄毅(coodeer@163.com

License

The Rbac-Laravel is open-sourced software licensed under the MIT license

本帖已被设为精华帖!
本帖由 Summer 于 3年前 加精
《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
《L04 微信小程序从零到发布》
从小程序个人账户申请开始,带你一步步进行开发一个微信小程序,直到提交微信控制台上线发布。
讨论数量: 21
bitqiu

:+1:

3年前 评论

比 entrust 如何?

3年前 评论
Chasers9527

同问,比 entrust 如何?

3年前 评论

https://github.com/romanbican/roles

没发现这个轮子的优点在哪里,造轮子要有优点啊,不同的地方应该指出做了哪些优化,实现了哪些没有的功能,目前你这个wiki 没有发现不同之处 。:joy:

3年前 评论

@springjk 世上本没有轮子,造的人多了就有了轮子。造个轮子未必是为了竞争,用了能满足简单需求,不用不影响功能,没有什么优化之说。发出来也本是为了相互学习。?

3年前 评论

@coodeer 造轮子的事我保留意见不谈,你的代码确实可以当作从零开始创建 Laravel Package 的教材!:clap:

3年前 评论

楼主,我下载了你的包,用laravel 5.4,你的包可不可以不要限制5.3,安装出错了

2年前 评论

@饭吃了饿
根据你提供的Exception信息,可以断定是系统未找到aragorn这个名字的数据库连接。
但是你配置的连接名是pgsql,所以请检查一下代码里面,是否哪个地方将数据库连接配置成了aragorn,然后修改为pgsql即可。
用grep或者IDE的Find in path搜索一下aragorn便知。

2年前 评论

请问删除一个角色后,与该角色关联的用户权限以及绑定关系也会自动删除吗?

2年前 评论

@饭吃了饿 会的,用相应的Manager来处理就好。

2年前 评论
Michael001

laravel 5.5.*, try this laravel-rbac

2年前 评论

做了后台登录后 如果用中间件 报Symfony \ Component \ Debug \ Exception \ FatalThrowableError (E_ERROR)
Call to undefined method Illuminate\Auth\GenericUser::hasPermission()啊

1年前 评论

@唐启胤 User对象需要use一下HuangYi\Rbac\RbacTrait。正式项目建议使用spatie/laravel-permission,这个拓展包仅供学习。

1年前 评论

file 跟着文档来做的 其他都可以的 只是在做中间件的时候 报Call to undefined method Illuminate\Auth\GenericUser::hasPermission()了

1年前 评论

@唐启胤 你的报错里有个关键信息Illuminate\Auth\GenericUser,当你的auth driver为database时,认证时返回的用户实例就为GenericUser,这个类显然不会存在hasPermission方法。建议将driver修改为eloquent,并指定model为App\Model\User,这样auth里的user实例就会是App\Model\User了。

1年前 评论

谢谢你的回复 我测试用laravel5.4正常
再请教一个问题 如何实现超级管理员功能 比如在用户表中再添加一个字段 标示为超级管理员 然后再在中间件中加个认证?

1年前 评论

@ifHasRole('roleSlug1|roleSlug2')

You can see this.

@endIfHasRole

你好 页面权限判断能否支持else呢?

1年前 评论

@yf962464 @ifHasRole('roleSlug1|roleSlug2')返回的是true或false @if(@ifHasRole('roleSlug1|roleSlug2'))xxx@elsexxx @endif 这样 你看行不行 没测试过 不知道语法能不能通过

1年前 评论

支持一下基于Casbin的授权库:Laravel Authorization(https://github.com/php-casbin/laravel-auth...

6个月前 评论

请勿发布不友善或者负能量的内容。与人为善,比聪明更重要!