当前位置:首页 > CMS教程 > 其它CMS > 列表

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

发布:smiling 来源: PHP粉丝网  添加日期:2022-01-18 10:39:27 浏览: 评论:0 

这篇文章主要介绍了在 Laravel 中动态隐藏 API 字段的方法,非常不错,具有一定的参考借鉴价值,需要的朋友可以参考下。

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

  1. <?php 
  2. namespace App\Http\Resources; 
  3. use Illuminate\Http\Resources\Json\Resource; 
  4. class UsersResource extends Resource 
  5.  /** 
  6.   * Transform the resource into an array. 
  7.   * 
  8.   * @param \Illuminate\Http\Request 
  9.   * @return array 
  10.   */ 
  11.  public function toArray($request
  12.  { 
  13.   return [ 
  14.    'id' => $this->id, 
  15.    'name' => $this->name, 
  16.    'email' => $this->email 
  17.   ]; 
  18.  } 

出于某种原因,您可能希望在另一个端点上重新使用该资源类,但隐藏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

继续设置项目

  1. php artisan migrate 
  2. php artisan make:resource UsersResource 
  3. php artisan make:resource --collection UsersResourceCollection  
  4. php artisan make:controller UsersController 
  5. php artisan tinker 
  6. 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.   * Display a listing of the resource. 
  8.   * 
  9.   * @param User $user 
  10.   * @return \Illuminate\Http\Response 
  11.   */ 
  12.  public function index(User $user
  13.  { 
  14.   return UsersResource::collection($user->paginate())->hide(['id''email']); 
  15.  } 
  16.  /** 
  17.   * Display a user. 
  18.   * 
  19.   * @param User $user 
  20.   * @return \Illuminate\Http\Response 
  21.   */ 
  22.  public function show(User $user
  23.  { 
  24.   return UsersResource::make($user)->hide(['id']); 
  25.  } 

为了达到这个目的,我们需要 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.   * @var array 
  7.   */ 
  8.  protected $withoutFields = []; 
  9.    
  10.   /** 
  11.   * Transform the resource into an array. 
  12.   * 
  13.   * @param \Illuminate\Http\Request 
  14.   * @return array 
  15.   */ 
  16.  public function toArray($request
  17.  { 
  18.   return $this->filterFields([ 
  19.    'id' => $this->id, 
  20.    'name' => $this->name, 
  21.    'email' => $this->email 
  22.   ]); 
  23.  } 
  24.  /** 
  25.   * Set the keys that are supposed to be filtered out. 
  26.   * 
  27.   * @param array $fields 
  28.   * @return $this 
  29.   */ 
  30.  public function hide(array $fields
  31.  { 
  32.   $this->withoutFields = $fields
  33.   return $this
  34.  } 
  35.  /** 
  36.   * Remove the filtered keys. 
  37.   * 
  38.   * @param $array 
  39.   * @return array 
  40.   */ 
  41.  protected function filterFields($array
  42.  { 
  43.   return collect($array)->forget($this->withoutFields)->toArray(); 
  44.  } 

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

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

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.  public static function collection($resource
  6.  { 
  7.   return tap(new UsersResourceCollection($resource), function ($collection) { 
  8.    $collection->collects = __CLASS__
  9.   }); 
  10.  } 
  11.    
  12.  /** 
  13.   * @var array 
  14.   */ 
  15.  protected $withoutFields = []; 
  16.  /** 
  17.   * Transform the resource into an array. 
  18.   * 将资源转换为一个数组 
  19.   *  
  20.   * @param \Illuminate\Http\Request 
  21.   * @return array 
  22.   */ 
  23.  public function toArray($request
  24.  { 
  25.   return $this->filterFields([ 
  26.    'id' => $this->id, 
  27.    'name' => $this->name, 
  28.    'email' => $this->email 
  29.   ]); 
  30.  } 
  31.  /** 
  32.   * Set the keys that are supposed to be filtered out. 
  33.   * 设置需要隐藏过滤掉的键 
  34.   *  
  35.   * @param array $fields 
  36.   * @return $this 
  37.   */ 
  38.  public function hide(array $fields
  39.  { 
  40.   $this->withoutFields = $fields
  41.   return $this
  42.  } 
  43.  /** 
  44.   * Remove the filtered keys. 
  45.   * 删除隐藏的键 
  46.   *  
  47.   * @param $array 
  48.   * @return array 
  49.   */ 
  50.  protected function filterFields($array
  51.  { 
  52.   return collect($array)->forget($this->withoutFields)->toArray(); 
  53.  } 

关于 (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.   * @var array 
  7.   */ 
  8.  protected $withoutFields = []; 
  9.  /** 
  10.   * Transform the resource collection into an array. 
  11.   * 
  12.   * @param \Illuminate\Http\Request 
  13.   * @return array 
  14.   */ 
  15.  public function toArray($request
  16.  { 
  17.   return $this->processCollection($request); 
  18.  } 
  19.  public function hide(array $fields
  20.  { 
  21.   $this->withoutFields = $fields
  22.   return $this
  23.  } 
  24.  /** 
  25.   * Send fields to hide to UsersResource while processing the collection. 
  26.   * 将隐藏字段通过 UsersResource 处理集合 
  27.   *  
  28.   * @param $request 
  29.   * @return array 
  30.   */ 
  31.  protected function processCollection($request
  32.  { 
  33.   return $this->collection->map(function (UsersResource $resourceuse ($request) { 
  34.    return $resource->hide($this->withoutFields)->toArray($request); 
  35.   })->all(); 
  36.  } 

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

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

6- 总结

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

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

Tags: Laravel动态隐藏 API

分享到: