Laravel-Permission 项目教程

1. 项目的目录结构及介绍

Laravel-Permission 项目的目录结构遵循标准的 Laravel 项目结构，并在此基础上添加了一些特定的文件和目录来管理权限和角色。以下是主要的目录和文件介绍：

- app/
  - Models/
    - Permission.php
    - Role.php
- config/
  - permission.php
- database/
  - migrations/
    - create_permission_tables.php
- resources/
  - views/
- routes/
  - web.php
- vendor/
- composer.json
- artisan

详细介绍

• app/Models/: 包含 Permission 和 Role 模型，用于定义权限和角色的数据结构。
• config/permission.php: 权限配置文件，包含与权限相关的设置，如数据库连接、缓存设置等。
• database/migrations/create_permission_tables.php: 数据库迁移文件，用于创建权限和角色相关的数据库表。
• routes/web.php: 路由文件，定义了与权限和角色相关的路由。
• artisan: Laravel 命令行工具，可以用于执行各种命令，如数据库迁移、生成模型等。

2. 项目的启动文件介绍

Laravel-Permission 项目的启动文件主要包括 app/Providers/AuthServiceProvider.php 和 config/app.php。

app/Providers/AuthServiceProvider.php

这个文件用于注册权限和角色的门卫（Gate）和策略（Policy）。以下是一个示例：

namespace App\Providers;

use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Gate;

class AuthServiceProvider extends ServiceProvider
{
    protected $policies = [
        // 'App\Model' => 'App\Policies\ModelPolicy',
    ];

    public function boot()
    {
        $this->registerPolicies();

        // 定义权限
        Gate::define('edit-articles', function ($user) {
            return $user->hasPermissionTo('edit articles');
        });
    }
}

config/app.php

这个文件包含应用程序的基本配置，如时区、语言、服务提供者等。在 providers 数组中，需要注册 Spatie\Permission\PermissionServiceProvider：

'providers' => [
    // 其他服务提供者
    Spatie\Permission\PermissionServiceProvider::class,
],

3. 项目的配置文件介绍

Laravel-Permission 的主要配置文件是 config/permission.php。这个文件包含了权限和角色的各种配置选项。

配置示例

return [
    'models' => [
        'permission' => Spatie\Permission\Models\Permission::class,
        'role' => Spatie\Permission\Models\Role::class,
    ],
    'table_names' => [
        'roles' => 'roles',
        'permissions' => 'permissions',
        'model_has_permissions' => 'model_has_permissions',
        'model_has_roles' => 'model_has_roles',
        'role_has_permissions' => 'role_has_permissions',
    ],
    'column_names' => [
        'model_morph_key' => 'model_id',
    ],
    'cache_expiration_time' => 60 * 24, // 缓存过期时间（分钟）
    'display_permission_in_exception' => false,
    'enable_wildcard_permission' => false,
];

详细介绍

• models: 定义权限和角色的模型类。
• table_names: 定义权限和角色相关的数据库表名。
• column_names: 定义模型关联的字段名。
• cache_expiration_time: 权限缓存的过期时间。
• display_permission_in_exception: 是否在异常中显示权限信息。
• enable_wildcard_permission: 是否启用通配符权限。

通过这些配置，可以灵活地调整权限和角色的行为，以适应不同的应用场景。