.NET HotChocolate泛型分页报错，自定义响应基类如何兼容分页功能？

问题根源 #

• HotChocolate内置的UsePaging特性默认作用于Resolver返回的可迭代集合（IQueryable<T>/IEnumerable<T>），会自动将集合包装为符合GraphQL规范的游标分页结构。你将需要分页的IQueryable<User>封装在自定义ListResponseBase<T>类内部，UsePaging无法自动识别要处理的数据源，所以会先后报「非可迭代类型」「无法拉取数据」的错误。
• 你使用的统一响应包装模式本身没有问题，只是不符合HotChocolate数据中间件的默认处理规则。

解决方案 #

分两种实现路径，可根据业务需求选择：

方案1：适配HotChocolate原生分页规则（推荐） #

保留UsePaging的能力，同时扩展分页结构增加Status字段，适合需要复用HotChocolate内置分页、过滤、排序能力的场景：

1. 定义带Status的自定义分页连接类型

// 继承HotChocolate原生的Connection<T>，扩展Status字段
public class StatusedConnection<T> : Connection<T>
{
    public ResponseStatus Status { get; set; }
}

2. 调整Resolver返回值，直接返回可迭代的数据源，指定自定义分页类型

[GraphQLName("user_getUsers")]
// 指定用自定义的带Status的连接类型做分页
[UsePaging(typeof(StatusedConnection<User>))]
public IQueryable<User> GetUsers([Service] IUserService userService)
{
    // 直接返回要分页的IQueryable<User>即可
    return userService.GetUsers().Result;
}

3. 全局统一设置Status值
   注册全局结果过滤器，自动给所有返回的StatusedConnection对象设置状态，不需要每个接口手动赋值：

public class StatusFillFilter : IResultFilter
{
    public async ValueTask OnResultExecutionAsync(ResultExecutionContext context, ResultExecutionDelegate next)
    {
        await next();
        if (context.Result is StatusedConnection<object> statusedConn)
        {
            // 有报错就设置失败状态，无报错设置成功状态
            statusedConn.Status = context.Errors.Any() ? ResponseStatus.Fail : ResponseStatus.Success;
        }
    }
}

在GraphQL服务配置里注册过滤器：

builder.Services.AddGraphQLServer()
    .AddPaging()
    .AddFiltering()
    .AddSorting()
    .AddResultFilter<StatusFillFilter>();

非分页的普通接口也可以用相同的逻辑，自定义带Status的返回类型，通过全局过滤器统一赋值。

方案2：保留原有ListResponseBase结构，手动实现分页 #

如果不想调整现有响应结构，就弃用HotChocolate内置的UsePaging特性，自己处理分页逻辑：

1. 扩展ListResponseBase，增加分页相关的标准字段

public class ListResponseBase<TResult>
{
    public IReadOnlyCollection<TResult> Nodes { get; set; }
    public PageInfo PageInfo { get; set; }
    public int? TotalCount { get; set; }
    public ResponseStatus Status { get; set; }
    // 不需要分页的接口可以忽略以上三个分页字段，只返回Status和业务数据即可
}

2. 服务层手动处理分页参数

public ListResponseBase<User> GetUsers(int? first, string? after, int? last, string? before)
{
    var allUsers = userRepository.GetUsers();
    // 自行实现游标分页逻辑，处理first/after等分页参数，计算节点列表、分页信息、总条数
    var (nodes, pageInfo, totalCount) = allUsers.ApplyCursorPagination(first, after, last, before);
    return new ListResponseBase<User> 
    { 
        Status = ResponseStatus.Success, 
        Nodes = nodes,
        PageInfo = pageInfo,
        TotalCount = totalCount
    };  
}

Resolver上不需要加UsePaging特性，直接返回ListResponseBase<User>即可。 #

统一返回Status的通用实现 #

所有接口的Status字段都可以通过全局IResultFilter+ 统一响应接口的方式实现，不需要每个接口手动赋值：

1. 定义统一的带Status的接口

public interface IHasStatus
{
    public ResponseStatus Status { get; set; }
}

2. 所有自定义响应类型（包括分页、非分页）都实现这个接口
3. 在全局结果过滤器里统一赋值：

public class GlobalStatusFilter : IResultFilter
{
    public async ValueTask OnResultExecutionAsync(ResultExecutionContext context, ResultExecutionDelegate next)
    {
        await next();
        if (context.Result is IHasStatus hasStatusResult)
        {
            hasStatusResult.Status = context.Errors.Any() ? ResponseStatus.Fail : ResponseStatus.Success;
        }
    }
}

注册后所有实现了IHasStatus的返回类型都会自动被赋值Status，完全不需要业务代码手动处理。

内容的提问来源于stack exchange，提问作者Sadeq Shajari