PHP 在 Laravel 中动态隐藏 API 字段

概述我最近在 Laravel Brasil 社区看到一个问题，结果比看起来更有趣。想象一下你有一个 UsersResource 用下面的实现： 1 <?php 2 namespace App\Htt

我最近在 Laravel Brasil 社区看到一个问题，结果比看起来更有趣。想象一下你有一个 UsersResource 用下面的实现：

 1 <?PHP 2 namespace App\http\Resources; 3 use Illuminate\http\Resources\Json\Resource; 4 class UsersResource extends Resource 5 { 6 /** 7 * transform the resource into an array. 8 * 9 * @param \Illuminate\http\Request10 * @return array11 */12 public function toArray($request)13 {14 return [15 'ID' => $this->ID,16 'name' => $this->name,17 'email' => $this->email18 ];19 }20 }

出于某种原因，您可能希望在另一个端点上重新使用该资源类，但隐藏email 字段。这篇文章就是告诉你如何实现这一点的。 如果你不知道 API Resources 是什么，请查看我之前关于这个的文章。

First Impression on API Resources
API Resources with nested Relationship
1- 初始化项目
有趣的东西从第3节开始.

composer create-project --prefer-dist laravel/laravel API-fIEldscd API-fIEldstouch database/database.sqlite

编辑.env文件，删除数据库设置并使用 sqlite

DB_CONNECTION=sqlite
继续设置项目

1 PHP artisan migrate2 PHP artisan make:resource UsersResource3 PHP artisan make:resource --collection UsersResourceCollection 4 PHP artisan make:controller UsersController5 PHP artisan tinker6 factory(App\User::class)->times(20)->create();7 quit

 

2- 路由
确保在 API.PHP 文件中创建一个路由。

Route::APIResource('/users','UsersController');

 

3- 控制器
控制器代表了期望的目标。在这个例子中，让我们假设在用户列表中，我们只想要所有用户的名字，而在用户显示中，我们只想隐藏电子邮件地址。

 1 <?PHP 2 namespace App\http\Controllers; 3 use App\http\Resources\UsersResource; 4 use App\User; 5 class UsersController extends Controller 6 { 7 /** 8 * display a Listing of the resource. 9 *10 * @param User $user11 * @return \Illuminate\http\Response12 */13 public function index(User $user)14 {15 return UsersResource::collection($user->paginate())->hIDe(['ID','email']);16 }17 /**18 * display a user.19 *20 * @param User $user21 * @return \Illuminate\http\Response22 */23 public function show(User $user)24 {25 return UsersResource::make($user)->hIDe(['ID']);26 }27 }

 

为了达到这个目的，我们需要 UsersResourceCollection 和UsersResource 同时知道如何处理 hIDe 调用。

4- UsersResource 类
让我们从 show 方法开始. UsersResource::make 将会返回 UsersResource 的对象. 因此,我们应该揭开 hIDe 的神秘面纱，它可以存储我们期望从响应中移除的键.

 1 <?PHP 2 namespace App\http\Resources; 3 use Illuminate\http\Resources\Json\Resource; 4 class UsersResource extends Resource 5 { 6 /** 7 * @var array 8 */ 9 protected $withoutFIElds = [];10 11 /**12 * transform the resource into an array.13 *14 * @param \Illuminate\http\Request15 * @return array16 */17 public function toArray($request)18 {19 return $this->filterFIElds([20 'ID' => $this->ID,21 'name' => $this->name,22 'email' => $this->email23 ]);24 }25 /**26 * Set the keys that are supposed to be filtered out.27 *28 * @param array $fIElds29 * @return $this30 */31 public function hIDe(array $fIElds)32 {33 $this->withoutFIElds = $fIElds;34 return $this;35 }36 /**37 * Remove the filtered keys.38 *39 * @param $array40 * @return array41 */42 protected function filterFIElds($array)43 {44 return collect($array)->forget($this->withoutFIElds)->toArray();45 }46 }

 

大功告成! 现在我们可以访问 http://API.dev/API/users/1 ，你会发现响应中已经没有ID 字段了。

1 {2 "data": {3 "name": "Mr. Frederik Morar",4 "email": "darryl.wilkinson@example.org"5 }6 }

 

5- UsersResourceCollection 类
执行项目集合中的 index 方法,我们需要作出如下修改:

