GraphQL应用程序服务器

Commerce GraphQL Application Server使Adobe Commerce能够维护Commerce GraphQL API请求中的状态。 GraphQL Application Server基于Swoole扩展构建，作为具有工作线程的进程运行，这些工作线程处理请求。 GraphQL Application Server通过在GraphQL API请求中保留引导的应用程序状态，来增强请求处理和整体产品性能。 API请求变得非常高效。

GraphQL Application Server仅适用于Adobe Commerce。 它不适用于Magento Open Source。 对于Cloud Pro项目，您必须提交Adobe Commerce支持票证以启用GraphQL应用程序服务器。

架构

GraphQL Application Server可维护Commerce GraphQL API请求之间的状态，并且无需引导。 通过跨进程共享应用程序状态，GraphQL请求可以显着提升效率，将响应时间最多减少30%。

无共享PHP执行模型从延迟的角度提供了一个挑战，因为每个请求都需要框架的引导。 此引导过程包括一些耗时的任务，如读取配置、设置引导过程和创建服务类对象。

将请求处理逻辑转换为应用程序级事件循环似乎解决了在企业级简化请求处理的难题。 此方法消除了在请求执行生命周期期间进行引导的需要。

优点

GraphQL Application Server允许Adobe Commerce在连续的Commerce GraphQL API请求之间保持状态。 跨请求共享应用程序状态通过最大限度地减少处理开销和优化请求处理而增强了API请求效率。 因此，GraphQL请求响应时间最多可缩短30%。

系统要求

运行GraphQL Application Server需要满足以下条件：

在云基础架构上启用和部署

ApplicationServer模块(Magento/ApplicationServer/)启用GraphQL应用程序服务器。

启用Pro项目

在Pro项目上启用应用程序服务器功能后，请先完成以下步骤，然后再部署GraphQL Application Server：

部署Pro项目

完成启用步骤后，将更改推送到Git存储库以部署GraphQL Application Server：

git push

启用入门项目

在启动项目上部署GraphQL Application Server之前，请完成以下步骤：

部署入门项目

完成启用步骤后，将更改推送到您的Git存储库以部署GraphQL Application Server：

git push

验证云项目上的启用情况

如果这些验证步骤成功，则GraphQL Application Server正在运行并提供/graphql请求。

启用内部部署项目

ApplicationServer模块(Magento/ApplicationServer/)为GraphQL API启用GraphQL Application Server。

在本地运行GraphQL Application Server需要安装Swoole扩展，并对部署的Nginx配置文件进行细微更改。

先决条件

在启用ApplicationServer模块之前，请完成以下步骤：

配置Nginx

您的特定Commerce部署决定了如何配置Nginx。 通常，Nginx配置文件默认名为nginx.conf，并位于以下目录之一： /usr/local/nginx/conf、/etc/nginx或/usr/local/etc/nginx。 有关配置Nginx的更多信息，请参阅​ 初学者指南。

示例Nginx配置：

location /graphql {
    proxy_set_header Host $http_host;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

    proxy_pass http://127.0.0.1:9501/graphql;
}

安装和配置Swool

要在本地运行GraphQL Application Server，请安装Swoole扩展（v5.0或更高版本）。 有多种方法可以安装此扩展。

以下过程介绍如何在基于OSX的系统上安装PHP 8.2的Swoole扩展。 这是安装Swoole扩展的多个方法之一。

pecl install swoole

在安装期间，Adobe Commerce显示提示以启用对openssl、mysqlnd、sockets、http2和postgres的支持。 为除postgres之外的所有选项输入yes。

验证Swool安装

确认已成功启用该扩展：

php -m | grep swoole

Swoole安装的常见错误

在Swoole安装过程中发生的任何错误通常发生在pecl安装阶段。 典型错误包括缺少openssl.h和pcre2.h文件。 要解决这些错误，请确保在本地系统中安装了这两个软件包。

openssl version -d

此命令显示安装openssl的路径。

pcre2-config --prefix

如果命令输出指示缺少文件，请使用Homebrew安装缺少的包：

brew install openssl

brew install pcre2

解决openssl的问题

若要解决与openssl相关的问题，请运行：

export LDFLAGS="-L/opt/homebrew/etc/openssl@3/lib" export CPPFLAGS="-I/opt/homebrew/etc/openssl@3/include"

确认您使用的是本地dev环境中的路径。

