Skip to content

Latest commit

 

History

History
347 lines (249 loc) · 9.52 KB

permission.md

File metadata and controls

347 lines (249 loc) · 9.52 KB

权限控制

Dcat Admin已经内置了完善的RBAC权限控制模块，包括：

  • 菜单权限：基于路由的访问控制
  • 按钮权限：细粒度的操作权限控制
  • 数据权限：行级、列级、表单字段级的数据访问控制
  • 组织机构：部门层级管理与权限继承

展开左侧边栏的Auth，下面有用户、角色、权限、部门、数据规则等管理面板，权限控制的使用如下：

路由控制

在Dcat Admin中，权限和路由是绑定在一起的，在编辑权限页面里面设置当前权限能访问的路由，在HTTP方法select框中选择访问路由的方法，在HTTP路径中填写能访问的路径。

比如要添加一个权限，该权限可以以GET方式访问路径/admin/users，那么HTTP方法选择GET，HTTP路径填写/users。

如果要访问前缀是/admin/users的所有路径，那么HTTP路径填写/users*；如果要访问的是编辑页，那么HTTP路径填写/users/*/edit；如果多个路径中每个路径的方法不同，那么HTTP路径填写GET:users/*。

如果上述的方法不能满足需求，HTTP路径还支持填写路由别名，如admin.users.show

禁用权限功能

把admin.permission.enable配置参数的值设置为false可以完全禁用内置的权限系统。

超级管理员

Dcat Admin中默认的角色 administrator 就是超级管理员角色，请勿更改标识，否则会变成普通角色。

跳过权限验证

可以把需要跳过权限验证的接口加入到配置文件admin.permission.except参数中

	'permission' => [
		// Whether enable permission.
		'enable' => true,

		// All method to path like: auth/users/*/edit
		// or specific method to path like: get:auth/users.
		'except' => [
			'/',
			'auth/login',
			'auth/logout',
			'auth/setting',
		],

	],

页面控制

如果你要在页面中控制用户的权限，可以参考下面的例子

场景1

比如现在有一个场景，对文章发布模块做权限管理，以创建文章为例

首先创建一项权限，进入http://localhost/admin/auth/permissions，权限标识（slug）填写create-post，权限名称填写创建文章，这样权限就创建好了。

第二步可以把这个权限直接附加给个人或者角色，在用户编辑页面可以直接把上面创建好的权限附加给当前编辑用户，也可以在编辑角色页面附加给某个角色。

第三步，在创建文章控制器里面添加控制代码：

use Dcat\Admin\Auth\Permission;

class PostController extends Controller
{
    public function create()
    {
        // 检查权限，有create-post权限的用户或者角色可以访问创建文章页面
        Permission::check('create-post');
    }
}

这样就完成了一个页面的权限控制。

场景2

如果你要在表格中控制用户对元素的显示，那么需要先定义两个权限，比如权限标示delete-image、和view-title-column分别用来控制有删除图片的权限和显示某一列的权限，把这两个权限赋给你设置的角色，然后在grid中加入代码：

$grid->actions(function ($actions) {

    // 没有`delete-image`权限的角色不显示删除按钮
    if (!Admin::user()->can('delete-image')) {
        $actions->disableDelete();
    }
});

// 只有具有`view-title-column`权限的用户才能显示`title`这一列
if (Admin::user()->can('view-title-column')) {
    $grid->column('title');
}

相关方法

获取当前用户对象

Admin::user();

获取当前用户id

Admin::user()->id;

获取用户角色

Admin::user()->roles;

获取用户的权限

Admin::user()->permissions;

用户是否某个角色

Admin::user()->isRole('developer');

是否有某个权限

Admin::user()->can('create-post');

是否没有某个权限

Admin::user()->cannot('delete-post');

是否是超级管理员

Admin::user()->isAdministrator();

是否是其中的角色

Admin::user()->inRoles(['editor', 'developer']);

角色继承

启用组织机构后，用户的角色会自动继承其所属部门（及上级部门）关联的角色。这意味着 isRole() 和 inRoles() 方法返回的结果会包含继承的角色。

权限中间件在匹配角色时也会考虑继承关系，具体逻辑详见 组织机构管理。

权限中间件

可以在路由配置上结合权限中间件来控制路由的权限

// 允许administrator、editor两个角色访问group里面的路由
Route::group([
    'middleware' => 'admin.permission:allow,administrator,editor',
], function ($router) {

    $router->resource('users', UserController::class);
    ...

});

