使用 when() 方法可实现字段级条件输出,如仅当用户有电话号码时返回 phone 字段;通过控制器中 with() 预加载关联数据可避免 N+1 查询问题;在资源中结合 relationLoaded() 与 whenLoaded() 可安全地按需返回关联数据,确保性能与数据结构整洁。

在 laravel 中使用 jsON 资源(Resource)时,经常需要根据条件动态添加属性或控制是否加载关联数据。Laravel 提供了灵活的方式来处理这些场景,下面介绍如何在 Resource 类中实现条件属性和关联加载。
条件属性:使用 when() 方法
Laravel 的 jsonResource 提供了 when() 方法,用于仅在满足条件时包含某个字段。
例如,只在用户有电话号码时返回该字段:
return [ 'id' => $this->id, 'name' => $this->name, 'email' => $this->email, 'phone' => $this->when($this->phone, $this->phone), ];
'is_admin' => $this->when(auth()->user()?->isAdmin(), true),
注意:when() 不会把 NULL 或不存在的值包含进去,适合做可选字段过滤。
避免 N+1 问题:预加载关联数据
在控制器中返回资源前,应使用 Eager Loading 预加载关联,防止性能问题。
比如获取用户及其文章:
Easily find JSON paths within JSON objects using our intuitive Json Path Finder
30
$users = User::with('posts')->get(); return UserResource::collection($users);
这样每个用户的 posts 关联只会查一次,而不是每条用户单独查询。
在资源中按条件包含关联数据
你可以结合 when() 和模型的加载状态来决定是否返回关联数据。
示例:只有当关联已加载时才输出 posts 数据:
'posts' => $this->when( $this->relationLoaded('posts'), fn () => PostResource::collection($this->whenLoaded('posts')) ),
whenLoaded() 是 Resource 专用方法,它确保只在关联被预加载时才序列化,同时保留原始数据结构。
如果只是想安全访问未加载的关联,可以写成:
'latest_post' => $this->whenLoaded('latestPost', new PostResource($this->latestPost)),
总结用法建议
- 使用 when(条件, 值) 实现字段级条件输出
- 在控制器中用 with() 预加载常用关联
- 在资源中用 whenLoaded() 安全地包含关联资源
- 复杂条件可用闭包返回动态值
基本上就这些。合理使用 when 和 whenLoaded,能让 API 返回更干净、高效的数据结构,同时避免意外的数据库查询。
