社区
学习
工具库
AI工具
休闲
搜索
简体中文
目录
关于 GraphQL
与REST对比
安装graphql-php包
开始
介绍
Schema 类
配置选项
ObjectType类
内置标量类型
字段参数
GraphQL 类
简单示例
普通示例
执行示例代码结果
对象示例
列表示例
使用类型语言
参考
首页 后端开发 php教程 详解PHP中如何安装和使用GraphQL

详解PHP中如何安装和使用GraphQL

青灯夜游
青灯夜游
May 07, 2021 pm 06:38 PM
graphql php

本篇文章带大家了解一下GraphQL，并详细介绍PHP中安装和使用GraphQL的方法。有一定的参考价值，有需要的朋友可以参考一下，希望对大家有所帮助。

详解PHP中如何安装和使用GraphQL

关于 GraphQL

GraphQL 是一种现代化的 HTTP API 接口构建方式，客户端可以按需查询需要的数据。
GraphQL 可以提升 API 调用的灵活性，我们可以像写数据库查询语句一样来请求 API 来获取所需要的数据，这对构建复杂的 API 查询来说非常有用。

与REST对比

REST的核心思想就是资源，每个资源都能用一个URL来表示，你能通过一个GET请求访问该URL从而获取该资源。根据当今大多数API的定义，你很有可能会得到一份JSON格式的数据响应，整个过程大概是这样：

GET /user/1
{
    "username":"姓名",
    "age":20,
    "sex":"男"
}
登录后复制
GET /book/1
{
    "book":"书名",
    "author":"作者",
    "country":"中国"
}
登录后复制

从上面的示例可以看出，如果前端需要user/1和book/1的时候需要调用2次接口，并且如果前端只需要user/1里面的username，而上面的接口获取了username以外的数据，那么对于前端而言，除 username 之外的数据无处可用，造成了资源的浪费。

如果我们使用GraphQL来进行查询的话，与REST方式相比，只需要调用一次并且可以查询我们指定的字段，避免了资源的浪费，并且更加高效。

query {
 user(id:1) {
     username
 }
 book(id:1){
     book,
     author,
     country
 }
}
登录后复制

推荐学习：《PHP视频教程》

安装graphql-php包

composer require webonyx/graphql-php
登录后复制

开始

1、安装完成之后，我们先编写一个简单示例，来看看graphql-php怎么用，具体代码如下：这段代码中，我们定义了一个名为phoneNumber的字段，然后通过postman来调用我们编写的代码。

<?php
require_once __DIR__ . &#39;/vendor/autoload.php&#39;;
use GraphQL\Type\Schema;
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type;
use GraphQL\GraphQL;

$queryType = new ObjectType([
    &#39;name&#39; => &#39;Query&#39;,
    &#39;fields&#39; => [
        &#39;phoneNumber&#39; => [
            &#39;type&#39; => Type::int(),
            &#39;resolve&#39; => function () {
                return 1875555555;
            }
        ]
    ],
]);

$schema = new Schema([
    &#39;query&#39; => $queryType,
]);



