在 Laravel 中动态隐藏 API 字段的方法
我最近在 laravel brasil 社区看到一个问题,结果比看起来更有趣。想象一下你有一个 usersresource 用下面的实现:
<?php namespace app\http\resources; use illuminate\http\resources\json\resource; class usersresource extends resource { /** * transform the resource into an array. * * @param \illuminate\http\request * @return array */ public function toarray($request) { return [ 'id' => $this->id, 'name' => $this->name, 'email' => $this->email ]; } }
出于某种原因,您可能希望在另一个端点上重新使用该资源类,但隐藏email 字段。这篇文章就是告诉你如何实现这一点的。
如果你不知道 api resources 是什么,请查看我之前关于这个的文章。
1- 初始化项目
有趣的东西从第3节开始.
composer create-project --prefer-dist laravel/laravel api-fields cd api-fields touch database/database.sqlite
编辑.env文件,删除数据库设置并使用 sqlite
db_connection=sqlite
继续设置项目
php artisan migrate php artisan make:resource usersresource php artisan make:resource --collection usersresourcecollection php artisan make:controller userscontroller php artisan tinker factory(app\user::class)->times(20)->create(); quit
2- 路由
确保在 api.php 文件中创建一个路由。
route::apiresource('/users', 'userscontroller');
3- 控制器
控制器代表了期望的目标。在这个例子中,让我们假设在用户列表中,我们只想要所有用户的名字,而在用户显示中,我们只想隐藏电子邮件地址。
<?php namespace app\http\controllers; use app\http\resources\usersresource; use app\user; class userscontroller extends controller { /** * display a listing of the resource. * * @param user $user * @return \illuminate\http\response */ public function index(user $user) { return usersresource::collection($user->paginate())->hide(['id', 'email']); } /** * display a user. * * @param user $user * @return \illuminate\http\response */ public function show(user $user) { return usersresource::make($user)->hide(['id']); } }
为了达到这个目的,我们需要 usersresourcecollection
和usersresource
同时知道如何处理 hide 调用。
4- usersresource 类
让我们从 show 方法开始. usersresource::make
将会返回 usersresource
的对象. 因此,我们应该揭开 hide 的神秘面纱,它可以存储我们期望从响应中移除的键.
<?php namespace app\http\resources; use illuminate\http\resources\json\resource; class usersresource extends resource { /** * @var array */ protected $withoutfields = []; /** * transform the resource into an array. * * @param \illuminate\http\request * @return array */ public function toarray($request) { return $this->filterfields([ 'id' => $this->id, 'name' => $this->name, 'email' => $this->email ]); } /** * set the keys that are supposed to be filtered out. * * @param array $fields * @return $this */ public function hide(array $fields) { $this->withoutfields = $fields; return $this; } /** * remove the filtered keys. * * @param $array * @return array */ protected function filterfields($array) { return collect($array)->forget($this->withoutfields)->toarray(); } }
大功告成! 现在我们可以访问 ,你会发现响应中已经没有id 字段了。
{ "data": { "name": "mr. frederik morar", "email": "darryl.wilkinson@example.org" } }
5- usersresourcecollection 类
执行项目集合中的 index 方法, 我们需要作出如下修改:
(1) 确保 usersresource::collection 返回 usersresourcecollection 实例
(2) 在 usersresourcecollection 上公开 hide 方法
(3) 将隐藏的字段传递给 usersresource
关于 (1), 我们只需要重写 usersresource 中的 collection 方法
<?php namespace app\http\resources; use illuminate\http\resources\json\resource; class usersresource extends resource { public static function collection($resource) { return tap(new usersresourcecollection($resource), function ($collection) { $collection->collects = __class__; }); } /** * @var array */ protected $withoutfields = []; /** * transform the resource into an array. * 将资源转换为一个数组 * * @param \illuminate\http\request * @return array */ public function toarray($request) { return $this->filterfields([ 'id' => $this->id, 'name' => $this->name, 'email' => $this->email ]); } /** * set the keys that are supposed to be filtered out. * 设置需要隐藏过滤掉的键 * * @param array $fields * @return $this */ public function hide(array $fields) { $this->withoutfields = $fields; return $this; } /** * remove the filtered keys. * 删除隐藏的键 * * @param $array * @return array */ protected function filterfields($array) { return collect($array)->forget($this->withoutfields)->toarray(); } }
关于 (2) 和 (3) 我们需要修改 usersresourcecollection 文件. 让我们公开 hide 方法并使用隐藏字段处理集合。.
<?php namespace app\http\resources; use illuminate\http\resources\json\resourcecollection; class usersresourcecollection extends resourcecollection { /** * @var array */ protected $withoutfields = []; /** * transform the resource collection into an array. * * @param \illuminate\http\request * @return array */ public function toarray($request) { return $this->processcollection($request); } public function hide(array $fields) { $this->withoutfields = $fields; return $this; } /** * send fields to hide to usersresource while processing the collection. * 将隐藏字段通过 usersresource 处理集合 * * @param $request * @return array */ protected function processcollection($request) { return $this->collection->map(function (usersresource $resource) use ($request) { return $resource->hide($this->withoutfields)->toarray($request); })->all(); } }
就是这么简单! 现在我们访问 看到返回结果中没有了 id 和 email 字段了如在 userscontroller 中的指定方法 .
{ "data": [{ "name": "mr. frederik morar" }, { "name": "angel daniel" }, { "name": "brianne mueller" }], "links": { "first": "http://lab.php71/api-fields-2/public/api/users?page=1", "last": "http://lab.php71/api-fields-2/public/api/users?page=7", "prev": null, "next": "http://lab.php71/api-fields-2/public/api/users?page=2" }, "meta": { "current_page": 1, "from": 1, "last_page": 7, "path": "http://api-fields.lab.php71/api/users", "per_page": 3, "to": 3, "total": 20 } }
6- 总结
本文目标是让resource类通过隐藏一些在其他接口允许暴露的字段从而变得更加灵活。例如当我们请求/users接口时响应的数据是不包含avatar字段的,但是当请求/users/99时响应的数据里包含avatar字段。
我不推荐过度重复去请求api资源,因为它很可能会把简单的事情变得更加复杂,所以说在请求的时候隐藏某些特定的字段是更简单、更合理的解决方案。
以上所述是小编给大家介绍的在 laravel 中动态隐藏 api 字段的方法,希望对大家有所帮助
推荐阅读
-
在iframe中隐藏横向滚动条的方法大全
-
基于Android在布局中动态添加view的两种方法(总结)
-
Android ListView中headerview的动态显示和隐藏的实现方法
-
基于Android在布局中动态添加view的两种方法(总结)
-
在oracle 数据库查询的select 查询字段中关联其他表的方法
-
Android ListView中headerview的动态显示和隐藏的实现方法
-
在 Laravel 6 中缓存数据库查询结果的方法
-
详解在iOS App中自定义和隐藏状态栏的方法
-
在oracle 数据库查询的select 查询字段中关联其他表的方法
-
详解在iOS App中自定义和隐藏状态栏的方法