在Twill CMS中实现自定义用户角色与权限管理-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01121/article/details/148552488

在Twill CMS中实现自定义用户角色与权限管理

twill Twill is an open source CMS toolkit for Laravel that helps developers rapidly create a custom admin console that is intuitive, powerful and flexible. Chat with us on Discord at https://discord.gg/cnWk7EFv8R. 项目地址: https://gitcode.com/gh_mirrors/tw/twill

前言

Twill作为一个功能强大的Laravel CMS框架，提供了完善的用户角色和权限管理系统。本文将深入讲解如何在Twill中创建自定义用户角色并配置细粒度的权限控制，帮助开发者构建更灵活的内容管理系统。

基础角色系统概述

Twill默认提供四种基础角色：

超级管理员(SuperAdmin)：拥有所有权限，不可通过CMS编辑
管理员(Admin)：几乎拥有所有权限
发布者(Publisher)：可以创建和发布内容
只读用户(View Only)：仅能查看内容

实战：创建作者(Author)角色

我们将通过一个实际案例，创建一个新的"作者(Author)"角色，并限制该角色只能访问"文章(Posts)"模块。

第一步：创建基础模块

首先创建需要的模块：

php artisan twill:make:module posts
php artisan twill:make:module pages

运行数据库迁移：

php artisan migrate

第二步：配置路由和导航

在路由文件中注册模块：

// routes/twill.php
use A17\Twill\Facades\TwillRoutes;

TwillRoutes::module('pages');
TwillRoutes::module('posts');

在导航配置中添加模块：

// config/twill-navigation.php
return [
    'pages' => [
        'title' => 'Pages',
        'module' => true,
    ],
    'posts' => [
        'title' => 'Posts',
        'module' => true,
    ],
];

第三步：扩展用户角色枚举

Twill的角色系统基于枚举实现，我们需要扩展默认的角色枚举：

// app/Models/Enums/UserRole.php
namespace A17\Twill\Models\Enums;

use MyCLabs\Enum\Enum;

class UserRole extends Enum
{
    const VIEWONLY = 'View only';
    const AUTHOR = 'Author';
    const PUBLISHER = 'Publisher';
    const ADMIN = 'Admin';
}

第四步：配置Composer自动加载

为了让Twill使用我们自定义的角色枚举，需要修改composer.json：

{
    "autoload": {
        "files": ["app/Models/Enums/UserRole.php"],
        "exclude-from-classmap": ["vendor/area17/twill/src/Models/Enums/UserRole.php"]
    }
}

更新自动加载：

composer dump-autoload

第五步：实现权限控制

权限控制是核心部分，我们需要在AuthServiceProvider中定义权限：

// app/Providers/AuthServiceProvider.php
use A17\Twill\Models\Enums\UserRole;

class AuthServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $this->registerPolicies();

        // 所有角色都可以查看文章列表
        Gate::define('list-posts', function ($user) {
            if ($user->isSuperAdmin()) return true;
            
            return in_array($user->role_value, [
                UserRole::VIEWONLY,
                UserRole::AUTHOR,
                UserRole::PUBLISHER,
                UserRole::ADMIN,
            ]);
        });

        // 只有编辑角色可以修改文章
        Gate::define('edit-posts', function ($user) {
            if ($user->isSuperAdmin()) return true;
            
            return in_array($user->role_value, [
                UserRole::AUTHOR,
                UserRole::PUBLISHER,
                UserRole::ADMIN,
            ]);
        });
    }
}

第六步：更新导航配置

为文章模块添加权限检查：

// config/twill-navigation.php
'posts' => [
    'title' => 'Posts',
    'module' => true,
    'can' => 'list-posts',
],

第七步：自定义控制器权限

最后，我们需要在控制器中覆盖默认的权限设置：

// app/Http/Controllers/Admin/PostController.php
class PostController extends ModuleController
{
    protected function setMiddlewarePermission()
    {
        $this->middleware('can:list-posts', ['only' => ['index', 'show']]);
        $this->middleware('can:edit-posts', ['except' => ['index', 'show']]);
    }

    protected function getIndexOption($option)
    {
        if (! \Auth::guard('twill_users')->user()->can('edit-posts')) {
            return false;
        }

        return ($this->indexOptions[$option] ?? $this->defaultIndexOptions[$option] ?? false);
    }
}

高级权限管理技巧

1. 使用路由组管理权限

对于简单的权限需求，可以直接在路由层面设置：

// routes/twill.php
Route::group(['middleware' => 'can:edit-posts'], function () {
    TwillRoutes::module('posts');
});

2. 优化权限代码结构

随着权限规则增多，建议使用常量分组和继承Twill的AuthServiceProvider：

class AuthServiceProvider extends TwillAuthServiceProvider
{
    const ALL_ROLES = [UserRole::VIEWONLY, UserRole::AUTHOR, UserRole::PUBLISHER, UserRole::ADMIN];
    const ALL_EDITORS = [UserRole::AUTHOR, UserRole::PUBLISHER, UserRole::ADMIN];

    public function boot()
    {
        Gate::define('list-posts', function ($user) {
            return $this->authorize($user, function ($user) {
                return $this->userHasRole($user, self::ALL_ROLES);
            });
        });
    }
}

3. 媒体库权限控制

Twill的媒体库需要额外配置以下权限：

list: 浏览媒体库
upload: 上传文件
edit: 编辑媒体项

Gate::define('list', function ($user) {
    return $this->authorize($user, function ($user) {
        return $this->userHasRole($user, self::ALL_ROLES);
    });
});