【.NET Core 3.0】開発者必見！DatabaseDeveloperPageExceptionFilter を活用したデータベース エラー処理

.NET Core 3.0における「No UseDatabaseErrorPage() 拡張メソッド」問題と解決策

.NET Core 3.0 で ASP.NET Core アプリケーションを開発していると、UseDatabaseErrorPage() 拡張メソッドを使用しようとすると、次のようなエラーが発生することがあります。

The type or namespace 'DataException' could not be found.

これは、DatabaseErrorPageMiddleware とそれに関連する拡張メソッドが 非推奨 になったことが原因です。

影響を受けるもの

この問題は、以下の状況で発生します。

• Startup クラスで UseDatabaseErrorPage() 拡張メソッドを呼び出している場合
• ASP.NET Core 3.0 で Entity Framework Core を使用している場合

解決策

この問題を解決するには、以下のいずれかの方法を実行する必要があります。

DatabaseDeveloperPageExceptionFilter を使用する

Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore NuGet パッケージをプロジェクトに追加し、DatabaseDeveloperPageExceptionFilter をサービス コレクションに追加します。

public void ConfigureServices(IServiceCollection services)
{
    services.AddDatabaseDeveloperPageExceptionFilter();
}

次に、UseDeveloperExceptionPage() 拡張メソッドを使用して開発者例外ページを有効にします。

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
}

カスタム エラー ページを実装する

非推奨になった理由

DatabaseErrorPageMiddleware が非推奨になった理由は、以下のとおりです。

• 拡張可能 API は、より柔軟でカスタマイズしやすい
• 開発者例外ページの拡張可能 API に置き換えられた

上記以外にも、問題解決に役立つ情報がいくつかあります。

• 具体的なエラー メッセージ
• 使用している ASP.NET Core のバージョン
• 使用している Entity Framework Core のバージョン

Startup.cs

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllersWithViews();

    services.AddDbContext<ApplicationDbContext>(options =>
        options.UseSqlServer(connectionString));

    services.AddDatabaseDeveloperPageExceptionFilter();
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseRouting();

    app.UseAuthorization();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}

この例では、カスタム エラー ページを実装して、データベース エラーを処理する方法を示します。

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllersWithViews();

    services.AddDbContext<ApplicationDbContext>(options =>
        options.UseSqlServer(connectionString));
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseRouting();

    app.UseAuthorization();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();

        endpoints.MapFallback(context =>
        {
            if (context.Response.StatusCode == 500)
            {
                // カスタム エラー ページを表示
                return context.StatusCode(500, "Database Error");
            }

            return context.StatusCode(context.Response.StatusCode);
        });
    });
}

Views/Shared/Error.cshtml

@model Exception

@{
    ViewData["Title"] = "Error";
}

<h1>An error occurred.</h1>

<div>
    @Model.Message
</div>

<div>
    @Model.StackTrace
</div>

この例では、単純なカスタム エラー ページを実装しています。実際のアプリケーションでは、より詳細な情報を表示したり、ログを記録したりする必要があります。

• 詳細については、ASP.NET Core のドキュメントを参照してください。
• 上記のコードはあくまで例であり、状況に応じて変更する必要があります。

グローバル エラー ハンドラーを使用する

ASP.NET Core MVC には、グローバル エラー ハンドラーを使用する機能があります。グローバル エラー ハンドラーは、アプリケーションで発生したすべての例外を処理します。データベース エラーが発生した場合は、グローバル エラー ハンドラーを使用して、カスタム エラー ページを表示したり、ログを記録したりすることができます。

Sentry などのサードパーティ製のエラー報告ツールを使用する

Sentry などのサードパーティ製のエラー報告ツールを使用すると、データベース エラーを含むすべての例外を簡単に追跡および管理できます。これらのツールは、エラーの根本原因を特定し、問題を迅速に解決するのに役立ちます。

それぞれの方法の比較

最適な方法を選択

使用する方法は、ニーズと要件によって異なります。

• 詳細なエラー追跡と管理機能が必要な場合は、サードパーティ製のエラー報告ツールを使用するのが良いでしょう。
• 特定のタイプのエラーを処理する必要がある場合は、IExceptionFilter の実装を検討してください。
• シンプルで使いやすいソリューションが必要な場合は、グローバル エラー ハンドラーを使用するのが良いでしょう。