.NET Core Web API如何捕获缺失/空参数并实现日志记录？

出现404的关键原因：

1. 若id是必填路由参数（如[HttpPut("{id}")]），调用者未传入id时，请求根本匹配不到目标Action，直接由框架返回404，不会进入你的方法逻辑，自然无法捕获日志或返回自定义响应。
2. 传入空BakeCookieRecipe对象时，若请求能匹配到Action但仍返回404，大概率是模型绑定失败后框架的默认处理逻辑，或是请求URL/路由定义存在冲突。

1. 处理未传入id的场景 #

方案一：将id设为可选路由参数，在方法内判断 #

修改路由定义，让id成为可选参数，确保无id的请求能进入Action，再在方法内做校验：

[HttpPut("{id?}")]
public IActionResult Update(int? id, [FromBody] BakeCookieRecipe recipe)
{
    if (!id.HasValue)
    {
        _logger.LogWarning("更新请求未传入食谱ID");
        return NotFound("未提供要更新的食谱ID");
    }
    // 后续更新逻辑
}

注意：需确保该路由不会与其他Action的路由冲突。

方案二：用中间件捕获未匹配路由的404请求 #

如果不想修改路由，可自定义中间件，针对你的API端点捕获404请求并处理：

public class NotFoundLoggingMiddleware
{
    private readonly RequestDelegate _next;
    private readonly ILogger<NotFoundLoggingMiddleware> _logger;

    public NotFoundLoggingMiddleware(RequestDelegate next, ILogger<NotFoundLoggingMiddleware> logger)
    {
        _next = next;
        _logger = logger;
    }

    public async Task InvokeAsync(HttpContext context)
    {
        await _next(context);

        // 仅针对你的食谱更新API端点处理404
        if (context.Response.StatusCode == StatusCodes.Status404NotFound && 
            context.Request.Path.StartsWithSegments("/api/recipes")) // 替换为你的实际API路径
        {
            _logger.LogWarning("食谱更新请求未传入ID，导致路由匹配失败");
            context.Response.ContentType = "application/json";
            var customResponse = new { Message = "请提供要更新的食谱ID" };
            await context.Response.WriteAsync(JsonSerializer.Serialize(customResponse));
        }
    }
}

在Program.cs中注册中间件：

app.UseMiddleware<NotFoundLoggingMiddleware>();

2. 处理传入空BakeCookieRecipe对象的场景 #

方案一：自定义模型验证失败响应 #

先给BakeCookieRecipe的属性添加必要的数据注解（如[Required]），再在Program.cs中配置自定义模型验证逻辑：

builder.Services.AddControllers()
    .ConfigureApiBehaviorOptions(options =>
    {
        options.InvalidModelStateResponseFactory = context =>
        {
            var logger = context.HttpContext.RequestServices.GetRequiredService<ILogger<Program>>();
            var errorMessages = context.ModelState.Values.SelectMany(v => v.Errors).Select(e => e.ErrorMessage);
            logger.LogWarning("食谱更新请求数据无效：{Errors}", string.Join("; ", errorMessages));
            
            return new BadRequestObjectResult(new 
            { 
                Message = "传入的食谱数据为空或无效",
                Errors = errorMessages
            });
        };
    });

同时在Action内手动判断对象是否为空：

[HttpPut("{id}")]
public IActionResult Update(int id, [FromBody] BakeCookieRecipe recipe)
{
    if (recipe == null)
    {
        _logger.LogWarning("更新请求未传入任何食谱数据");
        return NotFound("未提供要更新的食谱内容"); // 若需返回NotFound而非BadRequest，可自定义
    }
    
    if (!ModelState.IsValid)
    {
        return ValidationProblem(ModelState);
    }
    // 后续更新逻辑
}

3. 排查路由匹配问题 #

确保Action的路由定义与请求URL完全匹配，示例：

[Route("api/[controller]")]
[ApiController]
public class RecipesController : ControllerBase
{
    [HttpPut("{id}")]
    public IActionResult Update(int id, [FromBody] BakeCookieRecipe recipe)
    {
        // ...
    }
}

正确请求URL应为PUT /api/recipes/123，若调用时使用PUT /api/recipes（不带id），必然返回404，需通过前面的方案处理此类情况。

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