(1) 确保 UsersResource::collection 返回 UsersResourceCollection 实例
(2) 在 UsersResourceCollection 上公开 hIDe 方法
(3) 将隐藏的字段传递给 UsersResource
关于 (1),我们只需要重写 UsersResource 中的 collection 方法

 1 <?PHP 2 namespace App\http\Resources; 3 use Illuminate\http\Resources\Json\Resource; 4 class UsersResource extends Resource 5 { 6 public static function collection($resource) 7 { 8 return tap(new UsersResourceCollection($resource),function ($collection) { 9 $collection->collects = __CLASS__;10 });11 }12 13 /**14 * @var array15 */16 protected $withoutFIElds = [];17 /**18 * transform the resource into an array.19 * 将资源转换为一个数组20 * 21 * @param \Illuminate\http\Request22 * @return array23 */24 public function toArray($request)25 {26 return $this->filterFIElds([27 'ID' => $this->ID,28 'name' => $this->name,29 'email' => $this->email30 ]);31 }32 /**33 * Set the keys that are supposed to be filtered out.34 * 设置需要隐藏过滤掉的键35 * 36 * @param array $fIElds37 * @return $this38 */39 public function hIDe(array $fIElds)40 {41 $this->withoutFIElds = $fIElds;42 return $this;43 }44 /**45 * Remove the filtered keys.46 * 删除隐藏的键47 * 48 * @param $array49 * @return array50 */51 protected function filterFIElds($array)52 {53 return collect($array)->forget($this->withoutFIElds)->toArray();54 }55 }

 

关于 (2) 和 (3) 我们需要修改 UsersResourceCollection 文件. 让我们公开 hIDe 方法并使用隐藏字段处理集合。.

 1 <?PHP 2 namespace App\http\Resources; 3 use Illuminate\http\Resources\Json\ResourceCollection; 4 class UsersResourceCollection extends ResourceCollection 5 { 6 /** 7 * @var array 8 */ 9 protected $withoutFIElds = [];10 /**11 * transform the resource collection into an array.12 *13 * @param \Illuminate\http\Request14 * @return array15 */16 public function toArray($request)17 {18 return $this->processCollection($request);19 }20 public function hIDe(array $fIElds)21 {22 $this->withoutFIElds = $fIElds;23 return $this;24 }25 /**26 * Send fIElds to hIDe to UsersResource while processing the collection.27 * 将隐藏字段通过 UsersResource 处理集合28 * 29 * @param $request30 * @return array31 */32 protected function processCollection($request)33 {34 return $this->collection->map(function (UsersResource $resource) use ($request) {35 return $resource->hIDe($this->withoutFIElds)->toArray($request);36 })->all();37 }38 }

 

就是这么简单! 现在我们访问 http://API.dev/API/users 看到返回结果中没有了 ID 和 email 字段了如在 UsersController 中的指定方法 .

 1 { 2 "data": [{ 3 "name": "Mr. Frederik Morar" 4 }, { 5 "name": "Angel DanIEl" 6 }, { 7 "name": "Brianne Mueller" 8 }], 9 "links": {10 "first": "http://lab.PHP71/API-fIElds-2/public/API/users?page=1",11 "last": "http://lab.PHP71/API-fIElds-2/public/API/users?page=7",12 "prev": null,13 "next": "http://lab.PHP71/API-fIElds-2/public/API/users?page=2"14 },15 "Meta": {16 "current_page": 1,17 "from": 1,18 "last_page": 7,19 "path": "http://API-fIElds.lab.PHP71/API/users",20 "per_page": 3,21 "to": 3,22 "total": 2023 }24 }

 

6- 总结
本文目标是让Resource类通过隐藏一些在其他接口允许暴露的字段从而变得更加灵活。例如当我们请求/users接口时响应的数据是不包含avatar字段的，但是当请求/users/99时响应的数据里包含avatar字段。

我不推荐过度重复去请求API资源，因为它很可能会把简单的事情变得更加复杂，所以说在请求的时候隐藏某些特定的字段是更简单、更合理的解决方案。

总结

以上是内存溢出为你收集整理的PHP 在 Laravel 中动态隐藏 API 字段全部内容，希望文章能够帮你解决PHP 在 Laravel 中动态隐藏 API 字段所遇到的程序开发问题。

如果觉得内存溢出网站内容还不错，欢迎将内存溢出网站推荐给程序员好友。