Day30 .NET 6 <ErrorBoundary>

2021 iThome 鐵人賽

DAY 16

自我挑戰組

ASP.NET Core & Blazor系列第 30 篇

13th鐵人賽

StrayaWorker

2021-09-30 22:44:48

1966 瀏覽

分享至

昨天說到單元測試，但有些時候可能由於時程關係沒辦法完整測試，就可能因為某個 Component 出錯導致整個系統崩潰(如下圖)，因為 Blazor Server 是在 Server 建立一個 circuit(流程)，一旦有未處理的錯誤 Server 就會將circuit 終止以避免安全問題。

我們不想每次出錯都終止整個系統，也不想在每個方法都用 try…catch… 包住程式處理所有錯誤，所以要用 .NET 6 Preview 4 新推出的 Component <ErrorBoundary>。

在 React 這個前端框架中同樣有 ErrorBoundary 概念，它會捕捉任何 Component 產生的錯誤並展示預設 UI 畫面，當錯誤發生就會將錯誤限縮到該 Component，其他 Component 則維持功能性。

Blazor 也是借用這個概念，不過 Blaozr 團隊有說明這並不能捕捉所有可能的例外狀況，而且 <ErrorBoundary> 並不是要處理全域錯誤攔截，那是 ILogger 的任務，<ErrorBoundary> 主要目的還是處理渲染或是生命週期方法(OnInitializedAsync、OnParametersSetAsync)產生的錯誤，另外還有許多可能的風險，例如開發者以為 <ErrorBoundary> 可以處理所有錯誤、開發者覺得不需要再針對不同錯誤產生客製化 UI 而導致複數不同錯誤產生時感到困惑、大量同類型 <ErrorBoundary> 同時產生時開發者又剛好針對該錯誤記錄每筆 log 可能導致 log 堵塞…等等，所以不能把這個當成處理錯誤的最後一關。

雖然上面說得有些驚悚，但 <ErrorBoundary> 用來處理簡單的畫面邏輯還是可以的，就來試試看吧！

(註：如果是直接用 Visual Studio 2022 建立專案的人可以省略下面一段的步驟)
因為筆者用的是 Visual Studio 2019，.NET 6 只能以 Visual Studio 2022 執行，所以先去下載 Visual Studio 2022 Preview，接著開啟 BlaozrPractice 方案，將 BlazorServer、BlazorServerMsTest 兩個專案的 <TargetFramework> 都改成 net6.0。

然後記得去 wwwroot/css/site.css 加入下列 class，<ErrorBoundary> 會產生一個帶有 blazor-error-boundary class 的 <div>。

