ASP.NET Core应用中Carter模块未注册问题排查

核心问题原因 #

你的Endpoint类是嵌套在GetSheet静态类中的内部类，Carter默认的模块扫描逻辑会排除嵌套类，因此这个模块不会被框架发现，路由自然无法注册，断点也不会触发。

另外，你的GET请求路由中使用[FromBody]绑定参数也是错误的：GET请求默认不会读取请求体，会导致参数绑定失败。

修复步骤 #

1. 将Carter模块改为独立公共类 #

把嵌套的Endpoint类从GetSheet静态类中移出，变成独立的公共类：

using Carter;
using MediatR;
using Microsoft.AspNetCore.Mvc;
using Microsoft.EntityFrameworkCore;
using OneOf;
using MyApp.API.Data;
using MyApp.API.Data.Models;
using MyApp.API.Models;

namespace MyApp.API.Features.Sheets;

public static class GetSheet
{
    public record Command(string SheetId) : IRequest<OneOf<Sheet, NotFound>>;

    public class Handler : IRequestHandler<Command, OneOf<Sheet, NotFound>>
    {
        private readonly ApplicationDbContext context;

        public Handler(ApplicationDbContext context)
        {
            this.context = context;
        }

        public async Task<OneOf<Sheet, NotFound>> Handle(Command request, CancellationToken cancellationToken)
        {
            var sheetCells = await context.SheetCells
                .Where(x => x.SheetId == request.SheetId)
                .ToListAsync(cancellationToken: cancellationToken);

            // 修正：ToListAsync不会返回null，判断是否为空集合即可
            if (!sheetCells.Any())
            {
                return new NotFound();
            }

            var sheet = new Sheet(sheetCells);

            return sheet;
        }
    }
}

// 独立的Carter模块类
public class GetSheetEndpoint : ICarterModule
{
    public void AddRoutes(IEndpointRouteBuilder app)
    {
        app.MapGet("/api/v1/{sheetId:string}", 
            async (string sheetId, IMediator mediator) =>
            {
                var result = await mediator.Send(new GetSheet.Command(sheetId));
                return result.Match(
                    sheet => Results.Ok(sheet), 
                    _ => Results.NotFound());
            });
    }
}

2. 修正GET请求参数绑定 #

移除[FromBody]，直接从路由参数获取sheetId，手动创建Command实例（GET请求不支持从请求体绑定参数）。

3. 可选：确认Carter扫描范围（跨程序集场景） #

如果你的模块类在其他程序集中，需要显式指定扫描程序集：

// Program.cs中修改AddCarter注册
builder.Services.AddCarter(config =>
{
    config.WithAssembly(typeof(GetSheetEndpoint).Assembly);
});

4. 额外修复：查询结果判断逻辑 #

原代码中sheetCells == null永远为假，因为ToListAsync返回空集合而非null，改为判断集合是否为空：!sheetCells.Any()。

验证修复 #

启动应用后，检查Swagger文档是否出现/api/v1/{sheetId:string}的GET路由，调试时模块的AddRoutes方法断点应该会触发，请求该路由也能正常执行逻辑。

内容的提问来源于stack exchange，提问作者Yehor Androsov