laravel学习笔记------使用 Entrust 扩展包在 Laravel 5 中实现 RBAC 权限管理
为什么80%的码农都做不了架构师?>>>
Entrust为我们在Laravel中实现基于角色的权限管理(RBAC)提供了简洁灵活的方式。
1、安装
想要在Laravel中使用Entrust,首先需要通过Composer来安装其依赖包:
composer require zizaco/entrust 5.2.x-dev
安装完成后需要在config/app.php
中注册服务提供者到providers
数组:
Zizaco\Entrust\EntrustServiceProvider::class,
同时在该配置文件中注册相应门面到aliases
数组:
'Entrust' => Zizaco\Entrust\EntrustFacade::class,
如果你想要使用中间件(要求Laravel 5.1或更高版本)还需要添加如下代码到app/Http/Kernel.php
的routeMiddleware
数组:
'role' => \Zizaco\Entrust\Middleware\EntrustRole::class, 'permission' => \Zizaco\Entrust\Middleware\EntrustPermission::class, 'ability' => \Zizaco\Entrust\Middleware\EntrustAbility::class,
2、配置
在配置文件config/auth.php
中设置合适的值,Entrust会使用这些配置值来选择相应的用户表和模型类:
'providers' => ['users' => ['driver' => 'eloquent','model' => App\User::class,'table' => 'users',], ],
你还可以发布该扩展包的配置以便后续自定义相关表名以及模型类的命名空间:
php artisan vendor:publish
该命令会在config
目录下创建一个entrust.php
文件。
3、用户角色权限表
接下来我们使用Entrust提供的迁移命令生成迁移文件:
php artisan entrust:migration
然后通过以下命令生成相应的数据表:
php artisan migrate
最终会生成4张新表:
roles
—— 存储角色permissions
—— 存储权限role_user
—— 存储角色与用户之间的多对多关系permission_role
—— 存储角色与权限之间的多对多关系
4、模型类
Role
我们需要创建Role模型类app/Role.php
并编辑其内容如下:
<?php namespace App;use Zizaco\Entrust\EntrustRole;class Role extends EntrustRole { }
Role
模型拥有三个主要属性:
name
—— 角色的唯一名称,如“admin”,“owner”,“employee”等display_name
—— 人类可读的角色名,例如“后台管理员”、“作者”、“雇主”等description
—— 该角色的详细描述
display_name
和description
属性都是可选的,在数据库中的相应字段默认为空。
Permission
接下来创建Permission模型app/Permission.php
并编辑其内容如下:
<?php namespace App;use Zizaco\Entrust\EntrustPermission;class Permission extends EntrustPermission { }
Permission
模型也有三个主要属性:
name
—— 权限的唯一名称,如“create-post”,“edit-post”等display_name
—— 人类可读的权限名称,如“发布文章”,“编辑文章”等description
—— 该权限的详细描述
User
接下来我们在User
模型中使用EntrustUserTrait
:
<?phpnamespace App;use Illuminate\Notifications\Notifiable; use Illuminate\Foundation\Auth\User as Authenticatable; use Zizaco\Entrust\Traits\EntrustUserTrait;class User extends Authenticatable {use Notifiable;use EntrustUserTrait;/*** The attributes that are mass assignable.** @var array*/protected $fillable = ['name', 'email', 'password',];/*** The attributes that should be hidden for arrays.** @var array*/protected $hidden = ['password', 'remember_token',]; }
这将会建立User
与Role
之间的关联关系:在User
模型中添加roles()
、hasRole($name)
、can($permission)
以及ability($roles,$permissions,$options)
方法。
软删除
使用Entrust提供的迁移命令生成的关联关系表中默认使用了onDelete('cascade')
以便父级记录被删除后移除其对应的关联关系。如果你由于某种原因不能在数据库中使用级联删除,那么可以在EntrustRole
、EntrustPermission
类以及HasRole
trait提供的事件监听器中手动删除关联表中的记录。如果模型使用了软删除,那么当不小心误删除数据时,事件监听器将不会删除关联表数据。不过,由于Laravel事件监听器的局限性,所以暂时无法区分是调用delete()
还是forceDelete()
,基于这个原因,在你删除一个模型之前,必须手动删除所有关联数据(除非你的数据表使用了级联删除):
$role = Role::findOrFail(1); // 获取给定权限// 正常删除 $role->delete();// 强制删除 $role->users()->sync([]); // 删除关联数据 $role->perms()->sync([]); // 删除关联数据$role->forceDelete(); // 不管透视表是否有级联删除都会生效
1、创建角色/权限并进行分配
首先我们来创建Role
和Permission
:
$owner = new Role(); $owner->name = 'owner'; $owner->display_name = 'Project Owner'; $owner->description = 'User is the owner of a given project'; $owner->save();$admin = new Role(); $admin->name = 'admin'; $admin->display_name = 'User Administrator'; $admin->description = 'User is allowed to manage and edit other users'; $admin->save();
接下来我们将创建的两个roles分配给用户:
$user = User::where('username', '=', 'michele')->first();//调用EntrustUserTrait提供的attachRole方法 $user->attachRole($admin); // 参数可以是Role对象,数组或id// 或者也可以使用Eloquent原生的方法 $user->roles()->attach($admin->id); //只需传递id即可
现在我们还需要添加相应权限到这些角色上:
$createPost = new Permission(); $createPost->name = 'create-post'; $createPost->display_name = 'Create Posts'; $createPost->description = 'create new blog posts'; $createPost->save();$editUser = new Permission(); $editUser->name = 'edit-user'; $editUser->display_name = 'Edit Users'; $editUser->description = 'edit existing users'; $editUser->save();$owner->attachPermission($createPost); //等价于 $owner->perms()->sync(array($createPost->id));$admin->attachPermissions(array($createPost, $editUser)); //等价于 $admin->perms()->sync(array($createPost->id, $editUser->id));
2、检查角色&权限
完成上述操作后,下面我们可以检查相应角色和权限:
$user->hasRole('owner'); // false $user->hasRole('admin'); // true $user->can('edit-user'); // true $user->can('create-post'); // true
hasRole()
和can
都可以接收数组形式的角色和权限进行检查:
$user->hasRole(['owner', 'admin']); // true $user->can(['edit-user', 'create-post']); // true
默认情况下,如果用户拥有以上任意一个角色或权限都会返回true
,如果你想检查用户是否拥有所有角色及权限,可以传递true
作为第二个参数到相应方法:
$user->hasRole(['owner', 'admin']); // true $user->hasRole(['owner', 'admin'], true); // false $user->can(['edit-user', 'create-post']); // true $user->can(['edit-user', 'create-post'], true); // false
用户可以拥有多个角色。
除此之外,还可以通过Entrust
门面检查当前登录用户是否拥有指定角色和权限:
Entrust::hasRole('role-name'); Entrust::can('permission-name');
甚至还可以通过通配符的方式来检查用户权限:
// match any admin permission $user->can("admin.*"); // true// match any permission about users $user->can("*_users"); // true
3、ability方法
还可以通过使用ability
方法来实现更加高级的检查,这需要三个参数(角色、权限、选项),同样角色和权限既可以是字符串也可以是数组:
$user->ability(array('admin', 'owner'), array('create-post', 'edit-user')); // 或者 $user->ability('admin,owner', 'create-post,edit-user');
这将会检查用户是否拥有任意提供的角色和权限,在本例中会返回true
,因为用户的角色是admin
并且拥有create-post
权限。
第三个参数是一个可选数组:
$options = array('validate_all' => true | false (Default: false),'return_type' => boolean | array | both (Default: boolean) );
其中validate_all
是一个布尔值,用于设置是否检查所有值;return_type
用于指定返回布尔值、检查值数组还是两者都有。
下面是一个输出示例:
$options = array('validate_all' => true,'return_type' => 'both' );list($validate, $allValidations) = $user->ability(array('admin', 'owner'),array('create-post', 'edit-user'),$options );var_dump($validate); // bool(false)var_dump($allValidations); // array(4) { // ['role'] => bool(true) // ['role_2'] => bool(false) // ['create-post'] => bool(true) // ['edit-user'] => bool(false) // }
同样,Entrust
门面也为当前登录用户提供了ability
方法:
Entrust::ability('admin,owner', 'create-post,edit-user'); // 等价于 Auth::user()->ability('admin,owner', 'create-post,edit-user');
4、Blade模板
在Blade模板中也可以使用上述三个方法对应的指令:
@role('admin')<p>This is visible to users with the admin role. Gets translated to\Entrust::role('admin')</p> @endrole@permission('manage-admins')<p>This is visible to users with the given permissions. Gets translated to\Entrust::can('manage-admins'). The @can directive is already taken by corelaravel authorization package, hence the @permission directive instead.</p> @endpermission@ability('admin,owner', 'create-post,edit-user')<p>This is visible to users with the given abilities. Gets translated to\Entrust::ability('admin,owner', 'create-post,edit-user')</p> @endability
5、中间件
你可以在中间件中通过角色或权限来过滤路由以及路由群组:
Route::group(['prefix' => 'admin', 'middleware' => ['role:admin']], function() {Route::get('/', 'AdminController@welcome');Route::get('/manage', ['middleware' => ['permission:manage-admins'], 'uses' => 'AdminController@manageAdmins']); });
支持OR/AND逻辑:
'middleware' => ['role:admin|root'] 'middleware' => ['permission:owner', 'permission:writer']
同样可以使用ability
中间件:
'middleware' => ['ability:admin|owner,create-post|edit-user,true']
6、路由过滤器的快捷实现
通过权限和角色过滤路由你还可以在app/Http/routes.php
调用如下代码:
// 只有拥有'create-post'权限对应角色的用户才能访问admin/post* Entrust::routeNeedsPermission('admin/post*', 'create-post');// 只有所有者才能访问admin/advanced* Entrust::routeNeedsRole('admin/advanced*', 'owner');// 第二个参数可以是数组,这样用户必须满足所有条件才能访问对应路由 Entrust::routeNeedsPermission('admin/post*', array('create-post', 'edit-comment')); Entrust::routeNeedsRole('admin/advanced*', array('owner','writer'));
以上方法都可以接受第三个参数,如果第三个参数为空那么禁止访问默认调用App::abort(403)
,否则会返回第三个参数,所以我们可以这么做:
Entrust::routeNeedsRole('admin/advanced*', 'owner', Redirect::to('/home'));
甚至还可以接受第四个参数,该参数默认为true
,意味着将会检查提供的所有角色和权限,如果你将其设置为false
,则该方法只有在所有角色/权限都不满足才会返回失败:
// 如果用户拥有'create-post'、'edit-comment'其中之一或者两个权限都具备则可以访问 Entrust::routeNeedsPermission('admin/post*', array('create-post', 'edit-comment'), null, false);// 如果用户是所有者、作者或者都具备则可以访问 Entrust::routeNeedsRole('admin/advanced*', array('owner','writer'), null, false);Entrust::routeNeedsRoleOrPermission('admin/advanced*',array('owner', 'writer'),array('create-post', 'edit-comment'),null,false );
7、路由过滤器
Entrust角色/权限可通过调用Entrust
门面上的can
和hasRole
方法应用在过滤器中:
Route::filter('manage_posts', function() {// check the current userif (!Entrust::can('create-post')) {return Redirect::to('admin');} });// 只有用户对应角色拥有 'manage_posts' 权限才能访问任意 admin/post 路由 Route::when('admin/post*', 'manage_posts');
使用过滤器来检查角色:
Route::filter('owner_role', function() {// check the current userif (!Entrust::hasRole('Owner')) {App::abort(403);} });// 只有所有者才能访问 admin/advanced* 路由 Route::when('admin/advanced*', 'owner_role');
正如你所看到的,Entrust::hasRole
和Entrust::can
方法检查用户是否登录、然后才去判断他们是否有用指定角色或权限,如果用户没有登录则直接返回false
。
如果想要查看在Laravel 5.2中基于Entrust实现后台权限管理的实例可参考Ryan的这个Github项目:https://github.com/yuansir/laravel5-rbac-example
转载于:https://my.oschina.net/sunYwp/blog/993868
laravel学习笔记------使用 Entrust 扩展包在 Laravel 5 中实现 RBAC 权限管理相关推荐
- 使用 Entrust 扩展包在 Laravel 5 中实现 RBAC 权限管理与安装配置
Entrust为我们在Laravel中实现基于角色的权限管理(RBAC)提供了简洁灵活的方式. 1.安装 想要在Laravel中使用Entrust,首先需要通过Composer来安装其依赖包: com ...
- laravel框架应用和composer扩展包开发
laravel5.5+ laravel官方地址 laravel是目前最流行的php框架,发展势头迅猛,应用非常广泛,有丰富的扩展包可以应付你能想到的各种应用场景,laravel框架思想前卫,跟随时代潮 ...
- es6学习笔记-字符串的扩展_v1.0_byKL
es6学习笔记-字符串的扩展_v1.0 字符的Unicode表示法 JavaScript 允许使用uxxxx的形式表示一个字符,但在 ES6 之前,单个码点仅支持u0000到uFFFF,超出该范围的必 ...
- 怎么恢复oracle的包,【学习笔记】使用dbms_backup_restore包恢复数据库
天萃荷净 使用dbms_backup_restore包恢复数据库 Oracle提供了一个包:DBMS_BACKUP_RESTORE包是由dbmsbkrs.sql 和 prvtbkrs.plb 这两个脚 ...
- Laravel学习笔记汇总——Collection方法详解
## Laravel学习笔记汇总--Collection方法详解 本文参考:https:// laravel.com/docs/8.x/collections // 返回整个底层的数组 collect ...
- oracle修改asm参数文件,学习笔记:Oracle RAC参数文件管理 修改创建asm中的spfile文件...
天萃荷净 Oracle rac创建修改asm中的spfile文件内容 create spfile to asm --查看sid SQL> show parameter instance_name ...
- 《游戏设计艺术(第2版)》——学习笔记(20)第20章 世界中的角色
<游戏设计艺术(第2版)>学习笔记(20) 第20章 世界中的角色 游戏角色的本质 小说角色 电影角色 游戏角色 化身 理想型 白板 创造令人信服的游戏角色 角色窍门1:列出角色的功能 角 ...
- VBA学习笔记1:将同个文件夹中的工作簿汇总为一个工作簿,并建立目录超链接
VBA学习笔记1:将同个文件夹中的工作簿汇总为一个工作簿,并建立目录超链接 1.将文件夹中的xlsx文件名复制到新工作簿: 2.将文件夹中的xlsx数据簿中的sheet复制到新表并重命名: 3.插入超 ...
- Laravel学习笔记目录
伴随自己学习.使用laravel的过程,记录下遇到过的问题与思考.与程序猿们共勉,知识的道路没有止境,我们一直都在学习的路上. 第一部分:入门级 这部分文章写得都是比较浅显的,属于纯粹的使用,我也不知 ...
最新文章
- php列表显示教程,Dedecms后台管理文档列表显示自定义字段方法教程
- Linux C定时器使用指南
- O太多,具体都代表什么呢?
- 文巾解题 190. 颠倒二进制位
- linux之gdb基本调试命令和使用总结
- jsf集成spring_Spring和JSF集成:动态导航
- 【渝粤题库】国家开放大学2021春3938管理英语2题目
- python编程入门 适合于零基础朋友-零基础能学好python吗?教女朋友学python是送命题吗?...
- jQuery 学习-样式篇(六):jQuery 获取和设置表单元素的值
- 【LTspice仿真软件】如何从官网下载软件和入门到精通的教程
- Java菜鸡的学习日常——2021华为软挑(练手)
- 全国地级市坐标、名称、编码获取 / 全球城市坐标位置
- 基于Ubuntu系统下的Hadoop 环境搭建(新手可尝)
- android 市场 百度地图,百度地图 下载_地图导航软件_车载安卓应用_路畅市场
- 快速入门linux(收藏版)
- java游戏txt_java游戏泡泡龙
- 中台建设利器-SPI插件机制
- Python24中使用urllib时遇到IOError的正确打开方式
- 炼乳可以做什么 炼乳的多种食用方法
- 巴贝奇——现代计算机真正的鼻祖
热门文章
- 【Java基础】Java开发环境搭建并编写第一个入门程序HelloWorld
- winform直接控制云台_智云和快手发布重磅功能,手机云台升级,帮8成网民拍大片...
- 为什么那些美事没有实现---生活中小事有感
- 高三学习计划作文计算机专业,高三学习计划作文.docx
- MySQL数据库基本命令
- 数学在计算机方面的应用论文参考文献,数学论文参考文献
- 12.14黄金白银实时行情分析,黄金原油解套操作策略
- win10忘记密码_电脑忘记密码没关系,这招教你简单轻松改密码
- 色彩系列教程(3):实际运用
- 出现这十种症状,说明你不适合干程序员