ホームページ > 記事 > ウェブフロントエンド > PHP での JSONAPI のアプリケーション

PHP での JSONAPI のアプリケーション

小云云オリジナル: 2017-12-25 14:54:561400ブラウズ

現在、サーバープログラマーの主な仕事は、テンプレートを設定することではなく、JSON ベースの API インターフェイスを作成することです。残念ながら、インターフェイスの記述スタイルは人によって大きく異なることが多く、これによりシステム統合に多くの不必要な通信コストが発生します。同じような問題がある場合は、JSON に基づいて API を構築するための標準である JSONAPI に注目することをお勧めします。簡単な API インターフェイスは大まかに次のとおりです:

JSONAPI

簡単な説明: ルートノードのデータは、メインオブジェクトのコンテンツを配置するために使用されます。type と id は、オブジェクトのタイプと識別を表す必須フィールドです。メインオブジェクト、他のすべての単純な属性は属性に配置されます。メインオブジェクトに 1 対 1、1 対多、およびその他の関連オブジェクトがある場合、それらはリレーションシップに配置されます。 type フィールドと id フィールド、および関連するオブジェクトの実際のコンテンツがルートノードに含まれます。

JSONAPI を使用すると、データ解析のプロセスが標準化され、不必要な通信コストが節約されます。ただし、JSONAPI データを手動で構築するのは依然として非常に面倒です。幸いなことに、Fractal を使用すると、実装プロセスは比較的自動化できます。おそらく、次のようになります。お気に入りの PHP ツールキットを選択するように求められたら、Fractal がリストにあるはずです。これにより、実装の詳細が隠蔽され、ユーザーは JSONAPI プロトコルをまったく知らなくても始めることができます。ただし、Fractal を直接使用する代わりに、独自のプロジェクトで使用したい場合は、使いやすくするために Fractal をカプセル化する Fractalistic を試すことができます:

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

PHP を裸で書いている場合、Fractalistic は基本的に最良の選択ですが、フルスタックフレームワークを使用する場合、Fractalistic はフレームワーク自体の既存の機能とより完全に統合できないため、十分にエレガントではない可能性があります。例として Lavaral 自体には、組み込みの機能があります。これに基づいて、フレームワークと完全に統合できる JsonApiSerializer を実装しました。コードは次のとおりです。変更されました:

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

の対応するコントローラーは、ルートを識別するために isRoot 属性が追加されている点を除いて、オリジナルと似ています:

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

プロセス全体は、Laravel のアーキテクチャにあまり侵入しません。 Laravel は現在 JSONAPI を実装していると言えます。興味があれば、JsonApiSerializer の実装を検討してください。ただし、実装には多大な労力を費やしました。どの段階も大変な作業だと言われます。

PHP での JSONAPI のアプリケーション

関連記事