🚵🏽 🌓 🔃 GraphQL APIはPHPとMySQLで作成します。パート1：インストール、図、クエリ 🗓️ 🤚 🕴🏿

最近、GraphQLについてよく耳にします。また、インターネット上には、GraphQLサーバーの作成方法に関する多くの記事が既にあります。しかし、これらの記事のほとんどすべてで、Node.jsはバックエンドとして使用されています。

私はNode.jsに反対することはなく、私自身も喜んで使用していますが、それでもほとんどのプロジェクトはPHPで行っています。さらに、PHPとMySQLを使用したホスティングは、Node.jsを使用したホスティングよりもはるかに安価で手頃な価格です。そのため、インターネット上のPHPでGraphQLを使用することについて事実上何の言葉もないことは、私には公平に思えません。

この記事では、 graphql-phpライブラリを使用してPHPでGraphQLサーバーを作成する方法と、それを使用してMySQLからデータを取得するための簡単なAPIを実装する方法について説明します。

この記事では特定のPHPフレームワークの使用を放棄することにしましたが、それを読んだ後、この知識をアプリケーションに適用することは難しくありません。さらに、一部のフレームワークには、作業を容易にするgraphql-phpに基づくライブラリが既にあります。

準備する

この記事ではフロントエンドを実行しません。したがって、GraphQLサーバーへのクエリを簡単にテストするために、ブラウザーにGraphiQL拡張機能をインストールすることをお勧めします。

Chromeの場合：

また、データベースにテーブルを作成し、テストデータセットを入力する必要があります。

「users」テーブルに、ユーザーのリストを保存します。

また、友情の表には、ユーザー間の友情を示す多対多の関係があります。

データベースダンプは、他のすべてのコードと同様に、Githubのこの記事のリポジトリから取得できます。

こんにちは、GraphQL！

まず、プロジェクトにgraphql-phpをインストールする必要があります。コンポーザーでこれを行うことができます：

composer require webonyx/graphql-php

今、伝統に従って、「Hello、World」と書きます。

これを行うには、ルートにgraphql.phpファイルを作成します。これは、GraphQLサーバーのエンドポイントとして機能します。

その中で、composerオートローダーを接続します。

 require_once __DIR__ . '/vendor/autoload.php';

GraphQLを接続します。

 use GraphQL\GraphQL;

GraphQLにクエリを実行させるには、クエリ自体とデータスキーマを渡す必要があります。

リクエストを受信するには、次のコードを記述します。

 $rawInput = file_get_contents('php://input'); $input = json_decode($rawInput, true); $query = $input['query'];

スキーマを作成するには、まずGraphQL \ Schemaを接続します。

 use GraphQL\Schema;

スキーマコンストラクターは、クエリルートデータ型を指定する必要のある配列を受け入れます。この配列は、APIのデータを読み取るのに役立つため、最初にこの型を作成します。

ご注意

スキーマには、データを書き込むためのAPIを提供するオプションのルートMutationデータ型を含めることもできますが、この記事では説明しません。

最も単純なケースでは、Queryデータ型はObjectTypeクラスのインスタンスであり、そのフィールドは単純型（たとえば、intまたはstring）である必要があるため、これらのデータ型を提供するクラスをGraphQLで接続します。

 use GraphQL\Type\Definition\Type; use GraphQL\Type\Definition\ObjectType;

そして、Queryデータ型を作成します。

 $queryType = new ObjectType([ 'name' => 'Query', 'fields' => [ 'hello' => [ 'type' => Type::string(), 'description' => ' ', 'resolve' => function () { return ', GraphQL!'; } ] ] ]);

ご覧のとおり、データ型には名前とフィールドの配列が含まれている必要があり、オプションの説明を指定することもできます。

ご注意

また、データ型には「interfaces」、「isTypeOf」、および「resolveField」プロパティが含まれる場合がありますが、この記事ではそれらを考慮しません。

データ型のフィールドには、必要なプロパティ「name」と「type」も必要です。「name」プロパティが設定されていない場合、フィールドキーが名前として使用されます（この場合は「hello」）。また、この例では、「hello」フィールドはオプションのプロパティ「description」（説明と「resolve」）に設定され、結果を返す関数です。この場合、「解決」関数は単に文字列「 Hello、GraphQL！ 」を返しますが、より困難な状況では、APIまたはデータベースから情報を受信して処理できます。

ご注意

フィールドには、この記事で後述するargsプロパティと、この記事では考慮されないdeprecationReasonプロパティも含めることができます。

したがって、1つのhelloフィールドのみを含むルートQueryデータ型を作成し、単純なテキスト文字列を返します。それをデータスキーマに追加しましょう。

 $schema = new Schema([ 'query' => $queryType ]);

そして、GraphQLクエリを実行して結果を取得します。

 $result = GraphQL::execute($schema, $query);

結果をJSON形式で出力するだけで、アプリケーションの準備は完了です。

 header('Content-Type: application/json; charset=UTF-8'); echo json_encode($result);

