Eloquent：API 资源

简介
生成资源
概念概述
- 资源集合
编写资源
资源响应

简介

在构建 API 时，您可能需要一个转换层，它位于您的 Eloquent 模型和实际返回给应用程序用户的 JSON 响应之间。例如，您可能希望为部分用户显示某些属性，而为其他用户不显示，或者您可能希望始终在模型的 JSON 表示中包含某些关系。Eloquent 的资源类允许您以简洁易懂的方式将模型和模型集合转换为 JSON。

当然，您可以始终使用 Eloquent 模型或集合的 toJson 方法将它们转换为 JSON；但是，Eloquent 资源提供了对模型及其关系的 JSON 序列化更细粒度和更强大的控制。

生成资源

要生成资源类，您可以使用 make:resource Artisan 命令。默认情况下，资源将放置在应用程序的 app/Http/Resources 目录中。资源扩展了 Illuminate\Http\Resources\Json\JsonResource 类。

php artisan make:resource UserResource

资源集合

除了生成转换单个模型的资源之外，您还可以生成负责转换模型集合的资源。这允许您的 JSON 响应包含与给定资源的整个集合相关的链接和其他元信息。

要创建资源集合，您应该在创建资源时使用 --collection 标志。或者，在资源名称中包含 Collection 一词将表明 Laravel 应该创建一个集合资源。集合资源扩展了 Illuminate\Http\Resources\Json\ResourceCollection 类。

php artisan make:resource User --collection
 
php artisan make:resource UserCollection

概念概述

这是对资源和资源集合的高级概述。强烈建议您阅读本文档的其他部分，以便更深入地了解资源为您提供的自定义和功能。

在深入研究编写资源时可用的所有选项之前，让我们先从高级别了解资源如何在 Laravel 中使用。资源类表示需要转换为 JSON 结构的单个模型。例如，以下是一个简单的 UserResource 资源类。

<?php
 
namespace App\Http\Resources;
 
use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\JsonResource;
 
class UserResource extends JsonResource
{
    /**
     * Transform the resource into an array.
     *
     * @return array<string, mixed>
     */
    public function toArray(Request $request): array
    {
        return [
            'id' => $this->id,
            'name' => $this->name,
            'email' => $this->email,
            'created_at' => $this->created_at,
            'updated_at' => $this->updated_at,
        ];
    }
}

每个资源类都定义了一个 toArray 方法，该方法返回应该在资源作为路由或控制器方法的响应返回时转换为 JSON 的属性数组。

请注意，我们可以直接从 $this 变量访问模型属性。这是因为资源类将自动将属性和方法访问代理到底层模型，以便方便访问。定义资源后，它可以从路由或控制器中返回。资源通过其构造函数接受底层模型实例。

use App\Http\Resources\UserResource;
use App\Models\User;
 
Route::get('/user/{id}', function (string $id) {
    return new UserResource(User::findOrFail($id));
});

资源集合

如果您要返回资源集合或分页响应，您应该在路由或控制器中创建资源实例时使用资源类提供的 collection 方法。

use App\Http\Resources\UserResource;
use App\Models\User;
 
Route::get('/users', function () {
    return UserResource::collection(User::all());
});

请注意，这不允许添加可能需要与您的集合一起返回的任何自定义元数据。如果您想自定义资源集合响应，您可以创建一个专门的资源来表示集合。

php artisan make:resource UserCollection

生成资源集合类后，您可以轻松地定义应包含在响应中的任何元数据。

<?php
 
namespace App\Http\Resources;
 
use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\ResourceCollection;
 
class UserCollection extends ResourceCollection
{
    /**
     * Transform the resource collection into an array.
     *
     * @return array<int|string, mixed>
     */
    public function toArray(Request $request): array
    {
        return [
            'data' => $this->collection,
            'links' => [
                'self' => 'link-value',
            ],
        ];
    }
}

定义资源集合后，它可以从路由或控制器中返回。

use App\Http\Resources\UserCollection;
use App\Models\User;
 
Route::get('/users', function () {
    return new UserCollection(User::all());
});

保留集合键

从路由返回资源集合时，Laravel 会重置集合的键，使其按数字顺序排列。但是，您可以在资源类中添加一个 preserveKeys 属性，指示是否应保留集合的原始键。

<?php
 
namespace App\Http\Resources;
 
use Illuminate\Http\Resources\Json\JsonResource;
 
