授权

• 简介
• 守卫（Gates）
  • 编写守卫
  • 授权操作
  • 守卫响应
  • 拦截守卫检查
  • 内联授权
• 创建策略
  • 生成策略
  • 注册策略
• 编写策略
  • 策略方法
  • 策略响应
  • 没有模型的方法
  • 访客用户
  • 策略过滤器
• 使用策略授权操作
  • 通过用户模型
  • 通过 Gate 外观模式
  • 通过中间件
  • 通过 Blade 模板
  • 提供额外的上下文
• 授权 & Inertia

简介

除了提供内置的身份验证服务之外，Laravel 还提供了一种简单的方法来授权用户对给定资源的操作。例如，即使一个用户已经通过身份验证，他们也可能没有被授权更新或删除您的应用程序管理的某些 Eloquent 模型或数据库记录。Laravel 的授权功能提供了一种简单、有组织的方式来管理这些类型的授权检查。

Laravel 提供了两种主要的授权操作方式：守卫（gates）和 策略（policies）。可以将守卫和策略看作是路由和控制器。守卫提供了一种简单的、基于闭包的授权方法，而策略（如控制器）则将逻辑围绕特定的模型或资源进行分组。在本篇文档中，我们将首先探讨守卫，然后再研究策略。

在构建应用程序时，您无需选择仅使用守卫或仅使用策略。大多数应用程序很可能包含守卫和策略的混合，这完全没问题！守卫最适用于与任何模型或资源无关的操作，例如查看管理员仪表板。相反，当您希望为特定模型或资源授权操作时，应使用策略。

守卫（Gates）

编写守卫

守卫只是确定用户是否有权执行给定操作的闭包。通常，守卫是使用 Gate 外观模式在 App\Providers\AppServiceProvider 类的 boot 方法中定义的。守卫总是将用户实例作为其第一个参数接收，并且可以选择接收其他参数，例如相关的 Eloquent 模型。

在此示例中，我们将定义一个守卫，以确定用户是否可以更新给定的 App\Models\Post 模型。守卫将通过将用户的 id 与创建帖子的用户的 user_id 进行比较来实现此目的。

use App\Models\Post;
use App\Models\User;
use Illuminate\Support\Facades\Gate;
 
/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Gate::define('update-post', function (User $user, Post $post) {
        return $user->id === $post->user_id;
    });
}

与控制器类似，守卫也可以使用类回调数组定义。

use App\Policies\PostPolicy;
use Illuminate\Support\Facades\Gate;
 
/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Gate::define('update-post', [PostPolicy::class, 'update']);
}

授权操作

要使用守卫授权操作，您应该使用 Gate 外观模式提供的 allows 或 denies 方法。请注意，您无需将当前通过身份验证的用户传递给这些方法。Laravel 会自动处理将用户传递到守卫闭包中的情况。通常在应用程序的控制器中调用守卫授权方法，然后再执行需要授权的操作。

<?php
 
namespace App\Http\Controllers;
 
use App\Http\Controllers\Controller;
use App\Models\Post;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Gate;
 
class PostController extends Controller
{
    /**
     * Update the given post.
     */
    public function update(Request $request, Post $post): RedirectResponse
    {
        if (! Gate::allows('update-post', $post)) {
            abort(403);
        }
 
        // Update the post...
 
        return redirect('/posts');
    }
}

如果您想确定当前通过身份验证的用户以外的用户是否有权执行操作，则可以在 Gate 外观模式上使用 forUser 方法。

if (Gate::forUser($user)->allows('update-post', $post)) {
    // The user can update the post...
}
 
if (Gate::forUser($user)->denies('update-post', $post)) {
    // The user can't update the post...
}

您可以使用 any 或 none 方法一次授权多个操作。

if (Gate::any(['update-post', 'delete-post'], $post)) {
    // The user can update or delete the post...
}
 
if (Gate::none(['update-post', 'delete-post'], $post)) {
    // The user can't update or delete the post...
}

授权或抛出异常

