railt

简介

项目理念是干净和高质量的代码。

与大多数（目前所有）实现不同，如webonyx、 youshido或digitalonline， Railt包含一个完全自己实现的GraphQL SDL解析器，它基于类EBNF语法。这个机会不仅允许拥有语言的原始实现并始终保持它最新，而且还可以实现新的向后兼容功能，这是其他实现所不具备的。

Railt的目标：

不重复JS基础实现中犯的错误。
为PHP开发人员实现现代和便捷的环境。
实现轻松集成到任何基于PSR的现成解决方案中。
提供熟悉的功能（包括依赖注入、路由等）。

安装

composer require railt/railt

快速入门

本教程将帮助您：

获得对GraphQL原理的基本理解。
定义一个代表数据集结构的GraphQL模式。
运行Railt应用程序的实例，让您可以针对模式执行查询。

本教程假设您熟悉命令行和PHP，并且已安装最新版本的PHP（v8.1+）。

步骤1：创建新项目

从您喜欢的开发目录中，创建一个新项目的目录并cd进入：

mkdir railt-example
cd railt-example

使用Composer初始化一个新项目：

composer init
composer require railt/railt dev-master@dev

您的项目目录现在包含一个composer.json文件。

请注意，如果安装出现与安装开发版本相关的错误（"根据您的最低稳定性设置，该软件包没有可用的足够稳定的版本"），您需要在composer.json文件中指定"minimum-stability": "dev"。

更多信息请参见https://getcomposer.org/doc/04-schema.md#minimum-stability

运行Railt应用程序的应用程序可能需要两个顶级依赖项：

railt/webonyx-executor - 一个执行器，提供一个 webonyx/graphql-php桥接器，用于启动和处理GraphQL请求。
railt/router-extension - 一个路由器扩展，提供了一种方便的方式将GraphQL请求委派给控制器实例。

或者，您可以单独安装所有组件：
composer require railt/factory railt/webonyx-executor railt/router-extension

步骤2：定义您的GraphQL模式

每个GraphQL应用程序（包括Railt）都使用模式来定义客户端可以查询的数据结构。在本例中，我们将创建一个应用程序，通过id和name查询用户集合。

在您喜欢的代码编辑器中打开index.graphqls并粘贴以下内容：

# GraphQL字符串中的注释（如此注释）
# 以井号（#）符号开头。
# 这个"User"类型定义了我们数据源中每个用户的可查询字段。
type User {
    id: ID
    name: String
}

# "Query"类型是特殊的:它列出了客户端可以执行的所有可用查询,
# 以及每个查询的返回类型。在这种情况下,"users"
# 查询返回零个或多个User(在上面定义)的数组。
type Query {
    users: [User]
}

现在只需打开(创建)"index.php"文件,并将以下内容粘贴到其中:

<?php

require __DIR__ . '/vendor/autoload.php';

//
// 创建一个应用程序
//
$application = new Railt\Foundation\Application(
    executor: new Railt\Executor\Webonyx\WebonyxExecutor(),
);

$application->extend(new Railt\Extension\Router\DispatcherExtension());

//
// 创建一个连接实例,用于处理
// 传入的请求并返回响应。
//
$connection = $application->connect(
    schema: new \SplFileInfo(__DIR__ . '/index.graphqls'),
);

这个片段定义了一个简单、有效的GraphQL模式。客户端将能够执行名为"users"的查询,我们的服务器将返回零个或多个"User"的数组。

步骤2.1: 模式健康检查

要对应用程序进行健康检查,您可以通过传递带有所需GraphQL查询字符串的请求对象来手动创建"GraphQLRequest"实例。

//
// 将请求传递给指定的连接。
// 
$response = $connection->handle(
    request: new \Railt\Http\GraphQLRequest(
        query: '{ users { id, name } }',
    ),
);

dump($response->toArray());

//
// 预期输出:
//
// array:1 [
//   "data" => array:1 [
//     "users" => []
//   ]
// ]
//

步骤3: 定义控制器

解析器告诉Railt应用程序如何获取与特定类型相关的数据。因为我们的"User"数组是硬编码的,所以相应的解析器很简单。

