这是一篇社区协同翻译的文章,已完成翻译,更多信息请点击 协同翻译介绍 。
我最近在 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
是什么,请查看我之前关于这个的文章。
tanjibo 翻译于 6天前
0
重译
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
人来人往 翻译于 6天前
0
重译
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
调用。
tanjibo 翻译于 6天前
0
重译
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"
}
}
zoroo 翻译于 6天前
0
重译
5- The UsersResourceCollection 类
对于索引方法的项目的集合, 我们需要做一些稍微的调整:
- (1) 确保
UsersResource::collection
返回一个UsersResourceCollection
的实例 - (2) 暴露
UsersResourceCollection
的hide
方法 - (3) 传递隐藏字段到
UsersResource
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.
*
* @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
,我们可以看到结果就像我们指定 UsersController
的一样,没有 id
和 email
字段 。
{
"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
}
}
fmaple 翻译于 6天前
0
重译
6- 总结
本文目标是让Resource
类通过隐藏一些在其他接口允许暴露的字段从而变得更加灵活。例如当我们请求/users
接口时响应的数据是不包含avatar
字段的,但是当请求/users/99
时响应的数据里包含avatar
字段。
我不推荐过度重复去请求API资源,因为它很可能会把简单的事情变得更加复杂,所以说在请求的时候隐藏某些特定的字段是更简单、更合理的解决方案。
科大大 翻译于 6天前 0 重译本文中的所有译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。