插件窝 干货文章 在ThinkPHP6中使用GraphQL

在ThinkPHP6中使用GraphQL

我们 GraphQL class 定义 651    来源:    2024-10-24

随着前后端分离的流行,传统的 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,它返回一个路由列表:

<?php

use thinkacadeRoute;

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' => [
    // ...
    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 类型和操作,以实现更复杂的行为和查询功能。