class UserResource extends JsonResource
{
    /**
     * Indicates if the resource's collection keys should be preserved.
     *
     * @var bool
     */
    public $preserveKeys = true;
}

当 preserveKeys 属性设置为 true 时，在从路由或控制器返回集合时，将保留集合键。

use App\Http\Resources\UserResource;
use App\Models\User;
 
Route::get('/users', function () {
    return UserResource::collection(User::all()->keyBy->id);
});

自定义底层资源类

通常，资源集合的 $this->collection 属性会自动用将集合中的每个项目映射到其单一资源类的结果填充。单一资源类假定为集合的类名，不包含类名的尾部 Collection 部分。此外，根据您的个人喜好，单一资源类可能以 Resource 结尾，也可能不以 Resource 结尾。

例如，UserCollection 将尝试将给定的用户实例映射到 UserResource 资源。要自定义此行为，您可以覆盖资源集合的 $collects 属性。

<?php
 
namespace App\Http\Resources;
 
use Illuminate\Http\Resources\Json\ResourceCollection;
 
class UserCollection extends ResourceCollection
{
    /**
     * The resource that this resource collects.
     *
     * @var string
     */
    public $collects = Member::class;
}

编写资源

如果您还没有阅读概念概述，强烈建议您在继续阅读本文档之前阅读。

资源只需要将给定模型转换为数组。因此，每个资源都包含一个 toArray 方法，该方法将您的模型的属性转换为可以从应用程序的路由或控制器返回的 API 友好数组。

<?php
 
namespace App\Http\Resources;
 
use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\JsonResource;
 
class UserResource extends JsonResource
{
    /**
     * Transform the resource into an array.
     *
     * @return array<string, mixed>
     */
    public function toArray(Request $request): array
    {
        return [
            'id' => $this->id,
            'name' => $this->name,
            'email' => $this->email,
            'created_at' => $this->created_at,
            'updated_at' => $this->updated_at,
        ];
    }
}

定义资源后，它可以直接从路由或控制器中返回。

use App\Http\Resources\UserResource;
use App\Models\User;
 
Route::get('/user/{id}', function (string $id) {
    return new UserResource(User::findOrFail($id));
});

关系

如果您想在响应中包含相关资源，您可以将它们添加到资源的 toArray 方法返回的数组中。在此示例中，我们将使用 PostResource 资源的 collection 方法将用户的博客文章添加到资源响应中。

use App\Http\Resources\PostResource;
use Illuminate\Http\Request;
 
/**
 * Transform the resource into an array.
 *
 * @return array<string, mixed>
 */
public function toArray(Request $request): array
{
    return [
        'id' => $this->id,
        'name' => $this->name,
        'email' => $this->email,
        'posts' => PostResource::collection($this->posts),
        'created_at' => $this->created_at,
        'updated_at' => $this->updated_at,
    ];
}

如果您想仅在关系已加载时才包含关系，请查看关于条件关系的文档。

资源集合

虽然资源将单个模型转换为数组，但资源集合将模型集合转换为数组。但是，由于所有资源都提供了一个 collection 方法，可以在运行时生成“临时的”资源集合，因此并非绝对有必要为每个模型都定义一个资源集合类。

use App\Http\Resources\UserResource;
use App\Models\User;
 
Route::get('/users', function () {
    return UserResource::collection(User::all());
});

但是，如果您需要自定义与集合一起返回的元数据，则有必要定义自己的资源集合。

<?php
 
namespace App\Http\Resources;
 
use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\ResourceCollection;
 
class UserCollection extends ResourceCollection
{
    /**
     * Transform the resource collection into an array.
     *
     * @return array<string, mixed>
     */
    public function toArray(Request $request): array
    {
        return [
            'data' => $this->collection,
            'links' => [
                'self' => 'link-value',
            ],
        ];
    }
}

与单一资源类似，资源集合可以直接从路由或控制器中返回。

use App\Http\Resources\UserCollection;
use App\Models\User;
 
Route::get('/users', function () {
    return new UserCollection(User::all());
});

数据包装

默认情况下，您的最外层资源在资源响应转换为 JSON 时被包装在 data 键中。因此，例如，典型的资源集合响应如下所示。

{
    "data": [
        {
            "id": 1,
            "name": "Eladio Schroeder Sr.",
            "email": "[email protected]"
        },
        {
            "id": 2,
            "name": "Liliana Mayert",
            "email": "[email protected]"
        }
    ]
}

