WebJob与ExceptionFilterAttribute：能否为WebJob实现类Web API的异常捕获机制？

完全可行！WebJobs框架其实提供了和Web API里ExceptionFilterAttribute类似的扩展点，能让你统一捕获处理未处理异常，不用在每个作业方法里重复写try-catch逻辑。下面给你几种实用的实现方案：

1. 全局异常过滤器（最接近Web API的用法） #

WebJobs的Microsoft.Azure.WebJobs.Host.Filters命名空间下有IExceptionFilter接口，你可以自定义实现这个接口，来捕获所有作业执行时的未处理异常。

自定义全局异常过滤器代码： #

using Microsoft.Azure.WebJobs.Host;
using Microsoft.Azure.WebJobs.Host.Filters;
using System;
using System.Threading;
using System.Threading.Tasks;

public class GlobalJobExceptionFilter : IExceptionFilter
{
    public Task OnExceptionAsync(ExceptionContext exceptionContext, CancellationToken cancellationToken)
    {
        // 这里写你的异常处理逻辑：记录日志、发送告警、标记作业状态等
        var failedJobName = exceptionContext.FunctionName;
        var exceptionDetails = exceptionContext.Exception;
        
        Console.WriteLine($"作业 [{failedJobName}] 执行失败: {exceptionDetails.Message}");
        Console.WriteLine($"异常堆栈: {exceptionDetails.StackTrace}");

        // 如果不想让异常继续向上抛出（避免WebJob进程崩溃），设置Handled为true
        exceptionContext.Handled = true;

        return Task.CompletedTask;
    }
}

注册过滤器到WebJob主机： #

在WebJob的启动配置里把这个过滤器注册为单例，就能全局生效：

using Microsoft.Azure.WebJobs;
using Microsoft.Extensions.DependencyInjection;

class Program
{
    static void Main()
    {
        var hostBuilder = new HostBuilder()
            .ConfigureWebJobs(builder =>
            {
                builder.AddAzureStorageCoreServices(); // 根据你的作业类型添加对应服务，比如队列、Blob等
                // 注册全局异常过滤器
                builder.Services.AddSingleton<IExceptionFilter, GlobalJobExceptionFilter>();
            })
            .Build();

        hostBuilder.Run();
    }
}

2. 针对单个作业的局部异常过滤 #

如果你只想给特定的作业方法添加异常捕获，可以用FunctionExceptionFilterAttribute，用法和Web API的特性类一模一样：

自定义局部异常特性： #

using Microsoft.Azure.WebJobs.Host.Filters;
using System.Threading;
using System.Threading.Tasks;

public class SpecificJobExceptionFilterAttribute : FunctionExceptionFilterAttribute
{
    public override Task OnExceptionAsync(FunctionExceptionContext exceptionContext, CancellationToken cancellationToken)
    {
        // 只处理标记了这个特性的作业异常
        Console.WriteLine($"特定作业 [{exceptionContext.FunctionName}] 出错: {exceptionContext.Exception.Message}");
        exceptionContext.Handled = true;
        return Task.CompletedTask;
    }
}

给作业方法标记特性： #

public class MyJobFunctions
{
    // 这个作业的异常会被上面的过滤器捕获
    [SpecificJobExceptionFilter]
    [QueueTrigger("order-processing-queue")]
    public void ProcessOrder(string orderData)
    {
        // 作业业务逻辑，故意抛出异常测试
        throw new InvalidOperationException("订单数据格式错误");
    }
}

3. 主机级别的兜底异常处理 #

除了过滤器，还可以注册AppDomain的未处理异常事件，捕获那些可能绕过过滤器的异常（比如主机初始化阶段的错误）：

var hostBuilder = new HostBuilder()
    .ConfigureWebJobs(builder =>
    {
        builder.AddAzureStorageCoreServices();
        builder.Services.AddSingleton<IExceptionFilter, GlobalJobExceptionFilter>();
    })
    .Build();

// 捕获主机进程层面的未处理异常
AppDomain.CurrentDomain.UnhandledException += (sender, args) =>
{
    var exception = args.ExceptionObject as Exception;
    Console.WriteLine($"WebJob主机未处理致命异常: {exception?.Message}");
    Console.WriteLine($"异常堆栈: {exception?.StackTrace}");
};

hostBuilder.Run();

几个注意点 #

• 对于连续运行的WebJob，设置exceptionContext.Handled = true可以阻止异常导致主机进程崩溃，让其他作业继续运行。
• 对于触发式作业（比如定时触发），未处理的异常可能会触发作业重试，你可以在过滤器里根据异常类型决定是否标记为已处理，或者在host配置里自定义重试策略。
• 一定要结合日志框架（比如Serilog、NLog）记录完整的异常信息，别只打个简单的错误消息，不然排查问题会很头疼。

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