$rawInput = file_get_contents(&#39;php://input&#39;);
$input = json_decode($rawInput, true);

$query = $input[&#39;query&#39;];
$variableValues = isset($input[&#39;variables&#39;]) ? $input[&#39;variables&#39;] : null;

try {
    $rootValue = [&#39;prefix&#39; => &#39;prefix: &#39;];
    $result = GraphQL::executeQuery($schema, $query, $rootValue, null, $variableValues);
    $output = $result->toArray();
} catch (\Exception $e) {

    $output = [
        &#39;errors&#39; => [
            [
                &#39;message&#39; => $e->getMessage()
            ]
        ]
    ];
}
header(&#39;Content-Type: application/json&#39;);
echo json_encode($output);
登录后复制

2、使用postman来调用我们刚刚编写的代码，以下是我们查询结果的示例

1.png

介绍

从上面的示例中，我们可以看到示例主要引入了4个类

use GraphQL\Type\Schema;
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type;
use GraphQL\GraphQL;
登录后复制

Schema 类

Schema 是类型层次结构的容器，它接受构造函数中的根类型并向内部 GrahpQL 工具提供接收你的类型信息的方法。

配置选项

包含以下选项的数组：

OptionTypeNotes
queryObjectType必须。 读取 API 中包含根级字段的对象类型 (通常命名为 "Query")，用于读取数据
mutationObjectType写入 API 中包含根级字段的对象类型 (通常命名为 "Mutation")，数据变更时会用到
subscriptionObjectType保留用于将来的描述实现。目前表现为 graphql-js 自检查询的兼容，用于各种客户端 (如 Relay 或 GraphiQL)
directivesDirective[]默认包含内建指令 @skip 和 @include 。

如果你传递自定义指令并且依然想使用内建指令，请声明添加它们。例如：

array_merge(GraphQL::getStandardDirectives(), [$myCustomDirective]);
typesObjectType[]对象类型类表，它在静态 schema 解析期间是不能被 graphql-php 发现的。

大多数情况下，对象类型未曾在字段中被直接引用，但它依然是 schema 的一部分时会用到，因为它实现了一个在 resolveType 中调用解析为此对象类型的接口。

请注意，您在此处无需传递所有类型 ，它只是具体用例的解决方法。
typeLoadercallablefunction($name) 返回给定的类型实例名称。 多次调用情况下，必须返回同样的实例。 查阅下文延迟类型加载部分。

ObjectType类

GraphQL\Type\Definition\ObjectType
登录后复制

对象类型是典型的 GraphQL 应用程序中使用最频繁的基元。

配置选项

OptionTypeNotes
namestring必须。 Schema 中此对象的唯一名称
fieldsarray or callable必须。 描述对象字段或可调用返回此类数组的数组。
descriptionstring呈现于客户端的参数文本说明（例如：用于 GraphiQL 自动生成文档 ）
interfacesarray or callable此类型实现的接口列表或返回此类列表的可调用接口。

内置标量类型

<?php
use GraphQL\Type\Definition\Type;
// 内置标量类型
Type::string();  // String 类型
Type::int();     // Int 类型
Type::float();   // Float 类型
Type::boolean(); // Boolean 类型
Type::id();      // ID 类型
登录后复制

字段参数

GraphQL 对象类型上的所有字段都有 0 个或多个参数，使用在 args 的字段定义上。每个参数数组参考以下说明：

OptionTypeNotes
namestring必须。 参数名称。 为空时，使用 args 数组键值
typeType必须。
descriptionstring呈现于客户端的参数文本说明
defaultValuescalar当前参数默认值

示例

$queryType = new ObjectType([
    &#39;name&#39; => &#39;Query&#39;,
    &#39;fields&#39; => [
        &#39;phoneNumber&#39; => [
            &#39;type&#39; => Type::int(),
            &#39;resolve&#39; => function () {
                return 1875555555;
            }
        ]
    ],
]);
登录后复制

GraphQL 类

GraphQL类主要在查询的时候用到，我们可以用 GraphQL::executeQuery 方法来执行查询

executeQuery 方法的参数说明

参数类型说明
schemaGraphQL\Type\Schema必须。 Schema应用实例
queryStringstring or GraphQL\Language\AST\DocumentNode必须。 解析，验证并执行现有的 GraphQL 查询字符。 如果在执行之前解析其他查询，则在此处传递相应的 AST 文档节点来避免新的解析。
rootValuemixed表示数据图结构的基础值。作为Query type 字段解析传递的第一个参数。如果现有该值已被 Query type 解析过，则可忽略或设置为 null 值。
contextmixed字段解析器的共享信息。 常用来传递已登录用户信息，位置详情等。

它将用在所有字段解析器的第 3 个参数。
variableValuesarray变量的映射，该值将随同查询字符串一起传递。请查阅 GraphQL官网查询变量的相关。
operationNamestring指定请求方可执行的操作， 防止条件查询字符包含多级操作。
fieldResolvercallableSchema 参数 schema 中未实现的解析器函数。
validationRulesarray查询验证规则组，默认所有规则。空数组将跳过查询验证 (对于持久化查询将会比较方便，查询会在持久化之前默认已验证，并在执行期间假设符合规则)。
use GraphQL\GraphQL;

$result = GraphQL::executeQuery(
    $schema, 
    $queryString, 
    $rootValue = null, 
    $context = null, 
    $variableValues = null, 
    $operationName = null,
    $fieldResolver = null,
    $validationRules = null
);
登录后复制

简单示例

我们介绍完GraphQL几个概念之后，用几个简单的示例带大家来体验一下。

普通示例

在这个示例中我们定义了2个字段，分别是phoneNumber和echo，其中phoneNumber为 Type::int()类型，echo 为Type::string()类型，同时echo字段带有一个参数为message

<?php

require_once __DIR__ . &#39;/vendor/autoload.php&#39;;

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

$queryType = new ObjectType([
    &#39;name&#39; => &#39;Query&#39;,
    &#39;fields&#39; => [
        &#39;phoneNumber&#39; => [
            &#39;type&#39; => Type::int(),
            &#39;resolve&#39; => function () {
                return 1875555555;
            }
        ],

        &#39;echo&#39; => [
            &#39;type&#39; => Type::string(),
            &#39;args&#39; => [
                &#39;message&#39; => Type::string(),
            ],
            &#39;resolve&#39; => function ($root, $args) {
                return &#39;echo msg result：&#39; . ($args[&#39;message&#39;] ?? &#39;nothing&#39;);
            }
        ],
    ],
]);