如果您想禁用最外层资源的包装，您应该在基本 Illuminate\Http\Resources\Json\JsonResource 类上调用 withoutWrapping 方法。通常，您应该从您的 AppServiceProvider 或另一个加载到应用程序每个请求的服务提供者中调用此方法。

<?php
 
namespace App\Providers;
 
use Illuminate\Http\Resources\Json\JsonResource;
use Illuminate\Support\ServiceProvider;
 
class AppServiceProvider extends ServiceProvider
{
    /**
     * Register any application services.
     */
    public function register(): void
    {
        // ...
    }
 
    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        JsonResource::withoutWrapping();
    }
}

withoutWrapping 方法只影响最外层响应，不会删除您手动添加到自己的资源集合的 data 键。

包装嵌套资源

您可以完全自由地决定如何包装资源的关系。如果您希望所有资源集合都被包装在 data 键中，无论它们如何嵌套，您都应该为每个资源定义一个资源集合类，并将集合返回到 data 键中。

您可能想知道这是否会导致您的最外层资源被包装在两个 data 键中。不用担心，Laravel 绝不会让您的资源意外地双重包装，因此您不必担心您正在转换的资源集合的嵌套级别。

<?php
 
namespace App\Http\Resources;
 
use Illuminate\Http\Resources\Json\ResourceCollection;
 
class CommentsCollection extends ResourceCollection
{
    /**
     * Transform the resource collection into an array.
     *
     * @return array<string, mixed>
     */
    public function toArray(Request $request): array
    {
        return ['data' => $this->collection];
    }
}

数据包装和分页

当通过资源响应返回分页集合时，即使已调用 withoutWrapping 方法，Laravel 也会将资源数据包装在 data 键中。这是因为分页响应始终包含 meta 和 links 键，其中包含有关分页器状态的信息。

{
    "data": [
        {
            "id": 1,
            "name": "Eladio Schroeder Sr.",
            "email": "[email protected]"
        },
        {
            "id": 2,
            "name": "Liliana Mayert",
            "email": "[email protected]"
        }
    ],
    "links":{
        "first": "http://example.com/users?page=1",
        "last": "http://example.com/users?page=1",
        "prev": null,
        "next": null
    },
    "meta":{
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://example.com/users",
        "per_page": 15,
        "to": 10,
        "total": 10
    }
}

分页

您可以将 Laravel 分页器实例传递给资源的 collection 方法或自定义资源集合。

use App\Http\Resources\UserCollection;
use App\Models\User;
 
Route::get('/users', function () {
    return new UserCollection(User::paginate());
});

分页响应始终包含 meta 和 links 键，其中包含有关分页器状态的信息。

{
    "data": [
        {
            "id": 1,
            "name": "Eladio Schroeder Sr.",
            "email": "[email protected]"
        },
        {
            "id": 2,
            "name": "Liliana Mayert",
            "email": "[email protected]"
        }
    ],
    "links":{
        "first": "http://example.com/users?page=1",
        "last": "http://example.com/users?page=1",
        "prev": null,
        "next": null
    },
    "meta":{
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://example.com/users",
        "per_page": 15,
        "to": 10,
        "total": 10
    }
}

自定义分页信息

如果您想自定义分页响应中 links 或 meta 键中包含的信息，可以在资源上定义一个 paginationInformation 方法。此方法将接收 $paginated 数据和 $default 信息数组，这是一个包含 links 和 meta 键的数组。

/**
 * Customize the pagination information for the resource.
 *
 * @param  \Illuminate\Http\Request  $request
 * @param  array $paginated
 * @param  array $default
 * @return array
 */
public function paginationInformation($request, $paginated, $default)
{
    $default['links']['custom'] = 'https://example.com';
 
    return $default;
}

条件属性

有时您可能希望仅在满足特定条件时才在资源响应中包含属性。例如，您可能希望仅在当前用户是“管理员”时才包含值。Laravel 提供了各种辅助方法来帮助您在这种情况下。when 方法可用于有条件地将属性添加到资源响应。

/**
 * Transform the resource into an array.
 *
 * @return array<string, mixed>
 */
public function toArray(Request $request): array
{
    return [
        'id' => $this->id,
        'name' => $this->name,
        'email' => $this->email,
        'secret' => $this->when($request->user()->isAdmin(), 'secret-value'),
        'created_at' => $this->created_at,
        'updated_at' => $this->updated_at,
    ];
}

