這篇文章主要介紹了深入淺析JSONAPI在PHP中的應(yīng)用,需要的朋友可以參考下

現(xiàn)在服務(wù)端程式設(shè)計(jì)師的主要工作已經(jīng)不再是套模版，而是編寫(xiě)基於JSON 的API 介面?？上Т蠹覍?xiě)介面的風(fēng)格往往迥異，這就為系統(tǒng)整合帶來(lái)了很多不必要的溝通成本，如果你有類(lèi)似的困擾，那麼不妨關(guān)註一下JSONAPI ，它是一個(gè)基於JSON 構(gòu)建API 的規(guī)範(fàn)標(biāo)準(zhǔn)，一個(gè)簡(jiǎn)單的API 介面大致如下所示：

JSONAPI

#簡(jiǎn)單說(shuō)明一下：根節(jié)點(diǎn)中的data 用來(lái)放置主物件的內(nèi)容，其中type 和id 是必須要有的字段，用來(lái)表示主對(duì)象的類(lèi)型和標(biāo)識(shí)，其它簡(jiǎn)單的屬性統(tǒng)統(tǒng)放置到attributes 裡，如果主對(duì)象存在一對(duì)一、一對(duì)多等關(guān)聯(lián)對(duì)象，那麼放置到relationships 裡，不過(guò)只是通過(guò)type 和id 字段放置一個(gè)鏈接，關(guān)聯(lián)物件的實(shí)際內(nèi)容統(tǒng)統(tǒng)放置在根接點(diǎn)中的included 裡。

有了 JSONAPI，資料解析的過(guò)程變得規(guī)範(fàn)起來(lái)，節(jié)省了不必要的溝通成本。不過(guò)如果要手動(dòng)建立JSONAPI 資料還是很麻煩的，好在透過(guò)使用Fractal 可以讓實(shí)現(xiàn)過(guò)程相對(duì)自動(dòng)化一些，上面的例子如果用Fractal 實(shí)現(xiàn)大概是這個(gè)樣子：

<?php
use League\Fractal\Manager;
use League\Fractal\Resource\Collection;
$articles = [
  [
    &#39;id&#39; => 1,
    &#39;title&#39; => &#39;JSON API paints my bikeshed!&#39;,
    &#39;body&#39; => &#39;The shortest article. Ever.&#39;,
    &#39;author&#39; => [
      &#39;id&#39; => 42,
      &#39;name&#39; => &#39;John&#39;,
    ],
  ],
];
$manager = new Manager();
$resource = new Collection($articles, new ArticleTransformer());
$manager->parseIncludes(&#39;author&#39;);
$manager->createData($resource)->toArray();
?>

如果讓我選最喜愛(ài)的PHP 工具包，F(xiàn)ractal 一定榜上有名，它隱藏了實(shí)作細(xì)節(jié)，讓使用者完全不必了解JSONAPI 協(xié)定即可上手。不過(guò)如果你想在自己的專(zhuān)案裡使用的話，與直接使用Fractal 相比，可以試試Fractalistic ，它對(duì)Fractal 進(jìn)行了封裝，使其更好用：

<?php
Fractal::create()
  ->collection($articles)
  ->transformWith(new ArticleTransformer())
  ->includeAuthor()
  ->toArray();
?>

如果你是裸寫(xiě)PHP的話，那麼Fractalistic 基本上就是最佳選擇了，不過(guò)如果你使用了一些全?？蚣艿脑?，那麼Fractalistic 可能還不夠優(yōu)雅，因?yàn)樗鼰o(wú)法和框架本身已有的功能更完美的融合，以Lavaral 為例，它本身內(nèi)建了一個(gè)API Resources 功能，在此基礎(chǔ)上我實(shí)作了一個(gè)JsonApiSerializer，可以和框架完美融合，程式碼如下：

