在最近的项目中，我需要与一个 graphql API 进行交互。一开始，我尝试手动构建 GraphQL 查询字符串，但很快就发现这非常繁琐且容易出错。特别是当查询变得复杂，包含嵌套字段、参数和变量时，手动编写查询字符串简直是一场噩梦。
我开始寻找一个能够简化 graphql 查询构建过程的 php 库。经过一番调研，我发现了 carnage/php-graphql-client。这个库提供了一套简洁而强大的工具，可以帮助我轻松地构建和执行 graphql 查询。
carnage/php-graphql-client 提供以下几个核心功能：
- Query 类： 用于构建 GraphQL 查询对象，支持设置选择集、参数和变量。
- QueryBuilder 类： 用于动态构建 Query 对象，适用于需要在运行时构建查询的场景。
- Client 类： 用于执行 GraphQL 查询，并获取结果。
安装
使用 Composer 安装 carnage/php-graphql-client 非常简单：
立即学习“PHP免费学习笔记（深入）”；
composer require carnage/php-graphql-client
使用 Query 类构建查询
Query 类提供了一种简洁的方式来构建 GraphQL 查询。以下是一个简单的示例：
use CarnageGraphQLClientQueryQuery; $gql = (new Query('companies')) ->setSelectionSet( [ 'name', 'serialNumber' ] );
这个查询将检索所有公司的名称和序列号。
使用 QueryBuilder 类构建查询
QueryBuilder 类提供了一种动态构建 Query 对象的方式。以下是一个示例：
use CarnageGraphQLClientQueryBuilderQueryBuilder; use CarnageGraphQLClientRawObject; $builder = (new QueryBuilder('companies')) ->setVariable('namePrefix', 'String', true) ->setArgument('filter', new RawObject('{name_starts_with: $namePrefix}')) ->selectField('name') ->selectField('serialNumber'); $gql = $builder->getQuery();
使用 Client 类执行查询
Client 类用于执行 GraphQL 查询并获取结果。以下是一个示例：
use CarnageGraphQLClientClient; $client = new Client('http://api.graphql.com'); $results = $client->runQuery($gql);
优势
使用 carnage/php-graphql-client 具有以下优势：
- 简化查询构建： Query 类和 QueryBuilder 类提供了一种简洁而强大的方式来构建 GraphQL 查询，避免了手动编写查询字符串的繁琐。
- 提高代码可读性： 使用 Query 类和 QueryBuilder 类构建的查询更易于阅读和理解。
- 减少错误： 自动处理查询字符串的格式化，减少了手动编写查询字符串时可能出现的错误。
- 支持变量： 支持使用变量来构建动态查询。
- 支持别名： 支持为查询字段设置别名。
- 支持接口和内联片段： 支持查询返回接口类型的字段，并使用内联片段访问具体类型的数据。
- 支持突变： 支持执行 GraphQL 突变。
实际应用效果
自从使用 carnage/php-graphql-client 以来，我构建 GraphQL 查询的效率大大提高。代码的可读性和可维护性也得到了显著提升。这个库极大地简化了与 GraphQL API 的交互，让我能够更专注于业务逻辑的实现。
如果你正在使用 PHP 与 GraphQL API 进行交互，我强烈推荐你尝试 carnage/php-graphql-client。它将极大地简化你的开发工作，提高你的开发效率。