如果您想尝试授权操作，并在用户无权执行给定操作时自动抛出 Illuminate\Auth\Access\AuthorizationException，则可以使用 Gate 外观模式的 authorize 方法。AuthorizationException 的实例会自动被 Laravel 转换为 403 HTTP 响应。

Gate::authorize('update-post', $post);
 
// The action is authorized...

提供额外的上下文

用于授权能力的守卫方法（allows、denies、check、any、none、authorize、can、cannot）和授权Blade 指令（@can、@cannot、@canany）可以接收一个数组作为其第二个参数。这些数组元素将作为参数传递给守卫闭包，并可在进行授权决策时用于提供额外的上下文。

use App\Models\Category;
use App\Models\User;
use Illuminate\Support\Facades\Gate;
 
Gate::define('create-post', function (User $user, Category $category, bool $pinned) {
    if (! $user->canPublishToGroup($category->group)) {
        return false;
    } elseif ($pinned && ! $user->canPinPosts()) {
        return false;
    }
 
    return true;
});
 
if (Gate::check('create-post', [$category, $pinned])) {
    // The user can create the post...
}

守卫响应

到目前为止，我们只研究了返回简单布尔值的守卫。但是，有时您可能希望返回更详细的响应，包括错误消息。为此，您可以从您的守卫返回一个 Illuminate\Auth\Access\Response。

use App\Models\User;
use Illuminate\Auth\Access\Response;
use Illuminate\Support\Facades\Gate;
 
Gate::define('edit-settings', function (User $user) {
    return $user->isAdmin
                ? Response::allow()
                : Response::deny('You must be an administrator.');
});

即使您从您的守卫返回一个授权响应，Gate::allows 方法仍将返回一个简单的布尔值；但是，您可以使用 Gate::inspect 方法来获取守卫返回的完整授权响应。

$response = Gate::inspect('edit-settings');
 
if ($response->allowed()) {
    // The action is authorized...
} else {
    echo $response->message();
}

当使用 Gate::authorize 方法时，如果操作未经授权，该方法会抛出一个 AuthorizationException，则授权响应提供的错误消息将传播到 HTTP 响应。

Gate::authorize('edit-settings');
 
// The action is authorized...

自定义 HTTP 响应状态

当通过守卫拒绝操作时，会返回 403 HTTP 响应；但是，有时返回替代的 HTTP 状态代码可能很有用。您可以使用 Illuminate\Auth\Access\Response 类上的 denyWithStatus 静态构造函数自定义对失败的授权检查返回的 HTTP 状态代码。

use App\Models\User;
use Illuminate\Auth\Access\Response;
use Illuminate\Support\Facades\Gate;
 
Gate::define('edit-settings', function (User $user) {
    return $user->isAdmin
                ? Response::allow()
                : Response::denyWithStatus(404);
});

由于通过 404 响应隐藏资源是 Web 应用程序的一种常见模式，因此为了方便起见，提供了 denyAsNotFound 方法。

use App\Models\User;
use Illuminate\Auth\Access\Response;
use Illuminate\Support\Facades\Gate;
 
Gate::define('edit-settings', function (User $user) {
    return $user->isAdmin
                ? Response::allow()
                : Response::denyAsNotFound();
});

拦截守卫检查

有时，您可能希望授予特定用户所有权限。您可以使用 before 方法定义一个在所有其他授权检查之前运行的闭包。

use App\Models\User;
use Illuminate\Support\Facades\Gate;
 
Gate::before(function (User $user, string $ability) {
    if ($user->isAdministrator()) {
        return true;
    }
});

如果 before 闭包返回非空结果，则该结果将被视为授权检查的结果。

您可以使用 after 方法定义一个在所有其他授权检查之后执行的闭包。

use App\Models\User;
 
Gate::after(function (User $user, string $ability, bool|null $result, mixed $arguments) {
    if ($user->isAdministrator()) {
        return true;
    }
});

除非守卫或策略返回 null，否则 after 闭包返回的值不会覆盖授权检查的结果。

内联授权

