GraphQL-PHP 中通过 SchemaExtender 定义字段解析器的技术解析

在 GraphQL-PHP 项目中，SchemaExtender 是一个强大的工具，它允许开发者在不修改原始 Schema 的情况下扩展 GraphQL 类型定义。然而，当我们需要为扩展字段添加解析器时，会遇到一些技术挑战。

问题背景

在标准的 GraphQL Schema 构建过程中，我们可以通过 typeConfigDecorator 回调函数为字段添加解析器。但当使用 SchemaExtender 进行扩展时，这些解析器不会被自动应用到新增字段上。这是因为 ASTDefinitionBuilder 在构建字段时不会触发 typeConfigDecorator 回调。

技术细节分析

让我们通过一个代码示例来说明这个问题：

$resolvers = [
   'Query' => [
      'field1' => fn() => 'string',
      'field2' => fn() => 123,
   ]
];

$typeConfigDecorator = function (array $typeConfig, TypeDefinitionNode $typeDefinitionNode) use ($resolvers) {
   if($typeConfig['name'] === 'Query') {
       $fields = $typeConfig['fields'];
       $typeConfig['fields'] = function() use ($fields, $resolvers) {
         $fields = $fields();
         foreach($fields as &$field) {
             $field['resolve'] = $resolvers['Query'][$field['name']];
         }
         return $fields;
      };
   }
   return $typeConfig;
};

当使用 SchemaExtender 扩展 Query 类型添加 field2 时，上述代码中的解析器不会应用到 field2 上。

解决方案

GraphQL-PHP 在 15.15.0 版本中修复了这个问题。现在开发者可以通过以下两种方式为扩展字段添加解析器：

1. 直接字段解析器（推荐方式）：

$typeConfigDecorator = function (array $typeConfig) use ($resolvers) {
    if ($typeConfig['name'] === 'Query') {
        $typeConfig['fields'] = function() use ($typeConfig, $resolvers) {
            $fields = $typeConfig['fields']();
            foreach ($fields as &$field) {
                if (isset($resolvers['Query'][$field['name']])) {
                    $field['resolve'] = $resolvers['Query'][$field['name']];
                }
            }
            return $fields;
        };
    }
    return $typeConfig;
};

2. 对象级解析器（兼容旧版）：

$typeConfigDecorator = function (array $typeConfig) use ($resolvers) {
    if ($typeConfig['name'] === 'Query') {
        $typeConfig['resolveField'] = function($objectValue, $args, $contextValue, ResolveInfo $info) use ($resolvers) {
            return $resolvers['Query'][$info->fieldName]($objectValue, $args, $contextValue, $info);
        };
    }
    return $typeConfig;
};

最佳实践

1. 对于新项目，建议使用第一种方式，它为每个字段单独指定解析器，更加清晰明确
2. 对于需要向后兼容的项目，可以使用第二种方式
3. 确保在 SchemaExtender 调用时传递相同的 typeConfigDecorator
4. 考虑将解析器逻辑封装到独立的服务类中，而不是直接写在闭包里

性能考量

直接字段解析器方式在解析时会有更好的性能表现，因为：

• 减少了每次解析时的条件判断
• 允许 GraphQL 引擎进行更好的优化
• 提供了更精确的错误定位信息

对象级解析器虽然灵活，但在大型 Schema 中可能会引入额外的性能开销。

通过理解这些技术细节，开发者可以更有效地在 GraphQL-PHP 项目中扩展 Schema 并管理字段解析逻辑。