创建一个带有"UserController"类的控制器文件,例如带有"index()"方法和以下代码:

<?php

class UserController
{
    public function index(): iterable
    {
        return [
            ['id' => 1, 'name' => 'Vasya'],
            ['id' => 2, 'name' => 'Petya'],
        ];
    }
}

确保此类可用于自动加载或文件包含在"index.php"中。

步骤4: 将字段绑定到控制器操作

我们已经定义了我们的数据集,但Railt应用程序不知道在执行查询时应该使用该数据集。为了解决这个问题,我们创建一个路由。

路由告诉Railt如何获取与特定类型相关的数据。因为我们的"User"数组是硬编码的,所以相应的路由很简单。

在"index.graphqls"文件底部添加以下"@route"指令:

# ...
type User {
    id: ID
    name: String
}

# ...
type Query {
    users: [User]
        # 路由指令可以在这里定义
        @route(action: "UserController->index")
}

步骤5: 处理HTTP

要传递请求数据并发送响应,我们必须完成"index.php"文件。

{tip} 如果您使用Symfony、 Laravel或其他http层 (例如,psr-7),那么您可以根据提供的框架API和/或规范组织数据获取。

$data = json_decode(file_get_contents('php://input'), true);

$response = $connection->handle(
    request: new \Railt\Http\GraphQLRequest(
        query: $data['query'] ?? '',
        variables: $data['variables'] ?? [],
        operationName: $data['operationName'] ?? null,
    ),
);

$json = json_encode($response->toArray());

header('Content-Type: application/json');
header('Access-Control-Allow-Origin: *');

echo $json;

步骤6: 启动服务器

我们准备启动我们的服务器了!从项目的根目录运行以下命令:

php -S 127.0.0.0:80

你现在应该在终端底部看到以下输出:

PHP 8.2.6 Development Server (http://127.0.0.1:80) started

我们已经启动并运行了!

步骤7: 执行你的第一个查询

我们现在可以在服务器上执行GraphQL查询了。要执行我们的第一个查询, 我们可以使用Apollo Sandbox、 GraphQL Playground或其他工具。

我们的服务器支持一个名为"users"的查询。让我们执行它!

这是执行"users"查询的GraphQL查询字符串:

{
  users {
    id
    name
  }
}

将此字符串粘贴到查询面板中,然后单击"发送请求"按钮(GraphQL 界面和面板布局可能取决于您使用的平台/客户端)。结果(来自我们硬编码的数据集)显示在响应面板中:

/img/get-started-request.png

GraphQL最重要的概念之一是客户端可以选择只查询他们需要的字段。从查询字符串中删除"name" 并再次执行。响应会更新,只包含每个"User"的"id"字段!

学习Railt

完整文档可以在官方网站上找到。

贡献

感谢您考虑为Railt框架做出贡献! 贡献指南可以在文档中找到。

安全漏洞

如果您在Railt中发现安全漏洞,请发送电子邮件至 nesk@xakep.ru。所有安全漏洞都将得到及时处理。

许可证

Railt框架是根据MIT许可证许可的开源软件。

帮助和社区

如果遇到问题或有疑问，请加入我们的 Discord 社区。我们很乐意与您交流！

支持方

简介

安装

快速入门

步骤1：创建新项目

步骤2：定义您的GraphQL模式

步骤2.1: 模式健康检查

步骤3: 定义控制器

步骤4: 将字段绑定到控制器操作

步骤5: 处理HTTP

步骤6: 启动服务器

步骤7: 执行你的第一个查询

学习Railt

贡献

安全漏洞

许可证

帮助和社区

支持方

编辑推荐精选

蛙蛙写作

Trae

问小白

Transly

讯飞智文

讯飞星火

Spark-TTS

咔片PPT

讯飞绘文

材料星

探索AI的无限可能

推荐工具精选

Trae

豆包

讯飞文书

讯飞绘文

讯飞绘镜

阿里绘蛙

咔片PPT

AI云服务特惠

火山引擎

阿里云

腾讯云

华为云

百度智能云

AWS

关注微信公众号