try-catchブロックでコードをラップしてエラーを処理すると、graphql.phpファイルのコードは次のようになります。

graphql.php

 <?php require_once __DIR__ . '/vendor/autoload.php'; use GraphQL\GraphQL; use GraphQL\Schema; use GraphQL\Type\Definition\Type; use GraphQL\Type\Definition\ObjectType; try { //   $rawInput = file_get_contents('php://input'); $input = json_decode($rawInput, true); $query = $input['query']; //    "" $queryType = new ObjectType([ 'name' => 'Query', 'fields' => [ 'hello' => [ 'type' => Type::string(), 'description' => ' ', 'resolve' => function () { return ', GraphQL!'; } ] ] ]); //   $schema = new Schema([ 'query' => $queryType ]); //   $result = GraphQL::execute($schema, $query); } catch (\Exception $e) { $result = [ 'error' => [ 'message' => $e->getMessage() ] ]; } //   header('Content-Type: application/json; charset=UTF-8'); echo json_encode($result);

GraphQLの動作を確認します。これを行うには、GraphiQLの拡張機能を実行し、エンドポイント（私の場合は「 localhost / graphql.php 」）をインストールして、クエリを実行します。

DBからのユーザーの結論

それでは、タスクを複雑にしましょう。 MySQLデータベースのユーザーをリストします。

これを行うには、ObjectTypeクラスの別のデータ型を作成する必要があります。 graphql.phpのコードを積み上げないために、すべてのデータ型を個別のファイルにエクスポートします。そして、私たち自身の中でデータ型を使用する機会があるように、それらをクラスの形に整理します。たとえば、データタイプ「user」にフィールド「friends」を追加できます。これは、同じタイプ「user」のユーザーの配列になります。

データ型をクラスとしてフォーマットする場合、デフォルトでクラス名から取得されるため、「name」プロパティを指定する必要はありません（たとえば、QueryTypeクラスの名前はQueryになります）。

これで、graphql.phpにあったルートクエリデータタイプ：

 $queryType = new ObjectType([ 'name' => 'Query', 'fields' => [ 'hello' => [ 'type' => Type::string(), 'description' => ' ', 'resolve' => function () { return ', GraphQL!'; } ] ] ]);

別のQueryType.phpファイルに配置され、次のようになります。

 class QueryType extends ObjectType { public function __construct() { $config = [ 'fields' => [ 'hello' => [ 'type' => Type::string(), 'description' => ' ', 'resolve' => function () { return ', GraphQL!'; } ] ] ]; parent::__construct($config); } }

また、型を定義するときにさらに無限の再帰を避けるために、「fields」プロパティでフィールドの配列ではなく、フィールドの配列を返す匿名関数を常に示すことをお勧めします。

 class QueryType extends ObjectType { public function __construct() { $config = [ 'fields' => function() { return [ 'hello' => [ 'type' => Type::string(), 'description' => ' ', 'resolve' => function () { return ', GraphQL!'; } ] ]; } ]; parent::__construct($config); } }

プロジェクトを開発すると、多くのデータ型が表示される場合があるため、プロジェクトで使用される基本的なデータ型を含む、すべてのデータ型のファクトリとして機能する個別のレジストリを作成することをお勧めします。 Appフォルダーと、その中にファイル、Types.phpを作成しましょう。これは、すべてのタイプのプロジェクトデータのまさにレジストリーです。

また、Appフォルダーで、Typeのサブフォルダーを作成します。このサブフォルダーには、すべてのデータ型を保存し、QueryType.phpを転送します。

ここで、名前空間を追加し、Types.phpレジストリに必要なタイプを入力します。

App / Types.php

 <?php namespace App; use App\Type\QueryType; use GraphQL\Type\Definition\Type; class Types { private static $query; public static function query() { return self::$query ?: (self::$query = new QueryType()); } public static function string() { return Type::string(); } }

レジストリには2つのデータ型のみがあります：1つの単純な（文字列）と1つの複合（クエリ）です。

代わりに他のすべてのファイルで：

 use GraphQL\Type\Definition\Type;

タイプレジストリを接続します。

 use App\Types;

そして、前述のすべての型をレジストリの型に置き換えます。

代わりにQueryType.phpで：

 Type::string()

次のようになります。

 Types::string()

そして、graphql.phpの図は次のようになります。

 $schema = new Schema([ 'query' => Types::query() ]);

データベースからユーザーを取得するには、それにアクセスするためのインターフェイスを提供する必要があります。任意の方法でデータベースからデータを取得できます。各フレームワークには、このための独自のツールがあります。この記事では、MySQLデータベースに接続してクエリを実行できる最も単純なインターフェイスを作成しました。これはGraphQLには適用されないため、このクラスでメソッドがどのように実装されるかについては説明せず、単にそのコードを示します。

アプリ/DB.php

 <?php namespace App; class DB { private static $pdo; public static function init($config) { self::$pdo = new PDO("mysql:host={$config['host']};dbname={$config['database']}", $config['username'], $config['password']); self::$pdo->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_OBJ); } public static function selectOne($query) { $records = self::select($query); return array_shift($records); } public static function select($query) { $statement = self::$pdo->query($query); return $statement->fetchAll(); } public static function affectingStatement($query) { $statement = self::$pdo->query($query); return $statement->rowCount(); } }