$schema = new Schema([
    &#39;query&#39; => $queryType
]);


$rawInput = file_get_contents(&#39;php://input&#39;);
$input = json_decode($rawInput, true);

$query = $input[&#39;query&#39;];
$variableValues = isset($input[&#39;variables&#39;]) ? $input[&#39;variables&#39;] : null;

try {
    $rootValue = [&#39;prefix&#39; => &#39;prefix: &#39;];
    $result = GraphQL::executeQuery($schema, $query, $rootValue, null, $variableValues);
    $output = $result->toArray();
} catch (\Exception $e) {

    $output = [
        &#39;errors&#39; => [
            [
                &#39;message&#39; => $e->getMessage()
            ]
        ]
    ];
}
header(&#39;Content-Type: application/json&#39;);
echo json_encode($output);
登录后复制

执行示例代码结果

2.png

我们可以看到，在请求时我们传了phoneNumber和echo两个字段，并且message为test。

对象示例

我们在上面说过，对象类型是典型的 GraphQL 应用程序中使用最频繁的基元，一个对象类型里面可以包含宁外一个对象类型，我们可以新定义一个名为$userType的ObjectType，然后在oneUser指定它的类型为$userType,这样我们执行查询的时候，oneUser就会返回一个对象。

<?php
require_once __DIR__ . &#39;/vendor/autoload.php&#39;;

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

$userType = new ObjectType([
    &#39;name&#39; => &#39;userType&#39;,
    &#39;description&#39; => &#39;用户详情&#39;,
    &#39;fields&#39; => [
        &#39;uid&#39; => [
            &#39;type&#39; => Type::int(),
            &#39;description&#39; => &#39;用户ID&#39;
        ],
        &#39;name&#39; => Type::string()
    ]
]);


$queryType = new ObjectType([
    &#39;name&#39; => &#39;Query&#39;,
    &#39;fields&#39; => [
        &#39;oneUser&#39; => [
            &#39;type&#39; => $userType, // 我们这里指定type为我们上面创建的$userType
            &#39;description&#39; => &#39;用户列表&#39;,
            &#39;args&#39; => [
                &#39;uid&#39; => [
                    &#39;type&#39; => Type::int(),
                    &#39;defaultValue&#39; => 222
                ]
            ],
            &#39;resolve&#39; => function($root, $args) {
                return  [
                    "uid" => $args[&#39;user_id&#39;] ?? 3,
                    "name" => "xzl",
                ];
            }
        ],
    ]
]);

$schema = new Schema([
    &#39;query&#39; => $queryType
]);