<?php
namespace App\Http\Serializers;
use Illuminate\Http\Resources\MissingValue;
use Illuminate\Http\Resources\Json\Resource;
use Illuminate\Http\Resources\Json\ResourceCollection;
use Illuminate\Pagination\AbstractPaginator;
class JsonApiSerializer implements \JsonSerializable
{
  protected $resource;
  protected $resourceValue;
  protected $data = [];
  protected static $included = [];
  public function __construct($resource, $resourceValue)
  {
    $this->resource = $resource;
    $this->resourceValue = $resourceValue;
  }
  public function jsonSerialize()
  {
    foreach ($this->resourceValue as $key => $value) {
      if ($value instanceof Resource) {
        $this->serializeResource($key, $value);
      } else {
        $this->serializeNonResource($key, $value);
      }
    }
    if (!$this->isRootResource()) {
      return $this->data;
    }
    $result = [
      &#39;data&#39; => $this->data,
    ];
    if (static::$included) {
      $result[&#39;included&#39;] = static::$included;
    }
    if (!$this->resource->resource instanceof AbstractPaginator) {
      return $result;
    }
    $paginated = $this->resource->resource->toArray();
    $result[&#39;links&#39;] = $this->links($paginated);
    $result[&#39;meta&#39;] = $this->meta($paginated);
    return $result;
  }
  protected function serializeResource($key, $value, $type = null)
  {
    if ($type === null) {
      $type = $key;
    }
    if ($value->resource instanceof MissingValue) {
      return;
    }
    if ($value instanceof ResourceCollection) {
      foreach ($value as $k => $v) {
        $this->serializeResource($k, $v, $type);
      }
    } elseif (is_string($type)) {
      $included = $value->resolve();
      $data = [
        &#39;type&#39; => $included[&#39;type&#39;],
        &#39;id&#39; => $included[&#39;id&#39;],
      ];
      if (is_int($key)) {
        $this->data[&#39;relationships&#39;][$type][&#39;data&#39;][] = $data;
      } else {
        $this->data[&#39;relationships&#39;][$type][&#39;data&#39;] = $data;
      }
      static::$included[] = $included;
    } else {
      $this->data[] = $value->resolve();
    }
  }
  protected function serializeNonResource($key, $value)
  {
    switch ($key) {
      case &#39;id&#39;:
        $value = (string)$value;
      case &#39;type&#39;:
      case &#39;links&#39;:
        $this->data[$key] = $value;
        break;
      default:
        $this->data[&#39;attributes&#39;][$key] = $value;
    }
  }
  protected function links($paginated)
  {
    return [
      &#39;first&#39; => $paginated[&#39;first_page_url&#39;] ?? null,
      &#39;last&#39; => $paginated[&#39;last_page_url&#39;] ?? null,
      &#39;prev&#39; => $paginated[&#39;prev_page_url&#39;] ?? null,
      &#39;next&#39; => $paginated[&#39;next_page_url&#39;] ?? null,
    ];
  }
  protected function meta($paginated)
  {
    return [
      &#39;current_page&#39; => $paginated[&#39;current_page&#39;] ?? null,
      &#39;from&#39; => $paginated[&#39;from&#39;] ?? null,
      &#39;last_page&#39; => $paginated[&#39;last_page&#39;] ?? null,
      &#39;per_page&#39; => $paginated[&#39;per_page&#39;] ?? null,
      &#39;to&#39; => $paginated[&#39;to&#39;] ?? null,
      &#39;total&#39; => $paginated[&#39;total&#39;] ?? null,
    ];
  }
  protected function isRootResource()
  {
    return isset($this->resource->isRoot) && $this->resource->isRoot;
  }
}
?>

對(duì)應(yīng)的Resource 基本上還和之前一樣，只是回傳值改了一下：

<?php
namespace App\Http\Resources;
use App\Article;
use Illuminate\Http\Resources\Json\Resource;
use App\Http\Serializers\JsonApiSerializer;
class ArticleResource extends Resource
{
  public function toArray($request)
  {
    $value = [
      &#39;type&#39; => &#39;articles&#39;,
      &#39;id&#39; => $this->id,
      &#39;name&#39; => $this->name,
      &#39;author&#39; => $this->whenLoaded(&#39;author&#39;),
    ];
    return new JsonApiSerializer($this, $value);
  }
}
?>

對(duì)應(yīng)的Controller 也和原來(lái)差不多，只是加入了一個(gè)isRoot 屬性，用來(lái)識(shí)別根：

<?php
namespace App\Http\Controllers;
use App\Article;
use App\Http\Resources\ArticleResource;
class ArticleController extends Controller
{
  protected $article;
  public function __construct(Article $article)
  {
    $this->article = $article;
  }
  public function show($id)
  {
    $article = $this->article->with(&#39;author&#39;)->findOrFail($id);
    $resource = new ArticleResource($article);
    $resource->isRoot = true;
    return $resource;
  }
}
?>

整個(gè)過(guò)程沒(méi)有對(duì)Laravel 的架構(gòu)進(jìn)行太大的侵入，可以說(shuō)是目前Laravel 實(shí)現(xiàn)JSONAPI 的最優(yōu)解決方案了，有興趣的可以研究一下JsonApiSerializer 的實(shí)現(xiàn)，雖然只有一百多行程式碼，但是我卻費(fèi)了好大的力氣才實(shí)現(xiàn)，可以說(shuō)是行行皆辛苦啊。

上面是我整理給大家的，希望今後對(duì)大家有幫助。

相關(guān)文章：

在Vue中設(shè)定背景圖片

#使用vue less如何實(shí)作簡(jiǎn)單換膚功能

使用angular、react和vue如何實(shí)現(xiàn)相同的面試題元件

#利用jQuery實(shí)作捲動(dòng)到底部時(shí)自動(dòng)載入

########################### ###在Angular2.0中如何實(shí)現(xiàn)modal對(duì)話框############在JS中如何實(shí)現(xiàn)運(yùn)動(dòng)緩衝效果（詳細(xì)教學(xué)）#######

以上是在PHP中如何使用JSONAPI的詳細(xì)內(nèi)容。更多資訊請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！