有时，您可能希望确定当前已认证的用户是否有权执行某个给定操作，而无需编写与该操作对应的专用 Gate。Laravel 允许您通过 Gate::allowIf 和 Gate::denyIf 方法执行这些类型的“内联”授权检查。内联授权不会执行任何已定义的“之前”或“之后”授权钩子。

use App\Models\User;
use Illuminate\Support\Facades\Gate;
 
Gate::allowIf(fn (User $user) => $user->isAdministrator());
 
Gate::denyIf(fn (User $user) => $user->banned());

如果操作未被授权或当前没有用户通过身份验证，Laravel 将自动抛出 Illuminate\Auth\Access\AuthorizationException 异常。AuthorizationException 的实例会被 Laravel 的异常处理程序自动转换为 403 HTTP 响应。

创建策略

生成策略

策略是将特定模型或资源周围的授权逻辑组织起来的类。例如，如果您的应用程序是一个博客，您可能有一个 App\Models\Post 模型和一个对应的 App\Policies\PostPolicy 来授权诸如创建或更新文章等用户操作。

您可以使用 make:policy Artisan 命令生成策略。生成的策略将放置在 app/Policies 目录中。如果此目录在您的应用程序中不存在，Laravel 将为您创建它。

php artisan make:policy PostPolicy

make:policy 命令将生成一个空的策略类。如果您希望生成一个包含与查看、创建、更新和删除资源相关的示例策略方法类，您可以在执行命令时提供 --model 选项。

php artisan make:policy PostPolicy --model=Post

注册策略

策略发现

默认情况下，只要模型和策略遵循标准的 Laravel 命名约定，Laravel 会自动发现策略。具体来说，策略必须位于包含模型的目录的同级或上级的 Policies 目录中。因此，例如，模型可以放置在 app/Models 目录中，而策略可以放置在 app/Policies 目录中。在这种情况下，Laravel 将在 app/Models/Policies 然后 app/Policies 中检查策略。此外，策略名称必须与模型名称匹配，并具有 Policy 后缀。因此，User 模型将对应于 UserPolicy 策略类。

如果您想定义自己的策略发现逻辑，您可以使用 Gate::guessPolicyNamesUsing 方法注册自定义策略发现回调。通常，此方法应从应用程序的 AppServiceProvider 的 boot 方法中调用。

use Illuminate\Support\Facades\Gate;
 
Gate::guessPolicyNamesUsing(function (string $modelClass) {
    // Return the name of the policy class for the given model...
});

手动注册策略

使用 Gate facade，您可以在应用程序的 AppServiceProvider 的 boot 方法中手动注册策略及其对应的模型。

use App\Models\Order;
use App\Policies\OrderPolicy;
use Illuminate\Support\Facades\Gate;
 
/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Gate::policy(Order::class, OrderPolicy::class);
}

编写策略

策略方法

策略类注册后，您可以为其授权的每个操作添加方法。例如，让我们在 PostPolicy 上定义一个 update 方法，该方法确定给定的 App\Models\User 是否可以更新给定的 App\Models\Post 实例。

update 方法将接收一个 User 和一个 Post 实例作为其参数，并应返回 true 或 false，指示用户是否有权更新给定的 Post。因此，在本例中，我们将验证用户的 id 是否与文章上的 user_id 匹配。

<?php
 
namespace App\Policies;
 
use App\Models\Post;
use App\Models\User;
 
class PostPolicy
{
    /**
     * Determine if the given post can be updated by the user.
     */
    public function update(User $user, Post $post): bool
    {
        return $user->id === $post->user_id;
    }
}

您可以根据需要继续在策略上定义其他方法，以用于它授权的各种操作。例如，您可以定义 view 或 delete 方法来授权各种与 Post 相关的操作，但请记住，您可以随意为策略方法命名。

如果您在通过 Artisan 控制台生成策略时使用了 --model 选项，它将已经包含 viewAny、view、create、update、delete、restore 和 forceDelete 操作的方法。

策略响应

到目前为止，我们只研究了返回简单布尔值的策略方法。但是，有时您可能希望返回更详细的响应，包括错误消息。为此，您可以从您的策略方法返回 Illuminate\Auth\Access\Response 实例。

