基于.NET 6、PostgreSQL和HotChocolate实现动态JSON GraphQL查询

针对你用.NET 6、PostgreSQL、HotChocolate开发GraphQL服务器，需要动态查询PostgreSQL中存储的SharePoint JSON字段而非返回完整数据的需求，以下是几个实用方案：

方案1：结合PostgreSQL JSON查询与动态字段参数 #

利用PostgreSQL的JSON路径提取能力，让客户端指定需要的字段路径，后端只查询并返回这些字段。

核心代码实现 #

public class Query
{
    [GraphQLName("getSharePointItem")]
    public async Task<dynamic> GetSharePointItem(
        [Service] IDbConnection dbConnection,
        string itemId,
        List<string> requestedFields) // 客户端传入需要的字段，比如["Title", "Author.Name"]
    {
        // 构建PostgreSQL的字段提取语句，将点分隔的路径转为JSON运算符
        var selectClauses = requestedFields.Select(path => 
            $"data#>> '{{{path.Replace(".", ",")}}}' as \"{path}\"");
        
        var sql = $"SELECT {string.Join(", ", selectClauses)} FROM sharepoint_items WHERE id = @ItemId";
        
        return await dbConnection.QueryFirstOrDefaultAsync<dynamic>(sql, new { ItemId = itemId });
    }
}

配置HotChocolate支持动态类型 #

在Program.cs中启用动态对象解析：

builder.Services.AddGraphQLServer()
    .AddQueryType<Query>()
    .AddDynamicObjectType();

方案2：动态生成GraphQL Schema #

如果希望贴合GraphQL的类型系统，而非让客户端传字段路径，可以通过Schema过滤器动态解析JSON结构并生成对应字段。

步骤1：定义动态类型与Schema过滤器 #

public class SharePointItemType : ObjectType<ExpandoObject>
{
    protected override void Configure(IObjectTypeDescriptor<ExpandoObject> descriptor)
    {
        descriptor.Name("SharePointItem");
        // 不预先定义字段，由过滤器动态添加
    }
}

public class DynamicSchemaFilter : ISchemaFilter
{
    private readonly IDbConnection _dbConnection;

    public DynamicSchemaFilter(IDbConnection dbConnection)
    {
        _dbConnection = dbConnection;
    }

    public void Configure(ISchema schema)
    {
        // 从数据库获取一条样本JSON，解析其结构生成字段
        var sampleJson = _dbConnection.QueryFirstOrDefault<string>("SELECT data FROM sharepoint_items LIMIT 1");
        if (string.IsNullOrEmpty(sampleJson)) return;

        var expando = JsonConvert.DeserializeObject<ExpandoObject>(sampleJson);
        var itemType = schema.GetType<SharePointItemType>();

        foreach (var (key, value) in expando)
        {
            // 根据值的类型推断GraphQL字段类型，这里简化为StringType，可扩展为其他类型
            itemType.Field(key).Type<StringType>();
        }
    }
}

步骤2：注册服务与调整查询方法 #

builder.Services.AddGraphQLServer()
    .AddQueryType<Query>()
    .AddType<SharePointItemType>()
    .AddSchemaFilter<DynamicSchemaFilter>();

// 查询方法返回ExpandoObject，自动匹配动态生成的字段
public async Task<ExpandoObject> GetSharePointItem([Service] IDbConnection dbConnection, string itemId)
{
    var sql = "SELECT data FROM sharepoint_items WHERE id = @ItemId";
    var json = await dbConnection.QueryFirstOrDefaultAsync<string>(sql, new { ItemId = itemId });
    return JsonConvert.DeserializeObject<ExpandoObject>(json);
}

方案3：使用HotChocolate的@defer指令（可选） #

如果JSON结构有一定规律但嵌套较深，可以预先定义基础字段，让客户端通过@defer指令按需加载嵌套字段，平衡类型校验和灵活性。

关键注意事项 #

• PostgreSQL的#>>运算符支持用数组形式的路径提取嵌套字段，比如#>> '{Author,Name}'对应Author.Name。
• 动态类型方案会失去GraphQL的强类型校验优势，若需要部分校验，可以结合样本JSON生成静态类型并允许扩展字段。
• 只查询所需字段能大幅提升性能，尤其是当JSON对象体积较大时。

内容的提问来源于stack exchange，提问作者Buddhika Nelum