全域的 Exception 處理

大部分具有 Exception 機制的程式語言都有提供全域的 Exception 處理，如果你已經有用 log 去記錄錯誤的習慣的話，與其在程式裡佈滿了 try catch，不如在全域處裡中去記錄沒有被 catch 的 Exception，這樣程式就可以更乾淨了，而且程式如果發生異常的關閉時也會進入全域處裡，可以確保 Exception 妥善地被記錄。

Console, WinForm 程式

原始碼

1. using System; 
2. using System.Security.Permissions; 
3. using System.Threading; 
4. using System.Windows.Forms; 
5. using NLog; 
6.  
7. namespace AppThreadException 
8. { 
9.    static class Program 
10.    { 
11.        private static readonly ILogger _log = LogManager.GetCurrentClassLogger(); 
12.  
13.  
14.        [STAThread] 
15.        [SecurityPermission(SecurityAction.Demand, Flags = SecurityPermissionFlag.ControlAppDomain)] 
16.        public static void Main(string[] args) 
17.        { 
18.            /* ThreadException 用來攔截 UI 錯誤 */ 
19.            Application.ThreadException += threadExceptionHandler; 
20.  
21.            /* UnhandledException 只能攔截錯誤，不能阻止程式關閉 */ 
22.            Application.SetUnhandledExceptionMode(UnhandledExceptionMode.CatchException); 
23.            AppDomain.CurrentDomain.UnhandledException += unhandledExceptionHandler; 
24.  
25.            Application.Run(new MyForm()); 
26.        } 
27.  
28.  
29.        /// <summary>攔截 UI 錯誤</summary> 
30.        private static void threadExceptionHandler(object sender, ThreadExceptionEventArgs e) 
31.        { 
32.            _log.Fatal(e.Exception, "操作錯誤"); 
33.            MessageBox.Show(e.Exception.Message, "操作錯誤", MessageBoxButtons.OK, MessageBoxIcon.Stop); 
34.        } 
35.  
36.  
37.        /// <summary>攔截不可挽回的錯誤，不能阻止程式關閉</summary> 
38.        private static void unhandledExceptionHandler(object sender, UnhandledExceptionEventArgs e) 
39.        { 
40.            Exception ex = (Exception)e.ExceptionObject; 
41.  
42.            _log.Fatal(ex, "執行錯誤"); 
43.            MessageBox.Show(ex.Message, "執行錯誤", MessageBoxButtons.OK, MessageBoxIcon.Stop); 
44.        } 
45.    } 
46. } 

using System;
using System.Security.Permissions;
using System.Threading;
using System.Windows.Forms;
using NLog;

namespace AppThreadException
{
    static class Program
    {
        private static readonly ILogger _log = LogManager.GetCurrentClassLogger();


        [STAThread]
        [SecurityPermission(SecurityAction.Demand, Flags = SecurityPermissionFlag.ControlAppDomain)]
        public static void Main(string[] args)
        {
            /* ThreadException 用來攔截 UI 錯誤 */
            Application.ThreadException += threadExceptionHandler;

            /* UnhandledException 只能攔截錯誤，不能阻止程式關閉 */
            Application.SetUnhandledExceptionMode(UnhandledExceptionMode.CatchException);
            AppDomain.CurrentDomain.UnhandledException += unhandledExceptionHandler;

            Application.Run(new MyForm());
        }
        

        /// <summary>攔截 UI 錯誤</summary>
        private static void threadExceptionHandler(object sender, ThreadExceptionEventArgs e)
        {
            _log.Fatal(e.Exception, "操作錯誤");
            MessageBox.Show(e.Exception.Message, "操作錯誤", MessageBoxButtons.OK, MessageBoxIcon.Stop);
        }
        

        /// <summary>攔截不可挽回的錯誤，不能阻止程式關閉</summary>
        private static void unhandledExceptionHandler(object sender, UnhandledExceptionEventArgs e)
        {
            Exception ex = (Exception)e.ExceptionObject;

            _log.Fatal(ex, "執行錯誤");
            MessageBox.Show(ex.Message, "執行錯誤", MessageBoxButtons.OK, MessageBoxIcon.Stop);
        }
    }
}

Web 程式

在 Global.asax.cs 中可以設定 Application_Error 就可以攔截未處裡的 Exception，除了用這個方法記錄錯誤，還可以用現有的套件(elmah)幫我們完成。

原始碼

