怎么在Laravel 中動(dòng)態(tài)隱藏 API 字段

今天就跟大家聊聊有關(guān)怎么在Laravel 中動(dòng)態(tài)隱藏 API 字段，可能很多人都不太了解，為了讓大家更加了解，小編給大家總結(jié)了以下內(nèi)容，希望大家根據(jù)這篇文章可以有所收獲。

<?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
  ];
 }
}

出于某種原因，您可能希望在另一個(gè)端點(diǎn)上重新使用該資源類(lèi)，但隱藏email 字段。這篇文章就是告訴你如何實(shí)現(xiàn)這一點(diǎn)的。

如果你不知道 API Resources 是什么，請(qǐng)查看我之前關(guān)于這個(gè)的文章。

• First Impression on API Resources

• API Resources with Nested Relationship

1- 初始化項(xiàng)目

有趣的東西從第3節(jié)開(kāi)始.

composer create-project --prefer-dist laravel/laravel api-fields
cd api-fields
touch database/database.sqlite

編輯.env文件，刪除數(shù)據(jù)庫(kù)設(shè)置并使用 SQLite

DB_CONNECTION=sqlite

繼續(xù)設(shè)置項(xiàng)目

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 文件中創(chuàng)建一個(gè)路由。

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

3- 控制器

控制器代表了期望的目標(biāo)。在這個(gè)例子中，讓我們假設(shè)在用戶列表中，我們只想要所有用戶的名字，而在用戶顯示中，我們只想隱藏電子郵件地址。

<?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']);
 }
}

為了達(dá)到這個(gè)目的，我們需要 UsersResourceCollection 和UsersResource 同時(shí)知道如何處理 hide 調(diào)用。

4- UsersResource 類(lèi)

讓我們從  show 方法開(kāi)始.  UsersResource::make 將會(huì)返回  UsersResource 的對(duì)象. 因此,我們應(yīng)該揭開(kāi)  hide 的神秘面紗，它可以存儲(chǔ)我們期望從響應(yīng)中移除的鍵.

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

大功告成! 現(xiàn)在我們可以訪問(wèn) http://api.dev/api/users/1 ，你會(huì)發(fā)現(xiàn)響應(yīng)中已經(jīng)沒(méi)有id 字段了。

{
 "data": {
 "name": "Mr. Frederik Morar",
 "email": "darryl.wilkinson@example.org"
 }
}

5- UsersResourceCollection 類(lèi)

執(zhí)行項(xiàng)目集合中的 index 方法, 我們需要作出如下修改:

(1) 確保  UsersResource::collection 返回 UsersResourceCollection 實(shí)例

(2) 在  UsersResourceCollection 上公開(kāi) hide 方法

(3) 將隱藏的字段傳遞給  UsersResource

關(guān)于 (1), 我們只需要重寫(xiě)  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.
  * 將資源轉(zhuǎn)換為一個(gè)數(shù)組
  * 
  * @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.
  * 設(shè)置需要隱藏過(guò)濾掉的鍵
  * 
  * @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();
 }
}

關(guān)于 (2) 和 (3) 我們需要修改 UsersResourceCollection 文件. 讓我們公開(kāi) 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.
  * 將隱藏字段通過(guò) 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();
 }
}

就是這么簡(jiǎn)單! 現(xiàn)在我們?cè)L問(wèn) http://api.dev/api/users  看到返回結(jié)果中沒(méi)有了 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
 }
}

Laravel 是什么

Laravel 是一套簡(jiǎn)潔、優(yōu)雅的PHP Web開(kāi)發(fā)框架。它可以讓你從面條一樣雜亂的代碼中解脫出來(lái)；它可以幫你構(gòu)建一個(gè)完美的網(wǎng)絡(luò)APP，而且每行代碼都可以簡(jiǎn)潔、富于表達(dá)力。

看完上述內(nèi)容，你們對(duì)怎么在Laravel 中動(dòng)態(tài)隱藏 API 字段有進(jìn)一步的了解嗎？如果還想了解更多知識(shí)或者相關(guān)內(nèi)容，請(qǐng)關(guān)注億速云行業(yè)資訊頻道，感謝大家的支持。