.blazor-error-boundary {
    background: url(data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iNTYiIGhlaWdodD0iNDkiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIG92ZXJmbG93PSJoaWRkZW4iPjxkZWZzPjxjbGlwUGF0aCBpZD0iY2xpcDAiPjxyZWN0IHg9IjIzNSIgeT0iNTEiIHdpZHRoPSI1NiIgaGVpZ2h0PSI0OSIvPjwvY2xpcFBhdGg+PC9kZWZzPjxnIGNsaXAtcGF0aD0idXJsKCNjbGlwMCkiIHRyYW5zZm9ybT0idHJhbnNsYXRlKC0yMzUgLTUxKSI+PHBhdGggZD0iTTI2My41MDYgNTFDMjY0LjcxNyA1MSAyNjUuODEzIDUxLjQ4MzcgMjY2LjYwNiA1Mi4yNjU4TDI2Ny4wNTIgNTIuNzk4NyAyNjcuNTM5IDUzLjYyODMgMjkwLjE4NSA5Mi4xODMxIDI5MC41NDUgOTIuNzk1IDI5MC42NTYgOTIuOTk2QzI5MC44NzcgOTMuNTEzIDI5MSA5NC4wODE1IDI5MSA5NC42NzgyIDI5MSA5Ny4wNjUxIDI4OS4wMzggOTkgMjg2LjYxNyA5OUwyNDAuMzgzIDk5QzIzNy45NjMgOTkgMjM2IDk3LjA2NTEgMjM2IDk0LjY3ODIgMjM2IDk0LjM3OTkgMjM2LjAzMSA5NC4wODg2IDIzNi4wODkgOTMuODA3MkwyMzYuMzM4IDkzLjAxNjIgMjM2Ljg1OCA5Mi4xMzE0IDI1OS40NzMgNTMuNjI5NCAyNTkuOTYxIDUyLjc5ODUgMjYwLjQwNyA1Mi4yNjU4QzI2MS4yIDUxLjQ4MzcgMjYyLjI5NiA1MSAyNjMuNTA2IDUxWk0yNjMuNTg2IDY2LjAxODNDMjYwLjczNyA2Ni4wMTgzIDI1OS4zMTMgNjcuMTI0NSAyNTkuMzEzIDY5LjMzNyAyNTkuMzEzIDY5LjYxMDIgMjU5LjMzMiA2OS44NjA4IDI1OS4zNzEgNzAuMDg4N0wyNjEuNzk1IDg0LjAxNjEgMjY1LjM4IDg0LjAxNjEgMjY3LjgyMSA2OS43NDc1QzI2Ny44NiA2OS43MzA5IDI2Ny44NzkgNjkuNTg3NyAyNjcuODc5IDY5LjMxNzkgMjY3Ljg3OSA2Ny4xMTgyIDI2Ni40NDggNjYuMDE4MyAyNjMuNTg2IDY2LjAxODNaTTI2My41NzYgODYuMDU0N0MyNjEuMDQ5IDg2LjA1NDcgMjU5Ljc4NiA4Ny4zMDA1IDI1OS43ODYgODkuNzkyMSAyNTkuNzg2IDkyLjI4MzcgMjYxLjA0OSA5My41Mjk1IDI2My41NzYgOTMuNTI5NSAyNjYuMTE2IDkzLjUyOTUgMjY3LjM4NyA5Mi4yODM3IDI2Ny4zODcgODkuNzkyMSAyNjcuMzg3IDg3LjMwMDUgMjY2LjExNiA4Ni4wNTQ3IDI2My41NzYgODYuMDU0N1oiIGZpbGw9IiNGRkU1MDAiIGZpbGwtcnVsZT0iZXZlbm9kZCIvPjwvZz48L3N2Zz4=) no-repeat 1rem/1.8rem, #b32121;
    padding: 1rem 1rem 1rem 3.7rem;
    color: white;
}

    .blazor-error-boundary::after {
        content: "An error has occurred."
    }

再去 MainLayout.razor 用 <ErrorBoundary> 將 @Body 包住，最後去 BlogBase.razor.cs 在 loadData() 加入一段程式拋出錯誤。

        private async Task loadData()
        {
            …
            throw new Exception("這是測試錯誤訊息");
        }

開啟網站看看，可以看到這次沒有再看到底下黃色的例外狀況錯誤訊息，而是呈現預設的 UI。

不過不管什麼錯誤都會呈現這樣的訊息，對使用者來說似乎不太友善，我們來用 <ChildContent> 跟 <ErrorContent> 客製化，它們其實就是 RenderFragment，可以放入任何 HTML 標籤或是 Component。

            <ErrorBoundary>
                <ChildContent>
                    @Body
                </ChildContent>
                <ErrorContent>
                    <p>很抱歉，目前出現未知錯誤，請聯絡管理員</p>
                </ErrorContent>
            </ErrorBoundary>

但這時候如果切換到 Roles 或是 Users，會發現那塊紅色錯誤訊息依舊在畫面上，這是因為 <ErrorBoundary> 只要偵測到錯誤就會呈現，此時要呼叫方法 Recover()，這方法可以將錯誤數量重設為 0，並呼叫 StateHasChanged()去通知各個 Component 狀態已經改變了，如此就會將 Component 重新渲染，千萬記得要使用 @ ref 去參考指定的 <ErrorBoundary>，否則 Recover() 是不會執行的。

		…
        <div class="content px-4">
            <ErrorBoundary @ref="errorBoundary">
                <ChildContent>
                    @Body
                </ChildContent>
                <ErrorContent>
                    <p>很抱歉，目前出現未知錯誤，請聯絡管理員</p>
                </ErrorContent>
            </ErrorBoundary>
        </div>
		…

@code {
    private ErrorBoundary errorBoundary;

    protected override void OnParametersSet()
    {
        errorBoundary?.Recover();
    }
}

另外 <ErrorBoundary> 有一個變數 MaximumErrorCount 預設 100，只要 MaximumErrorCount 超過指定數量系統就會崩潰。