Spatie Laravel Permission 高级用法：数据库填充最佳实践-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00994/article/details/148393015

Spatie Laravel Permission 高级用法：数据库填充最佳实践

laravel-permission Associate users with roles and permissions 项目地址: https://gitcode.com/gh_mirrors/la/laravel-permission

前言

在 Laravel 应用开发中，权限管理是一个至关重要的环节。Spatie Laravel Permission 包提供了强大的角色和权限管理功能。本文将深入探讨如何在数据库填充(Seeding)过程中高效地初始化角色和权限数据，这是项目部署和测试环境搭建中的关键步骤。

缓存管理的重要性

在开始填充前，必须理解 Spatie Laravel Permission 包的缓存机制。该包会缓存角色和权限数据以提高性能，但在填充过程中可能导致数据不一致问题。

缓存刷新时机

填充前刷新：防止旧缓存与新数据冲突
创建权限/角色后刷新：确保后续操作基于最新数据
填充完成后刷新：保证应用使用正确的缓存数据

// 刷新权限缓存的标准方法
app()[\Spatie\Permission\PermissionRegistrar::class]->forgetCachedPermissions();

数据库缓存存储注意事项

如果使用数据库作为缓存驱动(CACHE_STORE=database)，必须确保：

已运行 Laravel 的缓存表迁移
否则会遇到 Call to a member function perform() on null 等错误

标准填充流程

以下是角色和权限填充的标准模板，展示了最佳实践顺序：

use Illuminate\Database\Seeder;
use Spatie\Permission\Models\Role;
use Spatie\Permission\Models\Permission;

class RolesAndPermissionsSeeder extends Seeder
{
    public function run(): void
    {
        // 第一步：清除缓存
        app()[\Spatie\Permission\PermissionRegistrar::class]->forgetCachedPermissions();

        // 第二步：创建基础权限
        Permission::create(['name' => 'edit articles']);
        Permission::create(['name' => 'delete articles']);
        // 更多权限...

        // 第三步：再次刷新缓存（特别是使用 WithoutModelEvents 时）
        app()[\Spatie\Permission\PermissionRegistrar::class]->forgetCachedPermissions();

        // 第四步：创建角色并分配权限
        $writer = Role::create(['name' => 'writer']);
        $writer->givePermissionTo('edit articles');
        
        // 链式调用示例
        Role::create(['name' => 'moderator'])
            ->givePermissionTo(['publish articles', 'unpublish articles']);

        // 超级管理员拥有所有权限
        Role::create(['name' => 'super-admin'])
            ->givePermissionTo(Permission::all());
    }
}

用户填充与角色分配

在实际项目中，我们通常需要同时创建用户并分配角色。以下是两种常用方法：

方法一：使用工厂状态(Factory States)

// 在 UserFactory 中定义
public function active(): static
{
    return $this->state(fn (array $attributes) => [
        'status' => 1,
    ])->afterCreating(function (User $user) {
        $user->assignRole('ActiveMember');
    });
}

// 在 Seeder 中使用
User::factory(4)->active()->create();

方法二：批量创建后分配角色

User::factory()
    ->count(50)
    ->create()
    ->each(function ($user) {
        $user->assignRole('Member');
    });

大规模数据填充优化

当需要初始化大量角色和权限时，标准创建方法可能效率低下。以下是两种优化方案：

方案一：使用 Eloquent 的 insert 方法

$permissions = collect(['writer', 'editor'])->map(function ($name) {
    return ['name' => $name, 'guard_name' => 'web'];
});

Permission::insert($permissions->toArray());

这种方法跳过了包的内部检查，显著提高性能。

方案二：直接使用 DB 查询

$permissionsByRole = [
    'admin' => ['restore posts', 'force delete posts'],
    // 更多角色和权限...
];

$insertPermissions = fn ($role) => collect($permissionsByRole[$role])
    ->map(fn ($name) => DB::table('permissions')->insertGetId(['name' => $name]));

$permissionIdsByRole = [
    'admin' => $insertPermissions('admin'),
    // 其他角色...
];

foreach ($permissionIdsByRole as $role => $permissionIds) {
    $role = Role::whereName($role)->first();
    
    DB::table('role_has_permissions')->insert(
        collect($permissionIds)->map(fn ($id) => [
            'role_id' => $role->id,
            'permission_id' => $id
        ])->toArray()
    );
}

重要提醒：直接使用 DB 查询后，必须手动刷新权限缓存！