在此示例中，仅当经过身份验证的用户的 isAdmin 方法返回 true 时，才会在最终资源响应中返回 secret 键。如果方法返回 false，则 secret 键将在发送到客户端之前从资源响应中删除。when 方法允许您在构建数组时明确定义资源，而无需依赖于条件语句。

when 方法还接受闭包作为其第二个参数，允许您仅在给定条件为 true 时计算结果值。

'secret' => $this->when($request->user()->isAdmin(), function () {
    return 'secret-value';
}),

whenHas 方法可用于在属性实际存在于底层模型上时包含属性。

'name' => $this->whenHas('name'),

此外，whenNotNull 方法可用于在属性不为空时将属性包含在资源响应中。

'name' => $this->whenNotNull($this->name),

合并条件属性

有时您可能有多个属性，这些属性应仅在满足相同条件的情况下才包含在资源响应中。在这种情况下，您可以使用 mergeWhen 方法仅在给定条件为 true 时将属性包含在响应中。

/**
 * Transform the resource into an array.
 *
 * @return array<string, mixed>
 */
public function toArray(Request $request): array
{
    return [
        'id' => $this->id,
        'name' => $this->name,
        'email' => $this->email,
        $this->mergeWhen($request->user()->isAdmin(), [
            'first-secret' => 'value',
            'second-secret' => 'value',
        ]),
        'created_at' => $this->created_at,
        'updated_at' => $this->updated_at,
    ];
}

同样，如果给定条件为 false，则这些属性将在发送到客户端之前从资源响应中删除。

mergeWhen 方法不应在混合字符串和数字键的数组中使用。此外，它不应在数字键未按顺序排序的数组中使用。

条件关系

除了有条件地加载属性外，您还可以有条件地在资源响应中包含关系，这取决于关系是否已在模型上加载。这允许您的控制器决定应在模型上加载哪些关系，并且您的资源可以轻松地在实际加载它们时才包含它们。最终，这使得在资源中更容易避免“N+1”查询问题。

whenLoaded 方法可用于有条件地加载关系。为了避免不必要地加载关系，此方法接受关系的名称而不是关系本身。

use App\Http\Resources\PostResource;
 
/**
 * Transform the resource into an array.
 *
 * @return array<string, mixed>
 */
public function toArray(Request $request): array
{
    return [
        'id' => $this->id,
        'name' => $this->name,
        'email' => $this->email,
        'posts' => PostResource::collection($this->whenLoaded('posts')),
        'created_at' => $this->created_at,
        'updated_at' => $this->updated_at,
    ];
}

在此示例中，如果关系未加载，则 posts 键将在发送到客户端之前从资源响应中删除。

条件关系计数

除了有条件地包含关系外，您还可以有条件地在资源响应中包含关系“计数”，这取决于关系的计数是否已在模型上加载。

new UserResource($user->loadCount('posts'));

whenCounted 方法可用于有条件地将关系的计数包含在资源响应中。此方法避免在关系计数不存在时不必要地包含该属性。

/**
 * Transform the resource into an array.
 *
 * @return array<string, mixed>
 */
public function toArray(Request $request): array
{
    return [
        'id' => $this->id,
        'name' => $this->name,
        'email' => $this->email,
        'posts_count' => $this->whenCounted('posts'),
        'created_at' => $this->created_at,
        'updated_at' => $this->updated_at,
    ];
}

在此示例中，如果 posts 关系的计数未加载，则 posts_count 键将在发送到客户端之前从资源响应中删除。

其他类型的聚合，例如 avg、sum、min 和 max 也可以使用 whenAggregated 方法有条件地加载。

'words_avg' => $this->whenAggregated('posts', 'words', 'avg'),
'words_sum' => $this->whenAggregated('posts', 'words', 'sum'),
'words_min' => $this->whenAggregated('posts', 'words', 'min'),
'words_max' => $this->whenAggregated('posts', 'words', 'max'),

条件枢轴信息

除了有条件地在资源响应中包含关系信息外，您还可以使用 whenPivotLoaded 方法有条件地包含来自多对多关系的中间表的 data。whenPivotLoaded 方法接受枢轴表的名称作为其第一个参数。第二个参数应该是返回要在模型上可用时返回的值的闭包。