use App\Models\Post;
use App\Models\User;
use Illuminate\Auth\Access\Response;
 
/**
 * Determine if the given post can be updated by the user.
 */
public function update(User $user, Post $post): Response
{
    return $user->id === $post->user_id
                ? Response::allow()
                : Response::deny('You do not own this post.');
}

当从策略返回授权响应时，Gate::allows 方法仍然会返回一个简单的布尔值；但是，您可以使用 Gate::inspect 方法获取 Gate 返回的完整授权响应。

use Illuminate\Support\Facades\Gate;
 
$response = Gate::inspect('update', $post);
 
if ($response->allowed()) {
    // The action is authorized...
} else {
    echo $response->message();
}

当使用 Gate::authorize 方法时，如果操作未经授权，该方法会抛出一个 AuthorizationException，则授权响应提供的错误消息将传播到 HTTP 响应。

Gate::authorize('update', $post);
 
// The action is authorized...

自定义 HTTP 响应状态

当通过策略方法拒绝某个操作时，将返回 403 HTTP 响应；但是，有时返回备用的 HTTP 状态代码可能很有用。您可以使用 Illuminate\Auth\Access\Response 类上的 denyWithStatus 静态构造函数来自定义失败的授权检查返回的 HTTP 状态代码。

use App\Models\Post;
use App\Models\User;
use Illuminate\Auth\Access\Response;
 
/**
 * Determine if the given post can be updated by the user.
 */
public function update(User $user, Post $post): Response
{
    return $user->id === $post->user_id
                ? Response::allow()
                : Response::denyWithStatus(404);
}

由于通过 404 响应隐藏资源是 Web 应用程序的一种常见模式，因此为了方便起见，提供了 denyAsNotFound 方法。

use App\Models\Post;
use App\Models\User;
use Illuminate\Auth\Access\Response;
 
/**
 * Determine if the given post can be updated by the user.
 */
public function update(User $user, Post $post): Response
{
    return $user->id === $post->user_id
                ? Response::allow()
                : Response::denyAsNotFound();
}

没有模型的方法

一些策略方法只接收当前已通过身份验证的用户的实例。这种情况在授权 create 操作时最为常见。例如，如果您正在创建一个博客，您可能希望确定用户是否有权创建任何文章。在这些情况下，您的策略方法应只期望接收用户实例。

/**
 * Determine if the given user can create posts.
 */
public function create(User $user): bool
{
    return $user->role == 'writer';
}

访客用户

默认情况下，如果传入的 HTTP 请求不是由已通过身份验证的用户发起的，则所有 Gate 和策略都会自动返回 false。但是，您可以通过声明“可选”类型提示或为用户参数定义提供 null 默认值，来允许这些授权检查传递到您的 Gate 和策略。

<?php
 
namespace App\Policies;
 
use App\Models\Post;
use App\Models\User;
 
class PostPolicy
{
    /**
     * Determine if the given post can be updated by the user.
     */
    public function update(?User $user, Post $post): bool
    {
        return $user?->id === $post->user_id;
    }
}

策略过滤器

对于某些用户，您可能希望授权给定策略中的所有操作。要实现此目的，请在策略上定义 before 方法。before 方法将在策略上的任何其他方法之前执行，使您有机会在实际调用预期的策略方法之前授权该操作。此功能最常用于授权应用程序管理员执行任何操作。

use App\Models\User;
 
/**
 * Perform pre-authorization checks.
 */
public function before(User $user, string $ability): bool|null
{
    if ($user->isAdministrator()) {
        return true;
    }
 
    return null;
}

如果您想拒绝特定类型用户的所有授权检查，则可以从 before 方法返回 false。如果返回 null，则授权检查将传递到策略方法。

使用策略授权操作

通过用户模型

您的 Laravel 应用程序附带的 App\Models\User 模型包含两个用于授权操作的有用方法：can 和 cannot。can 和 cannot 方法接收您希望授权的操作的名称和相关模型。例如，让我们确定用户是否有权更新给定的 App\Models\Post 模型。通常，这将在控制器方法中完成。