graphql.phpファイルで、データベースへの接続を初期化するコードを追加します。

 //     $config = [ 'host' => 'localhost', 'database' => 'gql', 'username' => 'root', 'password' => 'root' ]; //     DB::init($config);

次に、Typeフォルダーで、ユーザーデータを表示するユーザーデータタイプを作成します。 UserType.phpファイルのコードは次のようになります。

アプリ/タイプ/ UserType.php

 <?php namespace App\Type; use App\DB; use App\Types; use GraphQL\Type\Definition\ObjectType; class UserType extends ObjectType { public function __construct() { $config = [ 'description' => '', 'fields' => function() { return [ 'id' => [ 'type' => Types::string(), 'description' => ' ' ], 'name' => [ 'type' => Types::string(), 'description' => ' ' ], 'email' => [ 'type' => Types::string(), 'description' => 'E-mail ' ], 'friends' => [ 'type' => Types::listOf(Types::user()), 'description' => ' ', 'resolve' => function ($root) { return DB::select("SELECT u.* from friendships f JOIN users u ON u.id = f.friend_id WHERE f.user_id = {$root->id}"); } ], 'countFriends' => [ 'type' => Types::int(), 'description' => '  ', 'resolve' => function ($root) { return DB::affectingStatement("SELECT u.* from friendships f JOIN users u ON u.id = f.friend_id WHERE f.user_id = {$root->id}"); } ] ]; } ]; parent::__construct($config); } }

フィールドの意味は、「説明」プロパティから理解できます。プロパティ「id」、「name」、「email」、および「countFriends」には単純なタイプがあり、「friends」プロパティは友人のリストです-同じユーザーであるため、タイプがあります：

 Types::listOf(Types::user())

また、以前に使用したことのないいくつかの基本タイプをレジストリに追加する必要があります。

 public static function int() { return Type::int(); } public static function listOf($type) { return Type::listOf($type); }

そして、ユーザータイプを作成しました。

 private static $user; public static function user() { return self::$user ?: (self::$user = new UserType()); }

「friends」および「countFriends」プロパティの戻り値（解決）は、データベースから取得されます。 “ resolve”の匿名関数は、現在のフィールド（$ルート）の値を最初の引数として受け取ります。この引数から、フレンドリストリクエストに挿入するユーザーIDを見つけることができます。

ご注意

このコードはトレーニングを目的として作成されたため、リクエストのエスケープには注意を払いませんでしたが、もちろん実際のプロジェクトでこれを行うことはできません。

最後に、QueryType.phpコードを変更して、特定のユーザーに関する情報を識別子で取得するためのフィールド（「user」フィールド）とすべてのユーザーをリストするためのフィールド（「allUsers」フィールド）をAPIに追加します。

アプリ/タイプ/ QueryType.php

 <?php namespace App\Type; use App\DB; use App\Types; use GraphQL\Type\Definition\ObjectType; class QueryType extends ObjectType { public function __construct() { $config = [ 'fields' => function() { return [ 'user' => [ 'type' => Types::user(), 'description' => '   id', 'args' => [ 'id' => Types::int() ], 'resolve' => function ($root, $args) { return DB::selectOne("SELECT * from users WHERE id = {$args['id']}"); } ], 'allUsers' => [ 'type' => Types::listOf(Types::user()), 'description' => ' ', 'resolve' => function () { return DB::select('SELECT * from users'); } ] ]; } ]; parent::__construct($config); } }

ここでは、データを取得する必要があるユーザーの識別子を見つけるために、引数の配列を含む「user」フィールドの「args」プロパティを使用します。配列「args」は、2番目の引数によって匿名関数「resolve」に渡されます。これを使用して、ターゲットユーザーのIDがわかります。

ご注意

引数は独自のプロパティを持つことができますが、この場合、引数の配列を記述するために簡略化された形式を使用します。配列のキーは名前で、値は引数のタイプです。

 'args' => [ 'id' => Types::int() ]

代わりに：

 'args' => [ 'id' => [ 'type' => Types::int() ] ]

これで、GraphQLサーバーを起動し、次のクエリでその動作を確認できます。

またはこのように：

またはその他。

おわりに

以上です。ドキュメントを読んでください。コメントで質問してください。批判する。

また、Githubに関するコメント付きのソースコードを読むことをお勧めします。

この記事の他の部分：

GraphQL APIはPHPとMySQLで作成します。 パート1：インストール、図、クエリ

準備する

こんにちは、GraphQL！

DBからのユーザーの結論

おわりに

More articles:

GraphQL APIはPHPとMySQLで作成します。パート1：インストール、図、クエリ