EntityFramework Core 用にデバッグロガーを仕込む - EFCore v3 編

EntityFramework Core とは

EntityFramework Core (以下 EFCore) とは、C# などの .NET 言語で使用される、データベースアクセス用途のライブラリだ。

この EFCore を使用して、C# などのプログラムからデータベースなどを読み書きする際は、生の SQL 文文字列を記述することは多くなく、大抵の場合はデータベースの要素にマッピングされるクラスやそのプロパティなどの操作を介して行なう (※開発チームの指針に依るかも知れません)。

とはいえ、アプリケーション実装者が書くコード上から生 SQL 文文字列が消えただけで、最終的にデータベースシステムに送り込まれるのは SQL 文である。  

EFCore がその背後で SQL 文を生成してデータベースシステムとやりとりしてくれる訳だ。

EFCore は、プロジェクトの規模やチューニング要件次第ではあるものの、おそらくは多くの場面で便利に使える定番のライブラリであろう。

EFCore が吐く SQL 文を知りたい

そんな便利な EFCore ではあるが、その EFCore が生成・発行する SQL 文文字列を把握したい状況は往々にしてある。

とくに、少々入り組んだクエリを実装したときに、果たして、ちゃんと効率の良い SQL を EFCore が生成できているか、確認したいときなどだ。

ASP.NET Core による Web アプリサーバー側実装において、EFCore が発行する SQL 文を知る方法については、過去に自分のブログ記事としても書いた。

いっぽうで、ASP.NET Core とかではなく、コンソールアプリなど、任意の形態のプログラムにおいて、EFCore が吐く SQL 文を把握したいケースもあろうかと思う。

そのような場合は、ASP.NET Core 上でのときとは違い、自分でロギング周りを配線してやる必要があるらしい。

ネットで検索してみると、以下のような記事が見つかった。

他にもいくつか類似の記事が見つかるが、いずれも、ロガープロバイダを自分でインスタンス化 (new) して差し込むこととなる。

EFCore の ver.3 では使えない!

ところがである。

EFCore のバージョンが、ver.2.x までは上記記事の方法で目的を達成できるのだが、EFCore ver.3 になると、上記記事の実装ではコンパイルができなくなっていた。

例えば、デバッグ出力に SQL 文を出力するように実装してたコードを、EFCore v3 に昇格すると、以下のコンパイルエラーが発生する。

CS1729: 'DebugLoggerProvider' does not contain
a constructor that takes 1 arguments

このエラーメッセージからも察しが付くと思うが、厳密に言うと、EFCore のバージョンというよりも、EFCore v3 が依存している、ロギング周りのパッケージの v3 が、旧バージョン用の上記実装に対して破壊的変更があったのである。

具体的には、旧バージョンでは、ロガープロバイダ (ConsoleLoggerProvider や DebugLoggerProvider など) のコンストラクタには、ログの分類 (カテゴリ) やレベルに応じた絞り込みを行なうフィルタ関数を、そのコンストラクタ引数に受け取るオーバーロードバージョンが用意されていた。

それが ver.3 以降は、そのようなオーバーロードバージョンのコンストラクタが廃止されたのだ。

(ver.2.x 時代から、すでに Obsolete 属性でマーク、すなわち廃止予定であるとちゃんと示されていたようではある。)

EFCore ver.3 からは LoggerFactory.Create が便利

ではどうするのかというと、LoggerFactory.Create() を使ってロガーを構成するやり方が使えるらしい。

なお、下記公式ドキュメントを見ると、ロガーの構成方法はそれはもう色々ありすぎて習得するのも骨が折れる印象だ。

さておき、詳細は公式ドキュメントに譲るとして、ざっくり下記のようなコードにて、デバッグ出力に EFCore が発行する SQL 文が出力されるようになった。

using Microsoft.EntityFrameworkCore;

using Microsoft.Extensions.Logging;

...

// 以下、LoggerFactory の構築方法が v.2.x 以前と異なる。

var loggerFactory = LoggerFactory.Create(builder =>

{

  builder

    .AddDebug()

    .AddFilter(

      category: DbLoggerCategory.Database.Command.Name,

      level: LogLevel.Information);

});

// ここから以降はこれまでと変わらず、構築した LoggerFactory を差し込むだけ。

var option = new DbContextOptionsBuilder<MyDbContext>()

  ...

  .UseLoggerFactory(loggerFactory)

  .Options;

var dbContext = new MyDbContext(option);

...

まとめ

他にも LoggerFilterOptions オブジェクトを使ってログフィルターを構成するとか、上記実装例にしても、AddFilter() 拡張メソッドには少なくとも 9 種のオーバーロードバージョンがあったりとか、様々なやり方があるようだ。

とりあえず自分が検証した範囲では、上記実装例が、この用途ではいちばんシンプルに書けたので、ここに紹介する次第。

以上、EFCore v3 で、発行される SQL 文をログ出力する方法であった。