Azure Functions中services.AddMvc().ConfigureApiBehaviorOptions的等效实现方案

Azure Functions的HTTP触发器模型验证逻辑和ASP.NET WebAPI不同，ConfigureApiBehaviorOptions不会生效，需要通过自定义动作过滤器来实现相同的前置验证和自定义错误响应逻辑。

针对Isolated Worker模型（推荐使用） #

步骤1：实现自定义函数调用过滤器 #

创建继承自FunctionInvocationFilterAttribute的过滤器类，在OnActionExecuting方法中检查模型状态并构造自定义错误响应：

using Microsoft.Azure.Functions.Worker;
using Microsoft.Azure.Functions.Worker.Http;
using Microsoft.Azure.Functions.Worker.Filters;
using System.Net;
using System.Text.Json;

public class ModelValidationFilter : FunctionInvocationFilterAttribute
{
    public override void OnActionExecuting(ActionExecutingContext context)
    {
        if (!context.ModelState.IsValid)
        {
            // 构造和WebAPI一致的错误格式
            var errors = context.ModelState
                .Where(kv => kv.Value.Errors.Count > 0)
                .Select(kv => new Error
                {
                    ErrorField = kv.Key,
                    StatusCode = (int)HttpStatusCode.BadRequest,
                    ErrorDescription = kv.Value.Errors.First().ErrorMessage
                })
                .ToList();

            // 创建HTTP响应
            var request = context.GetHttpRequestData();
            var response = request.CreateResponse(HttpStatusCode.BadRequest);
            response.Headers.Add("Content-Type", "application/json");
            response.WriteString(JsonSerializer.Serialize(errors));

            // 设置结果终止后续执行
            context.Result = response;
        }
    }

    // 和你WebAPI中一致的Error类
    public class Error
    {
        public string ErrorField { get; set; }
        public int StatusCode { get; set; }
        public string ErrorDescription { get; set; }
    }
}

步骤2：全局注册过滤器 #

在Program.cs中注册过滤器，让所有HTTP触发器函数自动应用验证逻辑：

var host = new HostBuilder()
    .ConfigureFunctionsWorkerDefaults(builder =>
    {
        // 添加全局过滤器
        builder.AddFilter<ModelValidationFilter>();
    })
    .Build();

host.Run();

针对In-process模型（旧版基于ASP.NET Core） #

如果你使用的是In-process模型（项目引用Microsoft.NET.Sdk.Functions），过滤器实现方式更接近WebAPI：

步骤1：实现ActionFilterAttribute #

using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
using System.Net;

public class ModelValidationFilter : ActionFilterAttribute
{
    public override void OnActionExecuting(ActionExecutingContext context)
    {
        if (!context.ModelState.IsValid)
        {
            var errors = context.ModelState
                .Where(kv => kv.Value.Errors.Count > 0)
                .Select(kv => new Error
                {
                    ErrorField = kv.Key,
                    StatusCode = (int)HttpStatusCode.BadRequest,
                    ErrorDescription = kv.Value.Errors.First().ErrorMessage
                })
                .ToList();

            // 返回BadRequestObjectResult，和WebAPI逻辑一致
            context.Result = new BadRequestObjectResult(errors);
        }
    }

    public class Error
    {
        public string ErrorField { get; set; }
        public int StatusCode { get; set; }
        public string ErrorDescription { get; set; }
    }
}

步骤2：注册过滤器到Mvc管道 #

在Startup.cs的ConfigureServices中添加过滤器：

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvcCore(options =>
    {
        options.Filters.Add<ModelValidationFilter>();
    });
}

应用到单个函数（可选） #

如果不需要全局生效，也可以直接在特定的HTTP触发器函数上添加过滤器特性：

[FunctionName("ValidateUserInput")]
[ModelValidationFilter] // 仅该函数应用验证
public async Task<IActionResult> Run(
    [HttpTrigger(AuthorizationLevel.Function, "post", Route = null)] HttpRequest req,
    ILogger log,
    [FromBody] UserInputModel model)
{
    // 函数体无需再检查ModelState，验证不通过时过滤器已返回错误响应
    // 业务逻辑处理...
    return new OkObjectResult("输入验证通过");
}

这样就能完全复现你在WebAPI中实现的进入函数前自动验证参数并返回自定义错误的逻辑。

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