<?php
 
namespace App\Http\Controllers;
 
use App\Http\Controllers\Controller;
use App\Models\Post;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
 
class PostController extends Controller
{
    /**
     * Update the given post.
     */
    public function update(Request $request, Post $post): RedirectResponse
    {
        if ($request->user()->cannot('update', $post)) {
            abort(403);
        }
 
        // Update the post...
 
        return redirect('/posts');
    }
}

如果为给定模型注册了策略，则 can 方法将自动调用相应的策略并返回布尔结果。如果没有为模型注册策略，则 can 方法将尝试调用与给定操作名称匹配的基于闭包的 Gate。

不需要模型的操作

请记住，某些操作可能对应于不需要模型实例的策略方法，如 create。在这些情况下，您可以将类名称传递给 can 方法。该类名称将用于确定在授权操作时使用哪个策略。

<?php
 
namespace App\Http\Controllers;
 
use App\Http\Controllers\Controller;
use App\Models\Post;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
 
class PostController extends Controller
{
    /**
     * Create a post.
     */
    public function store(Request $request): RedirectResponse
    {
        if ($request->user()->cannot('create', Post::class)) {
            abort(403);
        }
 
        // Create the post...
 
        return redirect('/posts');
    }
}

通过 Gate Facade

除了为 App\Models\User 模型提供的有用方法之外，您始终可以通过 Gate facade 的 authorize 方法授权操作。

与 can 方法类似，此方法接受您希望授权的操作的名称和相关模型。如果未授权该操作，则 authorize 方法将抛出 Illuminate\Auth\Access\AuthorizationException 异常，Laravel 异常处理程序将自动将其转换为 HTTP 响应，状态代码为 403。

<?php
 
namespace App\Http\Controllers;
 
use App\Http\Controllers\Controller;
use App\Models\Post;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Gate;
 
class PostController extends Controller
{
    /**
     * Update the given blog post.
     *
     * @throws \Illuminate\Auth\Access\AuthorizationException
     */
    public function update(Request $request, Post $post): RedirectResponse
    {
        Gate::authorize('update', $post);
 
        // The current user can update the blog post...
 
        return redirect('/posts');
    }
}

不需要模型的操作

如前所述，某些策略方法（如 create）不需要模型实例。在这些情况下，您应该将类名称传递给 authorize 方法。该类名称将用于确定在授权操作时使用哪个策略。

use App\Models\Post;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Gate;
 
/**
 * Create a new blog post.
 *
 * @throws \Illuminate\Auth\Access\AuthorizationException
 */
public function create(Request $request): RedirectResponse
{
    Gate::authorize('create', Post::class);
 
    // The current user can create blog posts...
 
    return redirect('/posts');
}

通过中间件

Laravel 包括一个中间件，可以在传入的请求甚至到达您的路由或控制器之前授权操作。默认情况下，可以使用 can 中间件别名将 Illuminate\Auth\Middleware\Authorize 中间件附加到路由，Laravel 会自动注册该别名。让我们探索一个使用 can 中间件授权用户可以更新文章的示例。

use App\Models\Post;
 
Route::put('/post/{post}', function (Post $post) {
    // The current user may update the post...
})->middleware('can:update,post');

在此示例中，我们向 can 中间件传递了两个参数。第一个是我们要授权的操作的名称，第二个是我们要传递给策略方法的路由参数。在这种情况下，由于我们使用的是 隐式模型绑定，因此 App\Models\Post 模型将传递给策略方法。如果用户无权执行给定的操作，则中间件将返回状态代码为 403 的 HTTP 响应。

为了方便起见，您也可以使用 can 方法将 can 中间件附加到您的路由。

use App\Models\Post;
 
Route::put('/post/{post}', function (Post $post) {
    // The current user may update the post...
})->can('update', 'post');

不需要模型的操作

同样，某些策略方法（如 create）不需要模型实例。在这些情况下，您可以将类名称传递给中间件。该类名称将用于确定在授权操作时使用哪个策略。

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