/**
 * Transform the resource into an array.
 *
 * @return array<string, mixed>
 */
public function toArray(Request $request): array
{
    return [
        'id' => $this->id,
        'name' => $this->name,
        'expires_at' => $this->whenPivotLoaded('role_user', function () {
            return $this->pivot->expires_at;
        }),
    ];
}

如果您的关系使用自定义中间表模型，则可以将中间表模型的实例作为第一个参数传递给 whenPivotLoaded 方法。

'expires_at' => $this->whenPivotLoaded(new Membership, function () {
    return $this->pivot->expires_at;
}),

如果您的中间表使用除 pivot 之外的访问器，则可以使用 whenPivotLoadedAs 方法。

/**
 * Transform the resource into an array.
 *
 * @return array<string, mixed>
 */
public function toArray(Request $request): array
{
    return [
        'id' => $this->id,
        'name' => $this->name,
        'expires_at' => $this->whenPivotLoadedAs('subscription', 'role_user', function () {
            return $this->subscription->expires_at;
        }),
    ];
}

添加元数据

某些 JSON API 标准要求在您的资源和资源集合响应中添加元 data。这通常包括对资源或相关资源的 links，或有关资源本身的元 data。如果需要返回有关资源的更多元 data，请将其包含在 toArray 方法中。例如，您可能在转换资源集合时包含 links 信息。

/**
 * Transform the resource into an array.
 *
 * @return array<string, mixed>
 */
public function toArray(Request $request): array
{
    return [
        'data' => $this->collection,
        'links' => [
            'self' => 'link-value',
        ],
    ];
}

当从您的资源返回更多元 data 时，您不必担心意外覆盖 Laravel 在返回分页响应时自动添加的 links 或 meta 键。您定义的任何其他 links 都将与分页器提供的 links 合并。

顶级元 data

有时您可能希望仅在资源是正在返回的最外层资源时才将某些元 data 包含在资源响应中。通常，这包括有关响应本身的元信息。要定义此元 data，请在您的资源类中添加一个 with 方法。此方法应返回一个元 data 数组，仅在资源是最外层资源进行转换时才将其包含在资源响应中。

<?php
 
namespace App\Http\Resources;
 
use Illuminate\Http\Resources\Json\ResourceCollection;
 
class UserCollection extends ResourceCollection
{
    /**
     * Transform the resource collection into an array.
     *
     * @return array<string, mixed>
     */
    public function toArray(Request $request): array
    {
        return parent::toArray($request);
    }
 
    /**
     * Get additional data that should be returned with the resource array.
     *
     * @return array<string, mixed>
     */
    public function with(Request $request): array
    {
        return [
            'meta' => [
                'key' => 'value',
            ],
        ];
    }
}

在构建资源时添加元 data

您也可以在路由或控制器中构建资源实例时添加顶级 data。additional 方法（在所有资源上都可用）接受一个应添加到资源响应的 data 数组。

return (new UserCollection(User::all()->load('roles')))
                ->additional(['meta' => [
                    'key' => 'value',
                ]]);

资源响应

正如您已经阅读的那样，资源可以从路由和控制器中直接返回。

use App\Http\Resources\UserResource;
use App\Models\User;
 
Route::get('/user/{id}', function (string $id) {
    return new UserResource(User::findOrFail($id));
});

但是，有时您可能需要在将传出 HTTP 响应发送到客户端之前对其进行自定义。有两种方法可以实现这一点。首先，您可以在资源上链接 response 方法。此方法将返回一个 Illuminate\Http\JsonResponse 实例，让您完全控制响应的标头。

use App\Http\Resources\UserResource;
use App\Models\User;
 
Route::get('/user', function () {
    return (new UserResource(User::find(1)))
                ->response()
                ->header('X-Value', 'True');
});

或者，您可以在资源本身内定义一个 withResponse 方法。此方法将在资源作为响应中最外层资源返回时调用。

<?php
 
namespace App\Http\Resources;
 
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\JsonResource;
 
class UserResource extends JsonResource
{
    /**
     * Transform the resource into an array.
     *
     * @return array<string, mixed>
     */
    public function toArray(Request $request): array
    {
        return [
            'id' => $this->id,
        ];
    }
 
    /**
     * Customize the outgoing response for the resource.
     */
    public function withResponse(Request $request, JsonResponse $response): void
    {
        $response->header('X-Value', 'True');
    }
}