Info
Content

在 Laravel 中实现对资源操作的权限控制

由 学院君 创建于6年前, 最后更新于 4年前    版本号 #2    20636 views    6 likes    0 collects

简介

除了提供开箱即用的认证服务之外，Laravel 还提供了一个简单的方式来管理授权逻辑以便控制对资源的访问权限。和认证一样，在 Laravel 中实现授权很简单，主要有两种方式：Gate 和 Policy。

可以将 Gate 和 Policy 分别看作路由和控制器，Gate 提供了简单的基于闭包的方式进行授权，而 Policy 和控制器一样，对特定模型或资源上的复杂授权逻辑进行分组，本着由简入繁的思路，我们首先来看 Gate，然后再看 Policy。

不要将 Gate 和 Policy 看作互斥的东西，实际上，在大多数应用中我们会混合使用它们，这很有必要，因为 Gate 通常用于与模型或资源无关的权限，比如访问管理后台，与之相反，Policy 则用于对指定模型或资源的动作进行授权。

Gate

编写 Gate

Gate 是用于判断用户是否有权进行某项操作的闭包，通常使用 Gate 门面定义在 App\Providers\AuthServiceProvider 类中。Gate 总是接收用户实例作为第一个参数，还可以接收相关的 Eloquent 模型实例作为额外参数：

/**
 * 注册任意认证/授权服务.
 *
 * @return void
 */
public function boot()
{
    $this->registerPolicies();

    Gate::define('update-post', function ($user, $post) {
        return $user->id == $post->user_id;
    });
}

Gate 还可以通过使用 Class@method 风格的回调字符串定义，和控制器一样：

/**
 * Register any authentication / authorization services.
 *
 * @return void
 */
public function boot()
{
    $this->registerPolicies();

    Gate::define('update-post', 'PostPolicy@update');
}

资源 Gate

你还可以使用 resource 方法一次定义多个 Gate 权限：

Gate::resource('posts', 'PostPolicy');

上面的写法等价于下面的 Gate 定义：

Gate::define('posts.view', 'PostPolicy@view');
Gate::define('posts.create', 'PostPolicy@create');
Gate::define('posts.update', 'PostPolicy@update');
Gate::define('posts.delete', 'PostPolicy@delete');

默认情况下，view、create、update 和 delete 权限会被定义，你也可以通过传递一个数组作为第三个参数到 resource 方法来覆盖或添加其他权限。这个数组的键就是权限名称，而对应的键值就是权限方法的名称。例如，下面的代码将会创建两个新的 Gate 定义 —— posts.image 和 posts.photo：

Gate::resource('posts', 'PostPolicy', [
    'image' => 'updateImage',
    'photo' => 'updatePhoto',
]);

授权动作

要使用 Gate 授权某个动作，可以使用 allows 或 denies 方法，需要注意的是你可以不传用户实例到这些方法，Laravel 会自动将用户实例（当前用户）传递到 Gate 闭包： 
if (Gate::allows('update-post', $post)) {
    // 当前用户可以更新文章...
}

if (Gate::denies('update-post', $post)) {
// 当前用户不能更新文章...
}
注：这种情况下，对于未登录用户所有权限校验都会返回 false。
如果你想要判断指定用户（非当前用户）是否有权进行某项操作，可以使用 Gate 门面上的 forUser 方法： 
if (Gate::forUser($user)->allows('update-post', $post)) {
    // 当前用户可以更新文章...
}

if (Gate::forUser($user)->denies('update-post', $post)) {
// 当前用户不能更新文章...
}

创建 Policy

生成 Policy 类

Policy（策略）是用于组织基于特定模型或资源的授权逻辑类，例如，如果你开发的是一个博客应用，可以有一个 Post 模型和与之对应的 PostPolicy 来授权用户创建或更新博客的动作。

我们使用 Artisan 命令 make:policy 来生成一个 Policy 类，生成的 Policy 类位于 app/Policies 目录下，如果这个目录之前不存在，Laravel 会自动为我们创建：

php artisan make:policy PostPolicy

make:policy 命令会生成一个空的 Policy 类，如果你想要生成一个包含基本 CRUD 策略方法的 Policy 类，在执行该命令的时候可以通过 --model 指定相应模型：