在字符串中间件定义中指定完整的类名称可能会变得很麻烦。因此，您可以选择使用 can 方法将 can 中间件附加到您的路由。

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

通过 Blade 模板

在编写 Blade 模板时，您可能希望仅当用户有权执行给定操作时才显示页面的某个部分。例如，您可能希望仅当用户实际上可以更新文章时才显示博客文章的更新表单。在这种情况下，您可以使用 @can 和 @cannot 指令。

@can('update', $post)
    <!-- The current user can update the post... -->
@elsecan('create', App\Models\Post::class)
    <!-- The current user can create new posts... -->
@else
    <!-- ... -->
@endcan
 
@cannot('update', $post)
    <!-- The current user cannot update the post... -->
@elsecannot('create', App\Models\Post::class)
    <!-- The current user cannot create new posts... -->
@endcannot

这些指令是编写 @if 和 @unless 语句的便捷快捷方式。上面的 @can 和 @cannot 语句等效于以下语句。

@if (Auth::user()->can('update', $post))
    <!-- The current user can update the post... -->
@endif
 
@unless (Auth::user()->can('update', $post))
    <!-- The current user cannot update the post... -->
@endunless

您还可以确定用户是否有权执行给定的一系列操作中的任何操作。为此，请使用 @canany 指令。

@canany(['update', 'view', 'delete'], $post)
    <!-- The current user can update, view, or delete the post... -->
@elsecanany(['create'], \App\Models\Post::class)
    <!-- The current user can create a post... -->
@endcanany

不需要模型的操作

与大多数其他授权方法一样，如果操作不需要模型实例，您可以将类名传递给 @can 和 @cannot 指令。

@can('create', App\Models\Post::class)
    <!-- The current user can create posts... -->
@endcan
 
@cannot('create', App\Models\Post::class)
    <!-- The current user can't create posts... -->
@endcannot

提供额外的上下文

当使用策略授权操作时，您可以将数组作为第二个参数传递给各种授权函数和辅助函数。数组的第一个元素将用于确定应该调用哪个策略，而数组的其余元素将作为参数传递给策略方法，并可以在进行授权决策时用于额外的上下文。例如，考虑以下包含一个额外的 $category 参数的 PostPolicy 方法定义。

/**
 * Determine if the given post can be updated by the user.
 */
public function update(User $user, Post $post, int $category): bool
{
    return $user->id === $post->user_id &&
           $user->canUpdateCategory($category);
}

当试图确定经过身份验证的用户是否可以更新给定的帖子时，我们可以像这样调用此策略方法。

/**
 * Update the given blog post.
 *
 * @throws \Illuminate\Auth\Access\AuthorizationException
 */
public function update(Request $request, Post $post): RedirectResponse
{
    Gate::authorize('update', [$post, $request->category]);
 
    // The current user can update the blog post...
 
    return redirect('/posts');
}

授权 & Inertia

尽管授权必须始终在服务器上处理，但通常可以方便地为您的前端应用程序提供授权数据，以便正确呈现应用程序的 UI。Laravel 没有为向基于 Inertia 的前端公开授权信息定义必要的约定。

但是，如果您正在使用 Laravel 的基于 Inertia 的入门套件之一，您的应用程序已经包含一个 HandleInertiaRequests 中间件。在此中间件的 share 方法中，您可以返回共享数据，这些数据将提供给应用程序中的所有 Inertia 页面。此共享数据可以用作定义用户授权信息的便捷位置。

<?php
 
namespace App\Http\Middleware;
 
use App\Models\Post;
use Illuminate\Http\Request;
use Inertia\Middleware;
 
class HandleInertiaRequests extends Middleware
{
    // ...
 
    /**
     * Define the props that are shared by default.
     *
     * @return array<string, mixed>
     */
    public function share(Request $request)
    {
        return [
            ...parent::share($request),
            'auth' => [
                'user' => $request->user(),
                'permissions' => [
                    'post' => [
                        'create' => $request->user()->can('create', Post::class),
                    ],
                ],
            ],
        ];
    }
}