$rawInput = file_get_contents(&#39;php://input&#39;);
$input = json_decode($rawInput, true);
$query = $input[&#39;query&#39;];
$variableValues = isset($input[&#39;variables&#39;]) ? $input[&#39;variables&#39;] : null;

try {
    $rootValue = [&#39;prefix&#39; => &#39;prefix: &#39;];
    $result = GraphQL::executeQuery($schema, $query, $rootValue, null, $variableValues);
    $output = $result->toArray();
} catch (\Exception $e) {
    $output = [
        &#39;errors&#39; => [
            [
                &#39;message&#39; => $e->getMessage()
            ]
        ]
    ];
}
header(&#39;Content-Type: application/json&#39;);
echo json_encode($output);
登录后复制

执行示例代码结果

3.png

列表示例

在平时的开发请求中，我们从后端接口获取数据的时候，大部分都是以列表的形式返回的，我们可以通过Type::listOf方法来指定我们返回的字段是一个列表。

<?php
require_once __DIR__ . &#39;/vendor/autoload.php&#39;;

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

class User
{
    // 模拟从数据库取数据
    public static function getUserLimit($limit)
    {
        $user  = [
            [
                "uid" => 1,
                "name" => "name1"
            ],
            [
                "uid" => 2,
                "name" => "name2"
            ],
            [
                "uid" => 3,
                "name" => "name3"
            ],
            [
                "uid" => 4,
                "name" => "name4"
            ]
        ];
        return array_slice($user, 0, $limit);
    }
}


$userType = new ObjectType([
    &#39;name&#39; => &#39;userType&#39;,
    &#39;description&#39; => &#39;用户详情&#39;,
    &#39;fields&#39; => [
        &#39;uid&#39; => [
            &#39;type&#39; => Type::int(),
            &#39;description&#39; => &#39;用户ID&#39;
        ],
        &#39;name&#39; => Type::string()
    ]
]);


$queryType = new ObjectType([
    &#39;name&#39; => &#39;Query&#39;,
    &#39;fields&#39; => [
        &#39;users&#39; => [
            &#39;type&#39; => Type::listOf($userType),
            &#39;description&#39; => &#39;用户列表&#39;,
            &#39;args&#39; => [
                &#39;limit&#39; => [
                    &#39;type&#39; => Type::int(),
                    &#39;description&#39; => &#39;限制条数&#39;,
                    &#39;defaultValue&#39; => 10
                ]
            ],
            &#39;resolve&#39; => function($root, $args) {
                return User::getUserLimit($args[&#39;limit&#39;]);
            }
        ]
    ]
]);



$schema = new Schema([
    &#39;query&#39; => $queryType
]);