// 禁止developer、operator两个角色访问group里面的路由
Route::group([
    'middleware' => 'admin.permission:deny,developer,operator',
], function ($router) {

    $router->resource('users', UserController::class);
    ...

});

// 有edit-post、create-post、delete-post三个权限的用户可以访问group里面的路由
Route::group([
    'middleware' => 'admin.permission:check,edit-post,create-post,delete-post',
], function ($router) {

    $router->resource('posts', PostController::class);
    ...

});

权限中间件和其它中间件使用方法一致。

为何配置了角色和权限，依然提示无权访问？

这个原因可能是由于权限的URL路径配置错误导致的，正确的包含增删改查功能的URL配置应该是auth/users*这样的，如果你配置成了auth/users/*，那么就会提示无权访问。

另外标签表单填写自定义URL有两种方法：一种是选中后按删除键进行更改；另一种是填写后按空格键 + 回车键。

按钮权限

按钮权限允许你对页面中的操作按钮进行细粒度的权限控制，比如新增、编辑、删除、导出等按钮。

权限类型

系统支持三种权限类型：

类型 常量 说明
菜单权限 Permission::TYPE_MENU (1) 基于路由的访问控制
按钮权限 Permission::TYPE_BUTTON (2) 页面操作按钮控制
数据权限 Permission::TYPE_DATA (3) 数据访问控制

创建按钮权限

在权限管理页面创建按钮权限时，需要设置以下字段：

  • 类型：选择"按钮权限"
  • 权限标识 (slug)：唯一标识，如 user-create
  • 权限键 (permission_key)：语义化键名，如 user:create
  • 关联菜单：该按钮所属的菜单页面

推荐使用 资源:操作 的格式命名权限键，例如：

  • user:create - 创建用户
  • user:edit - 编辑用户
  • user:delete - 删除用户
  • order:export - 导出订单

使用按钮权限

方式一：使用 permission_key 检查

use Dcat\Admin\Admin;

// 检查用户是否有指定的权限键
if (Admin::user()->canPermissionKey('user:create')) {
    // 显示创建按钮
}

// 在 Grid 中使用
$grid->actions(function ($actions) {
    if (!Admin::user()->canPermissionKey('user:delete')) {
        $actions->disableDelete();
    }

    if (!Admin::user()->canPermissionKey('user:edit')) {
        $actions->disableEdit();
    }
});

// 在工具栏中使用
$grid->tools(function ($tools) {
    if (!Admin::user()->canPermissionKey('user:export')) {
        $tools->disableExport();
    }
});

方式二：使用 Laravel Gate

系统已集成 Laravel Gate，你可以使用标准的 Gate 方法进行权限检查：

use Illuminate\Support\Facades\Gate;

// 使用 Gate::allows
if (Gate::allows('user:create')) {
    // 有权限
}

// 使用 Gate::denies
if (Gate::denies('user:delete')) {
    // 无权限
}

// 在 Blade 模板中使用
@can('user:create')
    <button>创建用户</button>
@endcan

@cannot('user:delete')
    <span>无删除权限</span>
@endcannot

方式三：使用辅助函数

// 检查是否有权限
if (admin_can('user:create')) {
    // 显示按钮
}

// 检查是否无权限
if (admin_cannot('user:delete')) {
    // 隐藏按钮
}

完整示例

class UserController extends AdminController
{
    protected function grid()
    {
        return Grid::make(new User(), function (Grid $grid) {
            $grid->column('id');
            $grid->column('username');
            $grid->column('name');

            // 根据权限控制工具栏按钮
            if (!Admin::user()->canPermissionKey('user:create')) {
                $grid->disableCreateButton();
            }

            // 根据权限控制行操作
            $grid->actions(function ($actions) {
                if (!Admin::user()->canPermissionKey('user:view')) {
                    $actions->disableView();
                }
                if (!Admin::user()->canPermissionKey('user:edit')) {
                    $actions->disableEdit();
                }
                if (!Admin::user()->canPermissionKey('user:delete')) {
                    $actions->disableDelete();
                }
            });

            // 批量操作权限
            if (!Admin::user()->canPermissionKey('user:batch-delete')) {
                $grid->disableBatchDelete();
            }
        });
    }
}

组织机构

组织机构功能允许你管理企业的部门层级结构，并支持基于部门的权限继承。

详细文档请参考：组织机构管理

数据权限

数据权限提供了行级、列级、表单字段级的数据访问控制能力。

详细文档请参考：数据权限控制