Strawberry GraphQL字段扩展指南：实现可复用的字段逻辑-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00685/article/details/148527507

Strawberry GraphQL字段扩展指南：实现可复用的字段逻辑

strawberry A GraphQL library for Python that leverages type annotations 🍓 项目地址: https://gitcode.com/gh_mirrors/st/strawberry

什么是字段扩展

在Strawberry GraphQL中，字段扩展(Field Extension)是一种强大的机制，它允许开发者在不直接修改解析器(resolver)的情况下，为字段添加额外的功能逻辑。这种设计模式特别适合实现权限控制、数据转换、缓存等横切关注点(cross-cutting concerns)。

基础使用示例

让我们从一个简单的字符串大写转换扩展开始：

import strawberry
from strawberry.extensions import FieldExtension

class UpperCaseExtension(FieldExtension):
    def resolve(
        self, next_: Callable[..., Any], source: Any, info: strawberry.Info, **kwargs
    ):
        result = next_(source, info, **kwargs)
        return str(result).upper()

@strawberry.type
class Query:
    @strawberry.field(extensions=[UpperCaseExtension()])
    def string(self) -> str:
        return "This is a test!!"

在这个例子中，UpperCaseExtension会拦截字段解析器的返回结果，并将其转换为大写。这种扩展方式不会影响原始解析器的逻辑，保持了代码的整洁性和可维护性。

扩展的实际应用场景

字段扩展在实际开发中有多种应用场景：

数据转换：如上面的例子所示，可以在不修改业务逻辑的情况下对返回数据进行格式化
权限控制：可以在解析器执行前检查用户权限
缓存机制：为字段添加缓存逻辑，减少重复计算
日志记录：记录字段的访问情况和执行时间
数据验证：对输入参数进行预处理和验证

修改字段定义

字段扩展不仅可以修改解析器的行为，还可以修改字段本身的定义。通过重写apply方法，我们可以在模式转换阶段对字段进行修改：

class CachingExtension(FieldExtension):
    def __init__(self, caching_time=100):
        self.caching_time = caching_time
        self.last_cached = 0.0
        self.cached_result = None

    def apply(self, field: StrawberryField) -> None:
        field.directives.append(Cached(time=self.caching_time))

    def resolve(
        self, next_: Callable[..., Any], source: Any, info: strawberry.Info, **kwargs
    ) -> Any:
        current_time = time.time()
        if self.last_cached + self.caching_time > current_time:
            return self.cached_result
        self.cached_result = next_(source, info, **kwargs)
        return self.cached_result

这个缓存扩展不仅实现了缓存逻辑，还在字段上添加了对应的GraphQL指令，使得模式定义更加清晰。

扩展的执行顺序

当多个扩展同时作用于一个字段时，它们的执行顺序非常重要：

@strawberry.field(extensions=[LowerCaseExtension(), UpperCaseExtension()])
def my_field():
    return "My Result"

在这个例子中，执行顺序是：

UpperCaseExtension先执行
然后是LowerCaseExtension
最后是原始解析器

这种"后进先出"的执行顺序确保了扩展链的正确构建。

异步支持

Strawberry的字段扩展全面支持异步操作。对于异步解析器，扩展需要实现resolve_async方法：

class UpperCaseExtension(FieldExtension):
    def resolve(
        self, next: Callable[..., Any], source: Any, info: strawberry.Info, **kwargs
    ):
        result = next(source, info, **kwargs)
        return str(result).upper()

    async def resolve_async(
        self,
        next: Callable[..., Awaitable[Any]],
        source: Any,
        info: strawberry.Info,
        **kwargs
    ):
        result = await next(source, info, **kwargs)
        return str(result).upper()

最佳实践是同时实现同步和异步方法，以获得最佳性能。如果只实现了异步方法，Strawberry会自动使用SyncToAsyncExtension来适配同步解析器，但这会带来一定的性能开销。