GraphQL Calculator 开源项目教程-优快云博客

GraphQL Calculator 开源项目教程

graphql-calculator A lightweight graphql calculation engine, which is used to alter execution behavior of query. 项目地址: https://gitcode.com/gh_mirrors/gr/graphql-calculator

1. 项目介绍

GraphQL Calculator 是一个轻量级的 GraphQL 查询计算引擎，它基于指令（directive）提供 GraphQL 查询字段转换、字段跳过和编排的能力。该项目的名称和语义灵感来源于 Java 的 java.util.stream.Stream，使其易于理解和使用。GraphQL Calculator 支持对字段值进行处理、对列表字段进行过滤、排序和去重、对字段参数进行转换、实现流程控制以及数据编排等功能。

2. 项目快速启动

首先，您需要在项目中添加 GraphQL Calculator 的依赖。

implementation group: 'com.graphql-java-calculator', name: 'graphql-java-calculator', version: {version}

接下来，使用 DefaultGraphQLSourceBuilder 创建一个 GraphQLSource，它包括包装的 GraphQL 架构和 GraphQL 执行引擎。

GraphQLSource graphQLSource = DefaultGraphQLSourceBuilder.newBuilder()
    .schema(schema) // 您的 GraphQL Schema
    .build();

在执行查询前，建议通过 Validator 验证查询，包括 GraphQL 语法验证。您可以实现 CalculatorDocumentCachedProvider 来创建 PreparsedDocumentProvider。

PreparsedDocumentProvider preparsedDocumentProvider = new CalculatorDocumentCachedProvider();

如果使用了自定义的异步 DataFetcher，请确保它实现了 AsyncDataFetcherInterface 接口，并在重写的方法中返回包装的 DataFetcher 和在异步 DataFetcher 中使用的 Executor。

3. 应用案例和最佳实践

以下是一些使用 GraphQL Calculator 的示例：

字段值映射

query basicMapValue($userIds: [Int]) {
    userInfoList(userIds: $userIds) {
        id
        age
        firstName
        lastName
        fullName: stringHolder @map(mapper: "firstName + lastName")
    }
}

过滤用户列表

query filterUserByAge($userId: [Int]) {
    userInfoList(userIds: $userId) @filter(predicate: "age>=18") {
        userId
        age
        firstName
        lastName
    }
}

传递获取的值到另一个字段参数

query passFetchedValueToAnotherFieldArgument($itemIds: [Int]) {
    commodity {
        itemList(itemIds: $itemIds) {
            sellerId @fetchSource(name: "sellerIdList")
            name
            saleAmount
            salePrice
        }
    }
    consumer {
        userInfoList(userIds: 1) @argumentTransform(
            argumentName: "userIds",
            operateType: MAP,
            expression: "sellerIdList",
            dependencySources: ["sellerIdList"]
        ) {
            userId
            name
            age
        }
    }
}