1. using System; 
2. using System.Web.Mvc; 
3. using System.Web.Optimization; 
4. using System.Web.Routing; 
5. using NLog; 
6.  
7. namespace MvcReport 
8. { 
9.    public class MvcApplication : System.Web.HttpApplication 
10.    { 
11.        private static readonly ILogger _log = LogManager.GetCurrentClassLogger(); 
12.  
13.        //... 
14.  
15.        protected void Application_Error(object sender, EventArgs e) 
16.        { 
17.            Exception ex = Server.GetLastError(); 
18.            _log.Fatal(ex, ex.Message); 
19.        } 
20.  
21.        //... 
22.    } 
23. } 

using System;
using System.Web.Mvc;
using System.Web.Optimization;
using System.Web.Routing;
using NLog;

namespace MvcReport
{
    public class MvcApplication : System.Web.HttpApplication
    {
        private static readonly ILogger _log = LogManager.GetCurrentClassLogger();

        //...

        protected void Application_Error(object sender, EventArgs e)
        {
            Exception ex = Server.GetLastError();
            _log.Fatal(ex, ex.Message);
        }

        //...
    }
}

Net core 程式

Net core 的程式都是相同的方式，Web Request 的要另外配置

原始碼

1. using System; 
2. using System.IO; 
3. using System.Threading; 
4. using System.Threading.Tasks; 
5. using Autofac.Extensions.DependencyInjection; 
6. using EverTop.Api; 
7. using Microsoft.AspNetCore.Hosting; 
8. using Microsoft.Extensions.Hosting; 
9. using NLog; 
10.  
11.  
12. namespace MyWebApp 
13. { 
14.    public class Program 
15.    { 
16.        private static readonly ILogger _log = LogManager.GetCurrentClassLogger(); 
17.  
18.  
19.        public static void Main(string[] args) 
20.        { 
21.            /* UnhandledException 只能攔截錯誤，不能阻止程式關閉 */ 
22.            AppDomain.CurrentDomain.UnhandledException += unhandledExceptionHandler; 
23.  
24.            /* 用來攔截 Task 錯誤 */ 
25.            TaskScheduler.UnobservedTaskException += unobservedTaskException; 
26.  
27.            var host = Host.CreateDefaultBuilder(args) 
28.                .UseServiceProviderFactory(new AutofacServiceProviderFactory()) 
29.                .ConfigureWebHostDefaults(webHostBuilder => webHostBuilder 
30.                    .UseStartup<Startup>() 
31.                ) 
32.                .Build(); 
33.  
34.            host.Run(); /* 啟動網站 */ 
35.        } 
36.  
37.  
38.        private static void unhandledExceptionHandler(object sender, UnhandledExceptionEventArgs e) 
39.        { 
40.            Exception ex = (Exception)e.ExceptionObject; 
41.            _log.Fatal(ex, "執行錯誤"); 
42.        } 
43.  
44.        private static void unobservedTaskException(object sender, UnobservedTaskExceptionEventArgs e) 
45.        { 
46.            _log.Fatal(e.Exception, "執行錯誤"); 
47.            e.SetObserved(); 
48.        } 
49.    } 
50. } 

using System;
using System.IO;
using System.Threading;
using System.Threading.Tasks;
using Autofac.Extensions.DependencyInjection;
using EverTop.Api;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Hosting;
using NLog;


namespace MyWebApp
{
    public class Program
    {
        private static readonly ILogger _log = LogManager.GetCurrentClassLogger();


        public static void Main(string[] args)
        {
            /* UnhandledException 只能攔截錯誤，不能阻止程式關閉 */
            AppDomain.CurrentDomain.UnhandledException += unhandledExceptionHandler;

            /* 用來攔截 Task 錯誤 */
            TaskScheduler.UnobservedTaskException += unobservedTaskException;

            var host = Host.CreateDefaultBuilder(args)
                .UseServiceProviderFactory(new AutofacServiceProviderFactory())
                .ConfigureWebHostDefaults(webHostBuilder => webHostBuilder
                    .UseStartup<Startup>()
                )
                .Build();

            host.Run(); /* 啟動網站 */
        }


        private static void unhandledExceptionHandler(object sender, UnhandledExceptionEventArgs e)
        {
            Exception ex = (Exception)e.ExceptionObject;
            _log.Fatal(ex, "執行錯誤");
        }

        private static void unobservedTaskException(object sender, UnobservedTaskExceptionEventArgs e)
        {
            _log.Fatal(e.Exception, "執行錯誤");
            e.SetObserved();
        }
    }
}

