ElmahCore 项目使用教程

1. 项目介绍

ElmahCore 是一个用于 .NET Standard 和 .NET Core 的错误日志记录库。它源自于 ELMAH（Error Logging Modules and Handlers），但经过优化和改进，使其更适合现代的 .NET Core 应用程序。ElmahCore 提供了强大的错误日志记录功能，支持多种存储方式（如内存、XML文件、SQL数据库、MySQL、PostgreSQL等），并且易于集成到现有的 .NET Core 项目中。

2. 项目快速启动

2.1 安装 ElmahCore

首先，通过 NuGet 包管理器安装 ElmahCore：

dotnet add package elmahcore

2.2 配置 ElmahCore

在 Startup.cs 文件中配置 ElmahCore：

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        // 添加 ElmahCore 服务
        services.AddElmah();
    }

    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }
        else
        {
            app.UseExceptionHandler("/Home/Error");
            app.UseHsts();
        }

        // 使用 ElmahCore
        app.UseElmah();

        app.UseHttpsRedirection();
        app.UseStaticFiles();
        app.UseRouting();

        app.UseAuthorization();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllerRoute(
                name: "default",
                pattern: "{controller=Home}/{action=Index}/{id?}");
        });
    }
}

2.3 访问 ElmahCore 错误日志页面

配置完成后，启动应用程序并在浏览器中访问 http://<your-app-url>/elmah，即可查看错误日志页面。

3. 应用案例和最佳实践

3.1 自定义错误日志存储

ElmahCore 支持多种错误日志存储方式，例如将错误日志存储在 XML 文件中：

services.AddElmah<XmlFileErrorLog>(options =>
{
    options.LogPath = "~/logs"; // 指定日志存储路径
});

3.2 限制访问权限

可以通过配置 OnPermissionCheck 来限制对 ElmahCore 错误日志页面的访问：

services.AddElmah(options =>
{
    options.OnPermissionCheck = context => context.User.Identity.IsAuthenticated;
});

3.3 使用 ElmahCore 记录请求体

从版本 2.0.5 开始，ElmahCore 支持记录请求体：

services.AddElmah(options =>
{
    options.LogRequestBody = true;
});

4. 典型生态项目

4.1 ElmahCore.Mvc

ElmahCore.Mvc 是 ElmahCore 的一个扩展，专门为 ASP.NET Core MVC 应用程序设计。它提供了更丰富的错误日志记录功能，并且与 MVC 框架无缝集成。

4.2 ElmahCore.Sql

ElmahCore.Sql 是 ElmahCore 的一个扩展，用于将错误日志存储在 SQL Server 数据库中。它提供了高效的错误日志存储和查询功能。

4.3 ElmahCore.Postgresql

ElmahCore.Postgresql 是 ElmahCore 的一个扩展，用于将错误日志存储在 PostgreSQL 数据库中。它适用于需要使用 PostgreSQL 作为数据库的应用程序。

通过这些扩展，ElmahCore 可以满足不同应用场景下的错误日志记录需求。