php artisan make:policy PostPolicy --model=Post
注：所有策略类都通过服务容器进行解析，这样在策略类的构造函数中就可以通过类型提示进行依赖注入。

注册 Policy 类

Policy 类创建之后，需要注册到容器。Laravel 自带的 AuthServiceProvider 包含了一个 policies 属性来映射 Eloquent 模型及与之对应的 Policy 类。注册 Policy 将会告知 Laravel 在授权给定模型动作时使用哪一个策略类：

<?php

namespace App\Providers;

use App\Post;
use App\Policies\PostPolicy;
use Illuminate\Support\Facades\Gate;
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;

class AuthServiceProvider extends ServiceProvider
{
    /**
     * 应用的策略映射.
     *
     * @var array
     * @translator laravelacademy.org
     */
    protected $policies = [
        Post::class => PostPolicy::class,
    ];

    /**
     * 注册任意认证/授权服务.
     *
     * @return void
     */
    public function boot()
    {
        $this->registerPolicies();

        //
    }
}

编写 Policy

Policy 方法

Policy 类被注册后，还要为每个授权动作添加方法，例如，我们为用户更新 Post 实例这一动作在 PostPolicy 中定义一个 update 方法。

update 方法会接收一个 User 实例和一个 Post 实例作为参数，并且返回 true 或 false 以表明该用户是否有权限对给定 Post 进行更新。因此，在这个例子中，我们验证用户的 id 和文章对应的 user_id 是否匹配：

<?php

namespace App\Policies;

use App\User;
use App\Post;

class PostPolicy
{
    /**
     * 判断给定文章是否可以被用户更新.
     *
     * @param  \App\User  $user
     * @param  \App\Post  $post
     * @return bool
     * @translator laravelacademy.org
     */
    public function update(User $user, Post $post)
    {
        return $user->id === $post->user_id;
    }
}

你可以继续在 Policy 类中为授权的权限定义更多需要的方法，例如，你可以定义 view 或者 delete 等方法来授权多个 Post 动作，方法名不限。

注：如果你在使用 Artisan 命令生成策略类的时候使用了 --model 选项，那么策略类中就会包含了 view、create、update 和 delete 授权动作方法。

不带模型的方法

有些策略方法只接收当前认证的用户，并不接收授权的模型实例作为参数，这种用法在授权 create 动作的时候很常见。例如，创建一篇博客的时候，你可能想要检查检查当前用户是否有权创建新博客。

当定义不接收模型实例的策略方法时，例如 create 方法，可以这么做：

/**
 * 判断当前用户是否可以创建文章.
 *
 * @param  \App\User  $user
 * @return bool
 */
public function create(User $user)
{
    //
}

策略过滤器

对特定用户，你可能想要在一个策略方法中对其授权所有权限，比如后台管理员。要实现这个功能，需要在 Policy 类中定义一个 before 方法，before 方法会在 Policy 类的所有其他方法执行前执行，从而确保在其他策略方法调用前执行其中的逻辑： 
public function before($user, $ability)
{
    if ($user->isSuperAdmin()) {
        return true;
    }
}
如果你想要禁止所有授权，可以在 before 方法中返回 false。如果返回 null，该授权会落入策略方法。
注：如果 Policy 类没有包含与待检查权限名称相匹配的授权方法时，该 Policy 类的 before 方法将不会被调用。

使用 Policy 授权动作

通过 User 模型

Laravel 自带的 User 模型提供了两个方法用于授权动作：can 和 cant。can 方法接收你想要授权的动作和对应的模型作为参数。例如，下面的例子我们判断用户是否被授权更新给定的 Post 模型： 
if ($user->can('update', $post)) {
    //
}
如果给定模型对应的策略已经注册，则 can 方法会自动调用相应的策略并返回布尔结果。如果给定模型没有任何策略被注册，can 方法将会尝试调用与动作名称相匹配的 Gate 闭包。

不依赖模型的动作

有些动作比如 create 并不需要依赖给定模型实例，在这些场景中，可以传递一个类名到 can 方法，这个类名会在进行授权的时候用于判断使用哪一个策略：