确认解决与openssl相关的问题

您可以再次运行以下命令以检查是否已解决与openssl相关的问题：

pecl install swoole

解决pcre2.h中的问题

要解决与pcre2.h相关的问题，请将pcre2.h路径符号链接到已安装的PHP扩展目录。 您安装的PHP和pcr2.h的特定版本决定了应使用的命令的特定版本。

运行GraphQL应用程序服务器

启动GraphQL Application Server：

bin/magento server:run

此命令在9501上启动HTTP端口。 GraphQL应用程序服务器启动后，端口9501就会成为所有GraphQL查询的HTTP代理服务器。

要确认GraphQL应用程序服务器正在您的部署中运行，请执行以下操作：

ps aux | grep php

确认GraphQL Application Server正在运行的其他方法包括：

确认正在处理GraphQL请求

GraphQL Application Server将值为graphql_server的X-Backend响应标头添加到其处理的每个请求中。 要检查GraphQL Application Server是否已处理请求，请检查此响应标头。

确认扩展和自定义兼容性

扩展开发人员和商户应首先验证其扩展和自定义代码是否符合​ 技术准则 ​中所述的准则。

在代码评估过程中请考虑以下准则：

禁用GraphQL应用程序服务器

禁用GraphQL Application Server的过程因服务器是在内部部署还是云部署中运行而异。

禁用GraphQL应用程序服务器（云）

禁用GraphQL Application Server（本地）

这种禁用GraphQL Application Server的方法对于快速测试或比较性能很有用。

确认已禁用GraphQL应用程序服务器

要确认php-fpm正在处理GraphQL请求而不是GraphQL应用程序服务器，请输入以下命令： ps aux | grep php。

禁用GraphQL应用程序服务器后：

GraphQL应用程序服务器的集成和功能测试

扩展开发人员可以运行两个集成测试来验证与GraphQL Application Server的扩展兼容性： GraphQlStateTest和ResetAfterRequestTest。

GraphQlStateTest

GraphQlStateTest检测不应为多个请求重复使用的共享对象中的状态。

此测试旨在检测ObjectManager生成的服务对象中的状态更改。 该测试执行两次相同的GraphQL查询，并比较第二次查询之前和之后的服务对象状态。

GraphQlStateTest失败和可能的修复

通过执行vendor/bin/phpunit -c $(pwd)/dev/tests/integration/phpunit.xml dev/tests/integration/testsuite/Magento/GraphQl/App/GraphQlStateTest.php运行GraphQlStateTest。

ResetAfterRequestTest

ResetAfterRequestTest将查找实现ResetAfterRequestInterface的所有类，并验证_resetState()方法是否将对象的状态返回到ObjectManager构造后它保持的状态。  此测试创建具有ObjectManager的服务对象，然后克隆该对象，调用_resetState()，然后比较两个对象。 该测试未在对象实例化和_resetState()之间调用任何方法，因此它不会确认重置任何可变状态。 它确实发现了_resetState()中的错误或拼写错误可能会将状态设置为与它原来的状态不同的问题。

ResetAfterRequestTest失败和可能的修正

功能测试

在部署GraphQL Application Server时，扩展开发人员应该执行GraphQL的WebAPI功能测试和任何自定义的自动或手动功能测试。 这些功能测试可帮助开发人员识别潜在的错误或兼容性问题。

状态监视器模式

在运行功能测试（或手动测试）时，GraphQL Application Server可以在启用--state-monitor mode的情况下运行，以帮助查找状态被无意重复使用的类。 正常启动应用程序服务器，但添加--state-monitor参数除外。

bin/magento server:run --state-monitor

在处理每个请求后，都会向tmp目录中添加一个新文件，例如： var/tmp/StateMonitor-thread-output-50-6nmxiK。 完成测试后，这些文件可以与bin/magento server:state-monitor:aggregate-output命令合并，这将创建两个合并的文件，一个在XML，一个在JSON。

示例：

/var/workspace/var/tmp/StateMonitor-json-2024-04-10T18:50:39Z-hW0ucN.json
/var/workspace/var/tmp/StateMonitor-junit-2024-04-10T18:50:39Z-oreUco.xml

可以使用用于查看XML或JSON的任何工具来检查这些文件，这些工具显示GraphQlStateTest等服务对象的修改属性。 --state-monitor模式使用与GraphQlStateTest相同的跳过列表和筛选器列表。