Enterprise-level component library based on Bootstrap and Blazor

star nuget license download repo commit master coverage

Global exception

Added component ErrorLogger Through this component, global logs and exceptions can be output uniformly; currently, the Blazor framework does not provide a MVC like < b>Global exception The overall solution, for the time being, you need to use try/catch in the code block for exception capture

Instructions

1. Add AddLogging to the Startup file to enable the net core system log function

Use AddFileLogger need to reference Longbow.Logging component package
public void ConfigureServices(IServiceCollection services)
{
    services.AddLogging(builder => builder.AddFileLogger());
}

2. Use BlazorLogger to wrap the content, such as: Body in MainLayout

<ErrorLogger>
    @Body
</ErrorLogger>

3. Use cascading parameters in the code to get examples

private void OnClick()
{
    var a = 0;
    _ = 1 / a;
}

4. Console or IIS output visible log information

crit: BootstrapBlazor.Components.BlazorLogger[0]
      TimeStamp: 8/23/2021 12:20:46 PM
      MachineName: ECS-A399
      AppDomainName: BootstrapBlazor.Server
      OS: Microsoft Windows 10.0.17763
      OSArchitecture: X64
      ProcessArchitecture: X64
      Framework: .NET 5.0.9
      UserName: Argo
      EnvironmentName: Development
      IISRootPath: D:\Argo\src\BB\BootstrapBlazor\src\BootstrapBlazor.Server\
      VSIDE: Microsoft Visual Studio Enterprise 2019 16.0
      Exception:: Attempted to divide by zero.
      *********************************************
      System.DivideByZeroException: Attempted to divide by zero.
         at BootstrapBlazor.Shared.Pages.GlobalException.OnClick() in D:\Argo\src\BB\BootstrapBlazor\src\BootstrapBlazor.Shared\Pages\GlobalException.razor.cs:line 30

5. Controls whether error details are displayed

Through the configuration file appsettings.json, which is appsettings.Development.json in the development environment, if not set, it defaults to false and is not displayed. The default behavior is only a pop-up prompt to prevent the exposure of sensitive information
{
    "DetailedErrors": true
}

This function is to obtain the component instance through the cascade parameter and use its function

Demo

In this example code, an error code that divides by zero is written. Because try/catch is used to capture the exception, the error message is displayed in the console below

Set custom exception handling logic by setting OnErrorHandleAsync callback method

Demo
<Layout OnErrorHandleAsync="OnErrorHandleAsync">
    <Main>
        @Body
    </Main>
</Layout>

Attributes

Loading...
@page "/globalexception"
@layout ComponentLayout
@inject IStringLocalizer<GlobalException> Localizer

<h3>Global exception</h3>

Added component <code>ErrorLogger</code> Through this component, global logs and exceptions can be output uniformly; currently, the <code>Blazor</code> framework does not provide a <code>MVC</code> like < b>Global exception</b> The overall solution, for the time being, you need to use <code>try/catch</code> in the code block for exception capture

<h4>Instructions</h4>

<p>1. Add <code>AddLogging</code> to the <code>Startup</code> file to enable the <code>net core</code> system log function</p>

<div class="mb-2">Use <code>AddFileLogger</code> need to reference <b>Longbow.Logging</b> component package</div>

<Pre>public void ConfigureServices(IServiceCollection services)
{
    services.AddLogging(builder => builder.AddFileLogger());
}</Pre>

<p>2. Use <code>BlazorLogger</code> to wrap the content, such as: <code>Body</code> in <code>MainLayout</code></p>

<Pre><ErrorLogger>
    @Body
</ErrorLogger></Pre>

<p>3. Use cascading parameters in the code to get examples</p>

<Pre>private void OnClick()
{
    var a = 0;
    _ = 1 / a;
}</Pre>

<p>4. Console or <b>IIS</b> output visible log information</p>
<Pre>crit: BootstrapBlazor.Components.BlazorLogger[0]
      TimeStamp: 8/23/2021 12:20:46 PM
      MachineName: ECS-A399
      AppDomainName: BootstrapBlazor.Server
      OS: Microsoft Windows 10.0.17763
      OSArchitecture: X64
      ProcessArchitecture: X64
      Framework: .NET 5.0.9
      UserName: Argo
      EnvironmentName: Development
      IISRootPath: D:\Argo\src\BB\BootstrapBlazor\src\BootstrapBlazor.Server\
      VSIDE: Microsoft Visual Studio Enterprise 2019 16.0
      Exception:: Attempted to divide by zero.
      *********************************************
      System.DivideByZeroException: Attempted to divide by zero.
         at BootstrapBlazor.Shared.Pages.GlobalException.OnClick() in D:\Argo\src\BB\BootstrapBlazor\src\BootstrapBlazor.Shared\Pages\GlobalException.razor.cs:line 30</Pre>