use App\Post;

if ($user->can('create', Post::class)) {
    // Executes the "create" method on the relevant policy...
}

通过中间件

Laravel 提供了一个可以在请求到达路由或控制器之前进行授权的中间件 —— Illuminate\Auth\Middleware\Authorize ，默认情况下，这个中间件在 App\Http\Kernel 类中被分配了一个 can 别名，下面我们来探究如何使用 can 中间件授权用户更新博客文章动作： 
use App\Post;

Route::put('/post/{post}', function (Post $post) {
// The current user may update the post...
})->middleware('can:update,post');
在这个例子中，我们传递了两个参数给 can 中间件，第一个是我们想要授权的动作名称，第二个是我们想要传递给策略方法的路由参数。在这个例子中，由于我们使用了隐式模型绑定， Post 模型将会被传递给策略方法，如果没有对用户进行给定动作的授权，中间件将会生成并返回一个状态码为 403 的 HTTP 响应。

不依赖模型的动作

同样，对那些不需要传入模型实例的动作如 create，需要传递类名到中间件，类名将会在授权动作的时候用于判断使用哪个策略：

Route::post('/post', function () {
    // The current user may create posts...
})->middleware('can:create,App\Post');

通过控制器辅助函数

除了提供给 User 模型的辅助函数，Laravel 还为继承自 App\Http\Controllers\Controller 基类的所有控制器提供了 authorize 方法，和 can 方法类似，该方法接收你想要授权的动作名称以及相应模型实例作为参数，如果动作没有被授权， authorize 方法将会抛出 Illuminate\Auth\Access\AuthorizationException ，Laravel 默认异常处理器将会将其转化为状态码为 403 的 HTTP 响应：

<?php

namespace App\Http\Controllers;

use App\Post;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;

class PostController extends Controller
{
    /**
     * 更新给定博客文章.
     *
     * @param  Request  $request
     * @param  Post  $post
     * @return Response
     * @translator laravelacademy.org
     */
    public function update(Request $request, Post $post)
    {
        $this->authorize('update', $post);

        // The current user can update the blog post...
    }
}

不依赖模型的动作

和之前讨论的一样，类似 create 这样的动作不需要传入模型实例参数，在这些场景中，可以传递类名给 authorize 方法，该类名将会在授权动作时判断使用哪个策略：

/**
 * 创建一篇新的博客文章.
 *
 * @param  Request  $request
 * @return Response
 */
public function create(Request $request)
{
    $this->authorize('create', Post::class);

    // The current user can create blog posts...
}

通过 Blade 模板

编写 Blade 模板的时候，你可能想要在用户被授权特定动作的情况下才显示对应的视图模板部分，例如，你可能想要在用户被授权更新权限的情况下才显示更新表单。在这种情况下，你可以使用 @can 和 @cannot 指令： 
@can('update', $post)
    
@elsecan('create', App\Post::class)
    
@endcan

@cannot('update', $post)

@elsecannot('create', App\Post::class)

@endcannot
这种写法可看作是 @if 和 @unless 语句的缩写，上面的 @can 和 @cannot 语句与下面的语句等价： 
@if (Auth::user()->can('update', $post))
    
@endif

@unless (Auth::user()->can('update', $post))
    
@endunless

不依赖模型的动作

和其它授权方法一样，如果授权动作不需要传入模型实例的情况下可以传递类名给 @can 和 @cannot 指令：

@can('create', App\Post::class)
    
@endcan

@cannot('create', App\Post::class)
    
@endcannot
Laravel
文档
路由
中间件
控制器
Blade
模型
授权
权限
策略
Gate
教程
5.5
Policy
点赞 取消点赞 收藏 取消收藏

<< 上一篇: 使用 Laravel Passport 实现 API 认证

>> 下一篇: 在 Laravel 中对敏感数据进行加密解密

2 条评论
#1    PHPITGo 评论于 6年前
这个抛出的异常是不是有点不太安全。这个页面可以改吗？谢谢指教
#2    学院君 评论于 6年前
嘿嘿嘿嘿哈哈哈
登录后即可添加评论