Golang库推荐 - 构建GraphQL服务器的GQ库

Golang库推荐 - 构建GraphQL服务器的GQ库 GQ 是一个用于在 Go 中构建 GraphQL 服务端的新库。

当 HouseCanary 开始构建 GraphQL 服务端作为多个现有服务的 API 网关时，我们发现现有的库都没有完全符合我们需求的功能。最大的挑战在于调度对其他服务的批量调用。所有现有项目似乎只支持基于时间的批处理。我们希望能够确定性地在查询执行的合适时间点调度调用，类似于在 Node 中通过在下一个事件循环周期调度批量调用的方式。此外，每个现有库在开发体验的某些方面似乎都存在不足。在创建此项目之前，我们研究了以下库：

gqlgen

采用模式优先的方法。您编写一个模式，然后在配置文件中将类型绑定到该模式，接着使用模式和配置文件生成代码。

缺点 - 需要保持模式定义和结构体同步，需要代码生成。

gophers

采用模式优先的方法。您编写一个模式，然后提供一个根类型绑定到该模式。方法被绑定到模式上。

缺点 - 必须为每个字段编写一个方法，对于大型 DTO 会导致大量样板代码。

graphql-go

在代码中定义模式。您通过构建 Go 对象来构建模式。

缺点 - 非常冗长/样板代码多，没有类型检查。

thunder

从结构体构建模式，具有独立的方法注册。

缺点 - 解析器方法的注册过程冗长。模式定义的灵活性有限。

在研究了这些选项之后，我们着手构建一种结构体优先的开发体验，需要最少的样板代码，利用 GraphQL 模式定义的功能，并允许高效的查询批处理。您可以在 https://github.com/housecanary/gq 查看我们的工作成果，了解该库与现有 Go GraphQL 库的不同之处以及相关文档和示例。

在 HouseCanary，我们正在使用这个库作为主要内部服务的基础。我们期望继续改进和维护这个库。


更多关于Golang库推荐 - 构建GraphQL服务器的GQ库的实战教程也可以访问 https://www.itying.com/category-94-b0.html

1 回复

更多关于Golang库推荐 - 构建GraphQL服务器的GQ库的实战系列教程也可以访问 https://www.itying.com/category-94-b0.html


GQ库确实为Go语言中的GraphQL服务端开发带来了新的思路，特别是在批处理调度方面。以下是一个简单的示例，展示如何使用GQ库构建一个基本的GraphQL服务器，包括类型定义和解析器设置。

首先，确保通过go get github.com/housecanary/gq安装GQ库。然后，创建一个Go文件（例如main.go），定义GraphQL模式和处理查询。

package main

import (
    "context"
    "log"
    "net/http"

    "github.com/housecanary/gq"
    "github.com/housecanary/gq/ast"
)

// 定义用户类型
type User struct {
    ID   string `gq:"id"`
    Name string `gq:"name"`
}

// 定义查询解析器
type Query struct{}

func (q *Query) Users(ctx context.Context) ([]User, error) {
    // 模拟从数据库或其他服务批量获取用户数据
    users := []User{
        {ID: "1", Name: "Alice"},
        {ID: "2", Name: "Bob"},
    }
    return users, nil
}

func main() {
    // 创建GQ schema构建器
    builder := &gq.SchemaBuilder{}
    
    // 注册查询类型
    builder.Query().Type(&Query{})
    
    // 构建schema
    schema, err := builder.Build()
    if err != nil {
        log.Fatal("Failed to build schema:", err)
    }

    // 设置HTTP处理程序
    http.Handle("/graphql", gq.GraphQLHandler(schema))
    
    // 启动服务器
    log.Println("Server running on http://localhost:8080/graphql")
    log.Fatal(http.ListenAndServe(":8080", nil))
}

在这个示例中，我们定义了一个User结构体，并使用gq标签映射到GraphQL字段。Query结构体作为根查询类型，包含一个Users方法，用于解析查询并返回用户列表。GQ库自动处理类型推断和解析器绑定，减少了样板代码。

对于批处理调用，GQ库允许在解析器执行期间调度批量请求。例如，在更复杂的场景中，您可以使用上下文和goroutine来优化数据获取：

func (q *Query) Users(ctx context.Context) ([]User, error) {
    // 使用GQ的批处理特性，在解析时批量调用外部服务
    // 这里可以集成HouseCanary提到的确定性调度逻辑
    userIDs := []string{"1", "2"} // 假设从查询参数获取
    users, err := fetchUsersBatch(ctx, userIDs) // 自定义批量获取函数
    if err != nil {
        return nil, err
    }
    return users, nil
}

// 模拟批量获取用户数据的函数
func fetchUsersBatch(ctx context.Context, ids []string) ([]User, error) {
    // 实现批量调用逻辑，例如使用HTTP请求或数据库查询
    var users []User
    for _, id := range ids {
        users = append(users, User{ID: id, Name: "User " + id})
    }
    return users, nil
}

GQ库通过结构体优先的方法简化了开发，无需代码生成或手动模式同步。要测试这个服务器，运行go run main.go，然后使用GraphQL客户端（如GraphiQL）发送查询到http://localhost:8080/graphql，例如：

query {
  users {
    id
    name
  }
}

这将返回用户列表。GQ库的批处理能力使其在高效处理复杂查询时表现出色，特别适合作为API网关集成多个服务。更多高级用法，请参考GQ库文档。

回到顶部