<p>5. Controls whether error details are displayed</p>

<div class="mb-2">Through the configuration file <code>appsettings.json</code>, which is <code>appsettings.Development.json</code> in the development environment, if not set, it defaults to <code>false</code> and is not displayed. The default behavior is only a pop-up prompt to prevent the exposure of sensitive information</div>

<Pre>{
    "DetailedErrors": true
}</Pre>

<DemoBlock Title="Test" Introduction="This function is to obtain the component instance through the cascade parameter and use its function" Name="Normal">
    <p>In this example code, an error code that divides by zero is written. Because <code>try/catch</code> is used to capture the exception, the error message is displayed in the console below</p>
    <Button Icon="fa fa-fa" Text="test" OnClick="OnClick" />
</DemoBlock>

<DemoBlock Title="OnErrorHandleAsync" Introduction="Set custom exception handling logic by setting <code>OnErrorHandleAsync </code> callback method" Name="Swal">
    <ErrorLogger OnErrorHandleAsync="OnErrorHandleAsync">
        <Button Icon="fa fa-fa" Text="test" OnClick="OnClick" />
    </ErrorLogger>
</DemoBlock>

<Tips class="mt-3">
    <p>
        Both the <code>Layout</code> component and the <code>Tab</code> component have built-in <code>ErrorLogger</code> components. Please do not add them in the above two components. The following is the simplified example code
    </p>
</Tips>

<Pre><Layout OnErrorHandleAsync="OnErrorHandleAsync">
    <Main>
        @Body
    </Main>
</Layout></Pre>

<AttributeTable Items="@GetAttributes()" />
// Copyright (c) Argo Zhang (argo@163.com). All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
// Website: https://www.blazor.zone or https://argozhang.github.io/

using BootstrapBlazor.Components;
using BootstrapBlazor.Shared.Common;
using BootstrapBlazor.Shared.Components;
using Microsoft.AspNetCore.Components;
using Microsoft.Extensions.Logging;
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Threading.Tasks;

namespace BootstrapBlazor.Shared.Samples;

/// <summary>
/// 
/// </summary>
public partial class GlobalException
{
    [Inject]
    [NotNull]
    private SwalService? SwalService { get; set; }

    private static void OnClick()
    {
        // NET6.0 采用 ErrorLogger 统一处理
        var a = 0;
        _ = 1 / a;
    }

    private Task OnErrorHandleAsync(ILogger logger, Exception ex) => SwalService.Show(new SwalOption()
    {
        Category = SwalCategory.Error,
        Title = "Oops...",
        Content = ex.Message,
        ShowFooter = true,
        FooterTemplate = BootstrapDynamicComponent.CreateComponent<SwalFooter>().Render()
    });

    /// <summary>
    /// 获得属性方法
    /// </summary>
    /// <returns></returns>
    private static IEnumerable<AttributeItem> GetAttributes() => new[]
    {
            // TODO: 移动到数据库中
            new AttributeItem() {
                Name = nameof(ErrorLogger.ChildContent),
                Description = "子组件模板",
                Type = nameof(RenderTemplate),
                ValueList = " — ",
                DefaultValue = " — "
            },
            new AttributeItem() {
                Name = nameof(ErrorLogger.ErrorContent),
                Description = "异常显示模板",
                Type = nameof(RenderTemplate),
                ValueList = " — ",
                DefaultValue = " — "
            },
            new AttributeItem() {
                Name = nameof(ErrorLogger.ShowToast),
                Description = "是否显示错误消息弹窗",
                Type = "bool",
                ValueList = "true|false",
                DefaultValue = "true"
            }
        };
}

B 站相关视频链接

交流群

QQ Group:BootstrapAdmin & Blazor 795206915 675147445 Welcome to join the group discussion
Themes
Bootstrap
Motronic
Ant Design (完善中)
LayUI (完善中)
An error has occurred. This application may no longer respond until reloaded. Reload