在ThinkPHP6中使用GraphQL

隨著前后端分離的流行,傳統的 restful api 已經無法滿足現代互聯網的需求。問題在于每個資源的 api 都需要單獨設計,而且每次請求只會返回一個固定的結構,這就導致了大量的冗余請求和數據,程序變得非常笨重,不利于開發和維護。

GraphQL 的出現就解決了這個問題,它是一種新型的 API 查詢語言和運行時,能夠有效地減少網絡數據傳輸量和請求次數。與 RESTful API 不同的是,GraphQL 通過定義類型和模式來處理數據,這使得客戶端可以精確地請求所需的數據和類型,從而提高了數據的效率和響應速度。

在 PHP 開發中,thinkphp6 是一個流行的 Web 框架,提供了一些功能強大的特性,如面向對象編程、路由、模板和數據庫操作等。在本篇文章中,我們將介紹如何在 ThinkPHP6 中使用 GraphQL。

安裝

在開始之前,我們需要確保安裝好了 PHP 和 Composer,并且熟悉 ThinkPHP6 項目的基本結構。接下來,我們需要在項目中引入 GraphQL:

composer require overblog/graphql-bundle:^0.12.17

配置

在引入 GraphQL 后,我們需要在 ThinkPHP6 配置文件中添加一些必要的設置。打開 config/app.php 文件,找到 providers 數組,添加 GraphQL ServiceProvider:

立即學習PHP免費學習筆記(深入)”;

'providers' => [     // ...     OverblogGraphQLBundleGraphQLBundleServiceProvider::class, ]

接下來,我們需要定義 GraphQL 的路由,它將指向我們的 GraphQL 查詢控制器。這里我們可以使用一個獨立的路由文件 route/graphql.php,它返回一個路由列表:

acadeRoute;  Route::any('/graphql', 'graphql/index')->name('graphql');

其中,graphql/index 指向我們的 GraphQL 查詢控制器。

控制器

現在我們需要創建 GraphQL 控制器,它將負責處理所有 GraphQL 查詢和突變。我們創建一個 appcontrollerGraphql.php 文件,定義一個空類 Graphql,并繼承 OverblogGraphQLBundleControllerController:

<?php namespace appcontroller;  use OverblogGraphQLBundleControllerController;  class Graphql extends Controller {     // }

在這個類中,我們需要定義一些方法來處理 GraphQL 查詢和突變。在 PHP 中,我們可以使用注解來定義這些方法的操作。因此,我們需要添加注解支持。這里使用 doctrine/annotations 庫,使用 Composer 安裝:

composer require doctrine/annotations:^1.13.1

現在我們需要在 ThinkPHP6 中配置注解。打開 config/app.php 文件,編輯 providers 數組,添加 DoctrineCommonAnnotationsAnnotationReader 類:

'providers' =&gt; [     // ...     DoctrineCommonAnnotationsAnnotationReader::class, ]

在控制器中,我們可以定義一個 @Route 注解來指定 GraphQL 查詢的路由地址,以及一個 @ParamConverter 注解來自動轉換查詢參數等信息。例如,我們定義一個簡單的查詢方法:

use OverblogGraphQLBundleAnnotation as GQL;  /**  * @GQLType(type="MySchema")  * @GQLQueryList()  */ public function index() {     return []; }

其中,@Type 注解指定了返回值類型,@QueryList 注解指定這個方法是一個查詢方法。這里返回空數組,方便測試。接下來,我們需要定義圖形查詢模式。

模式

在模式中,我們定義了 GraphQL 的圖形方案。我們使用 GraphQL 類創建它,并使用 @Object, @Route 和 @Field 注解定義類型、方法和字段。例如,我們假設我們要查詢一個用戶列表,定義一個 UserQuery 類:

use GraphQLTypeDefinitionObjectType; use OverblogGraphQLBundleAnnotation as GQL;  /**  * @GQLType(type="query")  */ class UserQuery extends ObjectType {     /**      * @GQLField(type="[User]", name="users")      */     protected function getUsers()     {         return // return data from database or service;     } }

這里我們使用 GraphQLTypeDefinitionObjectType 類作為 UserQuery 的基類,它定義了查詢的字段和返回類型。我們添加了一個 getUsers 方法,它將返回一個用戶列表。我們還添加了一個 @Field 注解,它指定了這個字段的類型和名稱。在這個例子中,我們返回的是一個列表的用戶類型。

這里,我們使用 type=”[User]” 指定了用戶類型,它與定義用戶類型的方式有關。我們還可以寫一個 User 類型,具體定義方式可以參考 GitHub 上的 overblog/graphql-bundle 文檔。

查詢

現在我們已經定義了控制器和模式,我們可以通過瀏覽器訪問我們的 GraphQL Endpoint,我們的請求地址是 http://project.com/graphql?query={users{id,name}}。這里我們使用 POST 請求,傳遞查詢參數:

{   "query": "{users{id,name}}" }

這個請求將返回一個 JSON 格式的數據,其中包含了 ID 和名稱等信息。它的格式類似于這樣:

{     "data": {         "users": [             {                 "id": 1,                 "name": "Alice"             },             {                 "id": 2,                 "name": "Bob"             }         ]     } }

我們還可以使用變量來傳遞參數。例如,我們想要查詢用戶 ID 為 1 的詳細信息:

{   "query": "query GetUser($id:Int){user(id:$id){id,name,email}}",   "variables": {"id":1} }

這將返回用戶 ID、名稱和電子郵件地址等詳細信息。這里我們使用了一個 $ 符號來傳遞參數,它指定了我們要查詢用戶的 ID。我們使用 variables 關鍵字來定義實際變量,從而提供更精確的查詢參數。

總結

在本篇文章中,我們介紹了如何在 ThinkPHP6 框架中使用 GraphQL。首先,我們提出了 GraphQL 的背景和優點,然后安裝了必要的軟件包并配置了路由。接下來,我們定義了一個簡單的查詢示例,并使用注解定義其類型和操作。最后,我們介紹了 GraphQL 的變量和查詢方法,演示了如何使用 GraphQL 來查詢和處理數據。在實際開發中,我們可以根據需要自定義GraphQL 類型和操作,以實現更復雜的行為和查詢功能。

? 版權聲明
THE END
喜歡就支持一下吧
點贊7 分享