Net core 3.1 Web 程式

在 Startup.cs 中配置 middleware 進行 Exception 攔截

原始碼

1. public void Configure(IApplicationBuilder app, IWebHostEnvironment env) 
2. { 
3.    if (_env.IsProduction()) 
4.    { 
5.        app.UseExceptionHandler("/Error"); 
6.    } 
7.    else 
8.    { 
9.        app.UseDeveloperExceptionPage(); 
10.    } 
11.  
12.    app.UseStatusCodePagesWithReExecute("/Error"); 
13.  
14.  
15.    /* 利用 middleware 進行 Exception 攔截 */ 
16.    /* 這裡的順序很重要，不然會被前面 ExceptionHandler 處理掉就拿不到 Exception */ 
17.    app.Use(async (context, next) => 
18.    { 
19.        try 
20.        { 
21.            await next(); 
22.        } 
23.        catch (Exception ex) 
24.        { 
25.            _log.Fatal(ex, "執行錯誤"); 
26.            throw; /* 把 Exception 再丟出去給別人處理 */ 
27.        } 
28.    }); 
29. } 

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (_env.IsProduction())
    {
        app.UseExceptionHandler("/Error");
    }
    else
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseStatusCodePagesWithReExecute("/Error");


    /* 利用 middleware 進行 Exception 攔截 */
    /* 這裡的順序很重要，不然會被前面 ExceptionHandler 處理掉就拿不到 Exception */
    app.Use(async (context, next) =>
    {
        try
        {
            await next();
        }
        catch (Exception ex)
        {
            _log.Fatal(ex, "執行錯誤");
            throw; /* 把 Exception 再丟出去給別人處理 */
        }
    });
}

週期性 Thread 的處裡方式

將主要邏輯寫在另外 method 裡，這樣可以專注在 Exception 上。

原始碼

1. private bool _runFlag = false; 
2.  
3. public void Start() 
4. { 
5.    if (_runFlag) { return; } 
6.    _runFlag = true; 
7.  
8.    var thread = new Thread(() => 
9.    { 
10.        while (_runFlag) 
11.        { 
12.            try 
13.            { 
14.                cycleHandler(); 
15.            } 
16.            catch (Exception ex) 
17.            { 
18.                _log.Fatal(ex, "執行錯誤"); 
19.            } 
20.            Thread.Sleep(1000); 
21.        } 
22.    }); 
23.  
24.    thread.Start(); 
25. } 
26.  
27. public void Stop() 
28. { 
29.    _runFlag = false; 
30. } 
31.  
32. private void cycleHandler() 
33. { 
34.    // 主要的邏輯程式寫在這裡 
35. } 

private bool _runFlag = false;

public void Start()
{
    if (_runFlag) { return; }
    _runFlag = true;

    var thread = new Thread(() =>
    {
        while (_runFlag)
        {
            try
            {
                cycleHandler();
            }
            catch (Exception ex)
            {
                _log.Fatal(ex, "執行錯誤");
            }
            Thread.Sleep(1000);
        }
    });

    thread.Start();
}

public void Stop()
{
    _runFlag = false;
}

private void cycleHandler()
{
    // 主要的邏輯程式寫在這裡
}

PHP 錯誤處理

Ref: set_error_handler, set_exception_handler

原始碼

1. <?php 
2. function error_handler($errno, $errstr, $errfile, $errline) { 
3.    if(error_reporting() === 0){ return; } 
4.    throw new ErrorException($errstr, 0, $errno, $errfile, $errline); 
5. } 
6. set_error_handler('error_handler', E_ALL^E_NOTICE); 
7.  
8.  
9. function exception_handler($exception) { 
10.    // 在這記錄 log 
11.    throw $exception; 
12. } 
13. set_exception_handler('exception_handler'); 
14.  
15.  
16. throw new Exception('Uncaught Exception'); 
17. //$a = 1 / 0; 

<?php
function error_handler($errno, $errstr, $errfile, $errline) {
    if(error_reporting() === 0){ return; }
    throw new ErrorException($errstr, 0, $errno, $errfile, $errline);
}
set_error_handler('error_handler', E_ALL^E_NOTICE);


function exception_handler($exception) {
    // 在這記錄 log
    throw $exception;
}
set_exception_handler('exception_handler');


throw new Exception('Uncaught Exception');
//$a = 1 / 0;