在 Laravel 中动态隐藏 API 字段的方法


Posted in PHP onOctober 25, 2019

我最近在 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 是什么,请查看我之前关于这个的文章。

  • First Impression on API Resources
  • API Resources with Nested Relationship

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();
 }
}

大功告成! 现在我们可以访问 http://api.dev/api/users/1 ,你会发现响应中已经没有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();
 }
}

就是这么简单! 现在我们访问 http://api.dev/api/users  看到返回结果中没有了 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 字段的方法,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对三水点靠木网站的支持!
如果你觉得本文对你有帮助,欢迎转载,烦请注明出处,谢谢!

PHP 相关文章推荐
在Windows系统上安装PHP运行环境文字教程
Jul 19 PHP
新手学习PHP的一些基础知识分享
Jul 27 PHP
destoon调用自定义模板及样式的公告栏
Jun 21 PHP
ThinkPHP的URL重写问题
Jun 22 PHP
PHP的error_reporting错误级别变量对照表
Jul 08 PHP
php使用gettimeofday函数返回当前时间并存放在关联数组里
Mar 19 PHP
php中的常用魔术方法汇总
Feb 14 PHP
Laravel中Trait的用法实例详解
Mar 16 PHP
php版微信开发之接收消息,自动判断及回复相应消息的方法
Sep 23 PHP
php生成图片缩略图功能示例
Feb 22 PHP
PHP工厂模式简单实现方法示例
May 23 PHP
TP3.2.3框架使用CKeditor编辑器在页面中上传图片的方法分析
Dec 31 PHP
Laravel 实现添加多语言提示信息
Oct 25 #PHP
Laravel5.5 动态切换多语言的操作方式
Oct 25 #PHP
解决php扩展安装不生效问题
Oct 25 #PHP
Laravel实现通过blade模板引擎渲染视图
Oct 25 #PHP
laravel 解决Validator使用中出现的问题
Oct 25 #PHP
laravel接管Dingo-api和默认的错误处理方式
Oct 25 #PHP
Laravel 解决419错误 -ajax请求错误的问题(CSRF验证)
Oct 25 #PHP
You might like
打造计数器DIY三步曲(上)
2006/10/09 PHP
thinkphp中session和cookie无效的解决方法
2014/12/19 PHP
smarty模板引擎中自定义函数的方法
2015/01/22 PHP
PHP中file_get_contents函数抓取https地址出错的解决方法(两种方法)
2015/09/22 PHP
window.showModalDialog使用手册
2007/01/11 Javascript
锋利的jQuery jQuery中的DOM操作
2010/03/21 Javascript
手把手教你自己写一个js表单验证框架的方法
2010/09/14 Javascript
jquery中实现简单的tabs插件功能的代码
2011/03/02 Javascript
IE6下opacity与JQuery的奇妙结合
2013/03/01 Javascript
javascript 手动给表增加数据的小例子
2013/07/10 Javascript
关于Javascript作用域链的八点总结
2013/12/06 Javascript
javascript实现playfair和hill密码算法
2014/12/07 Javascript
深入理解JavaScript系列(48):对象创建模式(下篇)
2015/03/04 Javascript
jQuery实现预加载图片的方法
2015/03/17 Javascript
AngularJS初始化静态模板详解
2016/01/14 Javascript
jquery淡入淡出效果简单实例
2016/01/14 Javascript
DOM中事件处理概览与原理的全面解析
2016/08/16 Javascript
jQuery给指定的table动态添加删除行的操作方法
2016/10/12 Javascript
vue、react等单页面项目部署到服务器的方法及vue和react的区别
2018/09/29 Javascript
nodejs+express最简易的连接数据库的方法
2020/12/23 NodeJs
[47:45]Liquid vs OG 2018国际邀请赛小组赛BO2 第二场 8.16
2018/08/17 DOTA
python模拟新浪微博登陆功能(新浪微博爬虫)
2013/12/24 Python
Python中低维数组填充高维数组的实现
2019/12/02 Python
基于python检查矩阵计算结果
2020/05/21 Python
Django限制API访问频率常用方法解析
2020/10/12 Python
Python创建文件夹与文件的快捷方法
2020/12/08 Python
Selenium Webdriver元素定位的八种常用方式(小结)
2021/01/13 Python
基于HTML5新特性Mutation Observer实现编辑器的撤销和回退操作
2016/01/11 HTML / CSS
英国最大的在线时尚眼镜店:Eyewearbrands
2019/03/12 全球购物
什么是类的返射机制
2016/02/06 面试题
Prototype如何更新局部页面
2013/03/03 面试题
外语专业毕业生自荐信
2014/04/14 职场文书
实践单位评语
2014/04/26 职场文书
标准版离职证明书
2014/09/12 职场文书
优秀教师先进事迹材料
2014/12/15 职场文书
通过feDisplacementMap和feImage实现水波特效
2022/04/24 HTML / CSS