$rawInput = file_get_contents(&#39;php://input&#39;);
$input = json_decode($rawInput, true);
$query = $input[&#39;query&#39;];
$variableValues = isset($input[&#39;variables&#39;]) ? $input[&#39;variables&#39;] : null;

try {
    $rootValue = [&#39;prefix&#39; => &#39;prefix: &#39;];
    $result = GraphQL::executeQuery($schema, $query, $rootValue, null, $variableValues);
    $output = $result->toArray();
} catch (\Exception $e) {
    $output = [
        &#39;errors&#39; => [
            [
                &#39;message&#39; => $e->getMessage()
            ]
        ]
    ];
}
header(&#39;Content-Type: application/json&#39;);
echo json_encode($output);
登录后复制

执行示例代码结果

4.png

从上面结果可以看到，我们传了limit参数为2，最终从我们模拟的数据里面取出了2条数据

使用类型语言

在上面的示例中，如果我们代码返回的数据比较复杂时，需要编写大量的代码，通过GraphQL类型语言，我们可以减少代码量，使代码看上去更加简洁，这是一个用 GraphQL 类型语言定义的简单 Schema示例。

<?php

require_once __DIR__ . &#39;/vendor/autoload.php&#39;;
use GraphQL\GraphQL;
use GraphQL\Utils\BuildSchema;
// graph.graphql  文件内容
$graph =
<<<GRAPH
schema {
  query: Query
}

type Query {
  graph_test: String
  echo(message: String): String
  show_test: Show
  show_test_arr: [Show]
}


type Show {
    content: String!
    text: String!
}
GRAPH;


$schema = BuildSchema::build($graph);
$rawInput = file_get_contents(&#39;php://input&#39;);
$input = json_decode($rawInput, true);
$query = $input[&#39;query&#39;];
$variableValues = isset($input[&#39;variables&#39;]) ? $input[&#39;variables&#39;] : null;

try {
    $rootValue = [
        &#39;sum&#39; => function($rootValue, $args, $context) {
            return $args[&#39;x&#39;] + $args[&#39;y&#39;];
        },
        &#39;echo&#39; => function($rootValue, $args, $context) {
            return $rootValue[&#39;prefix&#39;] . ($args[&#39;message&#39;] ?? &#39;no echo&#39;);
        },
        &#39;show_test&#39; => function($rootValue, $args, $context) {
            return [
                &#39;content&#39; => &#39;show_content&#39;,
                &#39;text&#39; => &#39;xxxx xxx&#39;
            ];
        },
        &#39;show_test_arr&#39; => function($rootValue, $args, $context) {
            return [
                [
                    &#39;content&#39; => &#39;show_content&#39;,
                    &#39;text&#39; => &#39;xxxx xxx&#39;
                ],
                [
                    &#39;content&#39; => &#39;show_content_2&#39;,
                    &#39;text&#39; => &#39;xxxx xxx_2&#39;
                ]

            ];
        },
        &#39;prefix&#39; => &#39;from test:&#39;,
        "graph_test" => "graphql_test"
    ];;
    $result = GraphQL::executeQuery($schema, $query, $rootValue, null, $variableValues);
    $output = $result->toArray();
} catch (\Exception $e) {

    \GraphQL\Server\StandardServer::send500Error($e);
}
header(&#39;Content-Type: application/json&#39;);
echo json_encode($output);
登录后复制

执行示例代码结果

5.png

参考

graphql.cn/learn/

learnku.com/docs/graphq…

更多编程相关知识，请访问：编程视频！！

以上是详解PHP中如何安装和使用GraphQL的详细内容。更多信息请关注PHP中文网其他相关文章！

本站声明
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系admin@php.cn

热AI工具

Undresser.AI Undress

Undresser.AI Undress

人工智能驱动的应用程序，用于创建逼真的裸体照片

AI Clothes Remover

AI Clothes Remover

用于从照片中去除衣服的在线人工智能工具。

Undress AI Tool

Undress AI Tool

免费脱衣服图片

Clothoff.io

Clothoff.io

AI脱衣机

AI Hentai Generator

AI Hentai Generator

免费生成ai无尽的。

显示更多

热门文章

R.E.P.O.能量晶体解释及其做什么（黄色晶体）
4 周前 By 尊渡假赌尊渡假赌尊渡假赌
R.E.P.O.最佳图形设置
4 周前 By 尊渡假赌尊渡假赌尊渡假赌
刺客信条阴影：贝壳谜语解决方案
2 周前 By DDD
R.E.P.O.如果您听不到任何人，如何修复音频
4 周前 By 尊渡假赌尊渡假赌尊渡假赌
WWE 2K25：如何解锁Myrise中的所有内容
1 个月前 By 尊渡假赌尊渡假赌尊渡假赌
显示更多

热工具

记事本++7.3.1

记事本++7.3.1

好用且免费的代码编辑器

SublimeText3汉化版

SublimeText3汉化版

中文版，非常好用

禅工作室 13.0.1

禅工作室 13.0.1

功能强大的PHP集成开发环境

Dreamweaver CS6

Dreamweaver CS6

视觉化网页开发工具

SublimeText3 Mac版

SublimeText3 Mac版

神级代码编辑软件(SublimeText3)

显示更多

热门话题

gmail邮箱登陆入口在哪里
7510
15
CakePHP 教程
1378
52
steam的账户名称是什么格式
78
11
win11激活密钥永久
53
19
NYT连接提示和答案
19
64
显示更多
Related knowledge
适用于 Ubuntu 和 Debian 的 PHP 8.4 安装和升级指南 适用于 Ubuntu 和 Debian 的 PHP 8.4 安装和升级指南 Dec 24, 2024 pm 04:42 PM

PHP 8.4 带来了多项新功能、安全性改进和性能改进，同时弃用和删除了大量功能。 本指南介绍了如何在 Ubuntu、Debian 或其衍生版本上安装 PHP 8.4 或升级到 PHP 8.4

如何设置 Visual Studio Code (VS Code) 进行 PHP 开发 如何设置 Visual Studio Code (VS Code) 进行 PHP 开发 Dec 20, 2024 am 11:31 AM

Visual Studio Code，也称为 VS Code，是一个免费的源代码编辑器 - 或集成开发环境 (IDE) - 可用于所有主要操作系统。 VS Code 拥有针对多种编程语言的大量扩展，可以轻松编写

您如何在PHP中解析和处理HTML/XML？ 您如何在PHP中解析和处理HTML/XML？ Feb 07, 2025 am 11:57 AM

本教程演示了如何使用PHP有效地处理XML文档。 XML（可扩展的标记语言）是一种用于人类可读性和机器解析的多功能文本标记语言。它通常用于数据存储

在PHP API中说明JSON Web令牌（JWT）及其用例。 在PHP API中说明JSON Web令牌（JWT）及其用例。 Apr 05, 2025 am 12:04 AM

JWT是一种基于JSON的开放标准，用于在各方之间安全地传输信息，主要用于身份验证和信息交换。1.JWT由Header、Payload和Signature三部分组成。2.JWT的工作原理包括生成JWT、验证JWT和解析Payload三个步骤。3.在PHP中使用JWT进行身份验证时，可以生成和验证JWT，并在高级用法中包含用户角色和权限信息。4.常见错误包括签名验证失败、令牌过期和Payload过大，调试技巧包括使用调试工具和日志记录。5.性能优化和最佳实践包括使用合适的签名算法、合理设置有效期、

php程序在字符串中计数元音 php程序在字符串中计数元音 Feb 07, 2025 pm 12:12 PM

字符串是由字符组成的序列，包括字母、数字和符号。本教程将学习如何使用不同的方法在PHP中计算给定字符串中元音的数量。英语中的元音是a、e、i、o、u，它们可以是大写或小写。 什么是元音？ 元音是代表特定语音的字母字符。英语中共有五个元音，包括大写和小写： a, e, i, o, u 示例 1 输入：字符串 = "Tutorialspoint" 输出：6 解释 字符串 "Tutorialspoint" 中的元音是 u、o、i、a、o、i。总共有 6 个元

我后悔之前不知道的 7 个 PHP 函数 我后悔之前不知道的 7 个 PHP 函数 Nov 13, 2024 am 09:42 AM

如果您是一位经验丰富的 PHP 开发人员，您可能会感觉您已经在那里并且已经完成了。您已经开发了大量的应用程序，调试了数百万行代码，并调整了一堆脚本来实现操作

解释PHP中的晚期静态绑定（静态：:)。 解释PHP中的晚期静态绑定（静态：:)。 Apr 03, 2025 am 12:04 AM

静态绑定（static::）在PHP中实现晚期静态绑定（LSB），允许在静态上下文中引用调用类而非定义类。1）解析过程在运行时进行，2）在继承关系中向上查找调用类，3）可能带来性能开销。

什么是PHP魔术方法（__ -construct，__destruct，__call，__get，__ set等）并提供用例？ 什么是PHP魔术方法（__ -construct，__destruct，__call，__get，__ set等）并提供用例？ Apr 03, 2025 am 12:03 AM

PHP的魔法方法有哪些？PHP的魔法方法包括：1.\_\_construct，用于初始化对象；2.\_\_destruct，用于清理资源；3.\_\_call，处理不存在的方法调用；4.\_\_get，实现动态属性访问；5.\_\_set，实现动态属性设置。这些方法在特定情况下自动调用，提升代码的灵活性和效率。

See all articles