詳解PHP中如何安裝使用GraphQL
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__ . '/vendor/autoload.php';
use GraphQL\Type\Schema;
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type;
use GraphQL\GraphQL;
$queryType = new ObjectType([
'name' => 'Query',
'fields' => [
'phoneNumber' => [
'type' => Type::int(),
'resolve' => function () {
return 1875555555;
}
]
],
]);
$schema = new Schema([
'query' => $queryType,
]);
$rawInput = file_get_contents('php://input');
$input = json_decode($rawInput, true);
$query = $input['query'];
$variableValues = isset($input['variables']) ? $input['variables'] : null;
try {
$rootValue = ['prefix' => 'prefix: '];
$result = GraphQL::executeQuery($schema, $query, $rootValue, null, $variableValues);
$output = $result->toArray();
} catch (\Exception $e) {
$output = [
'errors' => [
[
'message' => $e->getMessage()
]
]
];
}
header('Content-Type: application/json');
echo json_encode($output);登入後複製
2、使用postman來呼叫我們剛剛寫的程式碼，以下是我們查詢結果的範例
##介紹
從上面的範例中，我們可以看到範例主要引入了4個類別use GraphQL\Type\Schema; use GraphQL\Type\Definition\ObjectType; use GraphQL\Type\Definition\Type; use GraphQL\GraphQL;
登入後複製
#Schema 類別
Schema 是類型層次結構的容器，它接受建構函式中的根類型並向內部GrahpQL 工具提供接收你的類型資訊的方法。設定選項
包含下列選項的陣列：| Type | Notes | |
|---|---|---|
#ObjectType | 必須。 讀取API 中包含根級字段的物件類型(通常命名為"Query")，用於讀取資料 | |
# ObjectType | 寫入API 中包含根級欄位的物件類型 (通常命名為"Mutation")，資料變更時會用到||
ObjectType | 保留用於未來的描述實作。目前表現為graphql-js 自檢查詢的相容，用於各種客戶端(如Relay 或GraphiQL) | |
#Directive[] | 預設包含內建指令@skip 和@include 。 如果你傳遞自訂指令並且仍然想使用內建指令，請聲明添加它們。例如： array_merge(GraphQL::getStandardDirectives(), [$myCustomDirective]); | |
#ObjectType[] | 物件類型類別表，它在靜態schema 解析期間是不能被graphql-php 發現的。 大多數情況下，物件類型未曾在欄位中直接被引用，但它仍然是schema 的一部分時會用到，因為它實作了一個在 resolveType 中呼叫解析為此物件類型的介面。 請注意，您在此處無需傳遞所有類型 ，它只是具體用例的解決方法。 | |
callable | #function($name) 傳回給定的類型實例名稱。多次呼叫情況下，必須傳回同樣的實例。查閱下文延遲類型載入部分。 |
| Option | Type | Notes |
|---|---|---|
| name | string | 必须。 Schema 中此对象的唯一名称 |
| fields | array or callable | 必须。 描述对象字段或可调用返回此类数组的数组。 |
| description | string | 呈现于客户端的参数文本说明（例如：用于 GraphiQL 自动生成文档 ） |
| interfaces | array 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 的字段定义上。每个参数数组参考以下说明：
| Option | Type | Notes |
|---|---|---|
| name | string | 必须。 参数名称。 为空时，使用 args 数组键值 |
| type | Type | 必须。 |
| description | string | 呈现于客户端的参数文本说明 |
| defaultValue | scalar | 当前参数默认值 |
示例
$queryType = new ObjectType([
'name' => 'Query',
'fields' => [
'phoneNumber' => [
'type' => Type::int(),
'resolve' => function () {
return 1875555555;
}
]
],
]);登入後複製
GraphQL 类
GraphQL类主要在查询的时候用到，我们可以用 GraphQL::executeQuery 方法来执行查询
executeQuery 方法的参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| schema | GraphQL\Type\Schema | 必须。 Schema应用实例 |
| queryString | string or GraphQL\Language\AST\DocumentNode | 必须。 解析，验证并执行现有的 GraphQL 查询字符。 如果在执行之前解析其他查询，则在此处传递相应的 AST 文档节点来避免新的解析。 |
| rootValue | mixed | 表示数据图结构的基础值。作为Query type 字段解析传递的第一个参数。如果现有该值已被 Query type 解析过，则可忽略或设置为 null 值。 |
| context | mixed | 字段解析器的共享信息。 常用来传递已登录用户信息，位置详情等。 它将用在所有字段解析器的第 3 个参数。 |
| variableValues | array | 变量的映射，该值将随同查询字符串一起传递。请查阅 GraphQL官网查询变量的相关。 |
| operationName | string | 指定请求方可执行的操作， 防止条件查询字符包含多级操作。 |
| fieldResolver | callable | Schema 参数 schema 中未实现的解析器函数。 |
| validationRules | array | 查询验证规则组，默认所有规则。空数组将跳过查询验证 (对于持久化查询将会比较方便，查询会在持久化之前默认已验证，并在执行期间假设符合规则)。 |
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__ . '/vendor/autoload.php';
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type;
use GraphQL\GraphQL;
use GraphQL\Type\Schema;
$queryType = new ObjectType([
'name' => 'Query',
'fields' => [
'phoneNumber' => [
'type' => Type::int(),
'resolve' => function () {
return 1875555555;
}
],
'echo' => [
'type' => Type::string(),
'args' => [
'message' => Type::string(),
],
'resolve' => function ($root, $args) {
return 'echo msg result：' . ($args['message'] ?? 'nothing');
}
],
],
]);
$schema = new Schema([
'query' => $queryType
]);
$rawInput = file_get_contents('php://input');
$input = json_decode($rawInput, true);
$query = $input['query'];
$variableValues = isset($input['variables']) ? $input['variables'] : null;
try {
$rootValue = ['prefix' => 'prefix: '];
$result = GraphQL::executeQuery($schema, $query, $rootValue, null, $variableValues);
$output = $result->toArray();
} catch (\Exception $e) {
$output = [
'errors' => [
[
'message' => $e->getMessage()
]
]
];
}
header('Content-Type: application/json');
echo json_encode($output);登入後複製
执行示例代码结果
我们可以看到，在请求时我们传了phoneNumber和echo两个字段，并且message为test。
对象示例
我们在上面说过，对象类型是典型的 GraphQL 应用程序中使用最频繁的基元，一个对象类型里面可以包含宁外一个对象类型，我们可以新定义一个名为$userType的ObjectType，然后在oneUser指定它的类型为$userType,这样我们执行查询的时候，oneUser就会返回一个对象。
<?php
require_once __DIR__ . '/vendor/autoload.php';
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type;
use GraphQL\GraphQL;
use GraphQL\Type\Schema;
$userType = new ObjectType([
'name' => 'userType',
'description' => '用户详情',
'fields' => [
'uid' => [
'type' => Type::int(),
'description' => '用户ID'
],
'name' => Type::string()
]
]);
$queryType = new ObjectType([
'name' => 'Query',
'fields' => [
'oneUser' => [
'type' => $userType, // 我们这里指定type为我们上面创建的$userType
'description' => '用户列表',
'args' => [
'uid' => [
'type' => Type::int(),
'defaultValue' => 222
]
],
'resolve' => function($root, $args) {
return [
"uid" => $args['user_id'] ?? 3,
"name" => "xzl",
];
}
],
]
]);
$schema = new Schema([
'query' => $queryType
]);
$rawInput = file_get_contents('php://input');
$input = json_decode($rawInput, true);
$query = $input['query'];
$variableValues = isset($input['variables']) ? $input['variables'] : null;
try {
$rootValue = ['prefix' => 'prefix: '];
$result = GraphQL::executeQuery($schema, $query, $rootValue, null, $variableValues);
$output = $result->toArray();
} catch (\Exception $e) {
$output = [
'errors' => [
[
'message' => $e->getMessage()
]
]
];
}
header('Content-Type: application/json');
echo json_encode($output);登入後複製
执行示例代码结果
列表示例
在平时的开发请求中，我们从后端接口获取数据的时候，大部分都是以列表的形式返回的，我们可以通过Type::listOf方法来指定我们返回的字段是一个列表。
<?php
require_once __DIR__ . '/vendor/autoload.php';
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([
'name' => 'userType',
'description' => '用户详情',
'fields' => [
'uid' => [
'type' => Type::int(),
'description' => '用户ID'
],
'name' => Type::string()
]
]);
$queryType = new ObjectType([
'name' => 'Query',
'fields' => [
'users' => [
'type' => Type::listOf($userType),
'description' => '用户列表',
'args' => [
'limit' => [
'type' => Type::int(),
'description' => '限制条数',
'defaultValue' => 10
]
],
'resolve' => function($root, $args) {
return User::getUserLimit($args['limit']);
}
]
]
]);
$schema = new Schema([
'query' => $queryType
]);
$rawInput = file_get_contents('php://input');
$input = json_decode($rawInput, true);
$query = $input['query'];
$variableValues = isset($input['variables']) ? $input['variables'] : null;
try {
$rootValue = ['prefix' => 'prefix: '];
$result = GraphQL::executeQuery($schema, $query, $rootValue, null, $variableValues);
$output = $result->toArray();
} catch (\Exception $e) {
$output = [
'errors' => [
[
'message' => $e->getMessage()
]
]
];
}
header('Content-Type: application/json');
echo json_encode($output);登入後複製
执行示例代码结果
从上面结果可以看到，我们传了limit参数为2，最终从我们模拟的数据里面取出了2条数据
使用类型语言
在上面的示例中，如果我们代码返回的数据比较复杂时，需要编写大量的代码，通过GraphQL类型语言，我们可以减少代码量，使代码看上去更加简洁，这是一个用 GraphQL 类型语言定义的简单 Schema示例。
<?php
require_once __DIR__ . '/vendor/autoload.php';
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('php://input');
$input = json_decode($rawInput, true);
$query = $input['query'];
$variableValues = isset($input['variables']) ? $input['variables'] : null;
try {
$rootValue = [
'sum' => function($rootValue, $args, $context) {
return $args['x'] + $args['y'];
},
'echo' => function($rootValue, $args, $context) {
return $rootValue['prefix'] . ($args['message'] ?? 'no echo');
},
'show_test' => function($rootValue, $args, $context) {
return [
'content' => 'show_content',
'text' => 'xxxx xxx'
];
},
'show_test_arr' => function($rootValue, $args, $context) {
return [
[
'content' => 'show_content',
'text' => 'xxxx xxx'
],
[
'content' => 'show_content_2',
'text' => 'xxxx xxx_2'
]
];
},
'prefix' => 'from test:',
"graph_test" => "graphql_test"
];;
$result = GraphQL::executeQuery($schema, $query, $rootValue, null, $variableValues);
$output = $result->toArray();
} catch (\Exception $e) {
\GraphQL\Server\StandardServer::send500Error($e);
}
header('Content-Type: application/json');
echo json_encode($output);登入後複製
执行示例代码结果
参考
更多编程相关知识，请访问：编程视频！！
以上是詳解PHP中如何安裝使用GraphQL的詳細內容。更多資訊請關注PHP中文網其他相關文章！
本網站聲明
本文內容由網友自願投稿，版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容，請聯絡admin@php.cn
熱AI工具
Undresser.AI Undress
人工智慧驅動的應用程序，用於創建逼真的裸體照片
AI Clothes Remover
用於從照片中去除衣服的線上人工智慧工具。
Undress AI Tool
免費脫衣圖片
Clothoff.io
AI脫衣器
AI Hentai Generator
免費產生 AI 無盡。
熱門文章
R.E.P.O.能量晶體解釋及其做什麼（黃色晶體）
3 週前
By 尊渡假赌尊渡假赌尊渡假赌
R.E.P.O.最佳圖形設置
3 週前
By 尊渡假赌尊渡假赌尊渡假赌
刺客信條陰影：貝殼謎語解決方案
2 週前
By DDD
R.E.P.O.如果您聽不到任何人，如何修復音頻
3 週前
By 尊渡假赌尊渡假赌尊渡假赌
WWE 2K25：如何解鎖Myrise中的所有內容
4 週前
By 尊渡假赌尊渡假赌尊渡假赌
熱工具
記事本++7.3.1
好用且免費的程式碼編輯器
SublimeText3漢化版
中文版，非常好用
禪工作室 13.0.1
強大的PHP整合開發環境
Dreamweaver CS6
視覺化網頁開發工具
SublimeText3 Mac版
神級程式碼編輯軟體(SublimeText3)
熱門話題
適用於 Ubuntu 和 Debian 的 PHP 8.4 安裝和升級指南
Dec 24, 2024 pm 04:42 PM
PHP 8.4 帶來了多項新功能、安全性改進和效能改進，同時棄用和刪除了大量功能。 本指南介紹如何在 Ubuntu、Debian 或其衍生版本上安裝 PHP 8.4 或升級到 PHP 8.4
討論 CakePHP
Sep 10, 2024 pm 05:28 PM
CakePHP 是 PHP 的開源框架。它旨在使應用程式的開發、部署和維護變得更加容易。 CakePHP 基於類似 MVC 的架構，功能強大且易於掌握。模型、視圖和控制器 gu
如何設定 Visual Studio Code (VS Code) 進行 PHP 開發
Dec 20, 2024 am 11:31 AM
Visual Studio Code，也稱為 VS Code，是一個免費的原始碼編輯器 - 或整合開發環境 (IDE) - 可用於所有主要作業系統。 VS Code 擁有大量針對多種程式語言的擴展，可以輕鬆編寫
CakePHP 快速指南
Sep 10, 2024 pm 05:27 PM
CakePHP 是一個開源MVC 框架。它使應用程式的開發、部署和維護變得更加容易。 CakePHP 有許多函式庫可以減少大多數常見任務的過載。
您如何在PHP中解析和處理HTML/XML？
Feb 07, 2025 am 11:57 AM
本教程演示瞭如何使用PHP有效地處理XML文檔。 XML（可擴展的標記語言）是一種用於人類可讀性和機器解析的多功能文本標記語言。它通常用於數據存儲
