web-dev-qa-db-ja.com

Entity Framework Core：単一のdbコンテキストインスタンスのログクエリ

EF Core（またはそのことについては任意のORM）を使用して、ソフトウェアでの操作中にORMがデータベースに対して行うクエリの数を追跡したいと思います。

私はSQLAlchemyをPython以前に使用しました。そのスタックでは、これは簡単にセットアップできません。通常、シナリオに対して行われたクエリの数、 -メモリSQLiteデータベース。

EF Coreを使用して同じことをしたいので、 ロギングドキュメント を見ました。

私のテストセットアップコードでは、ドキュメントにあるようにしています：

using (var db = new BloggingContext())
{
    var serviceProvider = db.GetInfrastructure<IServiceProvider>();
    var loggerFactory = serviceProvider.GetService<ILoggerFactory>();
    loggerFactory.AddProvider(new MyLoggerProvider());
}

しかし、私は次の結果だと思う問題に遭遇します（ドキュメントからも）：

ロガーを登録する必要があるのは、単一のコンテキストインスタンスのみです。登録すると、同じAppDomain内のコンテキストの他のすべてのインスタンスに使用されます。

テストで見た問題は、ロガーの実装が複数のコンテキストで共有されていることを示しています（これは、私が読んでいるドキュメントに準拠しています）。そして、a）私のテストランナーは並行してテストを実行し、b）私のテストスイート全体が数百のdbコンテキストを作成するため、うまく動作しません。

質問/問題：

  • 私がしたいことは可能ですか？
  • つまりそのdbコンテキストインスタンスにのみ使用されるdbコンテキストでロガーを登録できますか？
  • 私がやろうとしていることを達成する他の方法はありますか？
c#unit-testingloggingentity-framework-corexunit
23
codeape

DbContextOptionsBuilder.UseLoggerFactory(loggerFactory)メソッドを呼び出して、特定のコンテキストインスタンスのすべてのSQL出力を記録します。コンテキストのコンストラクターにロガーファクトリを挿入できます。

以下に使用例を示します。

//this context writes SQL to any logs and to ReSharper test output window
using (var context = new TestContext(_loggerFactory))
{
    var customers = context.Customer.ToList();
}

//this context doesn't
using (var context = new TestContext())
{
    var products = context.Product.ToList();
}

通常、この機能は手動テストに使用します。元のコンテキストクラスをクリーンに保つために、オーバーライドされたOnConfiguringメソッドを使用して、派生したテスト可能なコンテキストを宣言します。

public class TestContext : FooContext
{
    private readonly ILoggerFactory _loggerFactory;

    public TestContext() { }

    public TestContext(ILoggerFactory loggerFactory)
    {
        _loggerFactory = loggerFactory;
    }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        base.OnConfiguring(optionsBuilder);

        optionsBuilder.UseLoggerFactory(_loggerFactory);
    }
}

SQLクエリをログに記録するだけで十分です。コンテキストに渡す前に、適切なロガー（コンソールなど）をloggerFactoryにアタッチすることを忘れないでください。

パートII：ログをxUnit出力とReSharperテスト出力ウィンドウに渡す

テストクラスコンストラクターでloggerFactoryを作成できます。

public class TestContext_SmokeTests : BaseTest
{
    public TestContext_SmokeTests(ITestOutputHelper output)
        : base(output)
    {
        var serviceProvider = new ServiceCollection().AddLogging().BuildServiceProvider();

        _loggerFactory = serviceProvider.GetService<ILoggerFactory>();

        _loggerFactory.AddProvider(new XUnitLoggerProvider(this));
    }

    private readonly ILoggerFactory _loggerFactory;
}

テストクラスはBaseTestから派生し、xUnit出力への書き込みをサポートします。

public interface IWriter
{
    void WriteLine(string str);
}

public class BaseTest : IWriter
{
    public ITestOutputHelper Output { get; }

    public BaseTest(ITestOutputHelper output)
    {
        Output = output;
    }

    public void WriteLine(string str)
    {
        Output.WriteLine(str ?? Environment.NewLine);
    }
}

最も注意が必要な部分は、IWriterをパラメーターとして受け入れるロギングプロバイダーを実装することです。

public class XUnitLoggerProvider : ILoggerProvider
{
    public IWriter Writer { get; private set; }

    public XUnitLoggerProvider(IWriter writer)
    {
        Writer = writer;
    }
    public void Dispose()
    {
    }

    public ILogger CreateLogger(string categoryName)
    {
        return new XUnitLogger(Writer);
    }

    public class XUnitLogger : ILogger
    {
        public IWriter Writer { get; }

        public XUnitLogger(IWriter writer)
        {
            Writer = writer;
            Name = nameof(XUnitLogger);
        }

        public string Name { get; set; }

        public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception,
            Func<TState, Exception, string> formatter)
        {
            if (!this.IsEnabled(logLevel))
                return;

            if (formatter == null)
                throw new ArgumentNullException(nameof(formatter));

            string message = formatter(state, exception);
            if (string.IsNullOrEmpty(message) && exception == null)
                return;

            string line = $"{logLevel}: {this.Name}: {message}";

            Writer.WriteLine(line);

            if (exception != null)
                Writer.WriteLine(exception.ToString());
        }

        public bool IsEnabled(LogLevel logLevel)
        {
            return true;
        }

        public IDisposable BeginScope<TState>(TState state)
        {
            return new XUnitScope();
        }
    }

    public class XUnitScope : IDisposable
    {
        public void Dispose()
        {
        }
    }
}

ここでやった！すべてのSQLログがRider/Resharperテスト出力ウィンドウに表示されます。

30
Ilya Chumakov

これを読む： docs.Microsoft.com/en-us/ef/core/miscellaneous/logging

アプリケーションが各コンテキストインスタンスに対して新しいILoggerFactoryインスタンスを作成しないことが非常に重要です。これを行うと、メモリリークが発生し、パフォーマンスが低下します。1

静的な説明（コンソールなど）にログを記録する場合、Iljaの答えは機能しますが、最初にカスタムバッファーにログを記録する場合、各dbContextが独自のバッファーにログメッセージを収集する場合（およびマルチユーザーサービスで行うこと） 、その後UPSSS-メモリリーク（およびメモリリークは、ほとんど空のモデルあたり約20 mbです）...

EF6が1行でログイベントをサブスクライブする簡単なソリューションを持っているとき、次のようにログを挿入します。

        var messages = new List<string>();
        Action<string> verbose = (text) => {
            messages.Add(text);
        }; // add logging message to buffer

        using (var dbContext = new MyDbContext(BuildOptionsBuilder(connectionString, inMemory), verbose))
        {
             //..
        };

プーリングモンスターを書く必要があります。

追伸誰かがEf Coreアーキテクトに、DIについて間違った理解を持っていると言い、「コンテナ」と呼ばれる洗練されたサービスロケーターとASP.Coreから流用する流UseなUseXXXが「コンストラクターからの卑劣なDI」を置き換えることはできないと言います！通常、少なくともログ関数はコンストラクターを介して注入できる必要があります。

* P.P.S。こちらもお読みください https://github.com/aspnet/EntityFrameworkCore/issues/1042 これは、LoggerFactoryの追加がInMemoryデータプロバイダーへのアクセスを中断したことを意味します。これはそのまま抽象化リークです。 EF Coreにはアーキテクチャに問題があります。

ILoggerFactoryプーリングコード：

public class StatefullLoggerFactoryPool
{
    public static readonly StatefullLoggerFactoryPool Instance = new StatefullLoggerFactoryPool(()=> new StatefullLoggerFactory());
    private readonly Func<StatefullLoggerFactory> construct;
    private readonly ConcurrentBag<StatefullLoggerFactory> bag = new ConcurrentBag<StatefullLoggerFactory>();

    private StatefullLoggerFactoryPool(Func<StatefullLoggerFactory> construct) =>
        this.construct = construct;

    public StatefullLoggerFactory Get(Action<string> verbose, LoggerProviderConfiguration loggerProviderConfiguration)
    {
        if (!bag.TryTake(out StatefullLoggerFactory statefullLoggerFactory))
            statefullLoggerFactory = construct();
        statefullLoggerFactory.LoggerProvider.Set(verbose, loggerProviderConfiguration);
        return statefullLoggerFactory;
    }

    public void Return(StatefullLoggerFactory statefullLoggerFactory)
    {
        statefullLoggerFactory.LoggerProvider.Set(null, null);
        bag.Add(statefullLoggerFactory);
    }
}

 public class StatefullLoggerFactory : LoggerFactory
{
    public readonly StatefullLoggerProvider LoggerProvider;
    internal StatefullLoggerFactory() : this(new StatefullLoggerProvider()){}

    private StatefullLoggerFactory(StatefullLoggerProvider loggerProvider) : base(new[] { loggerProvider }) =>
        LoggerProvider = loggerProvider;
}

public class StatefullLoggerProvider : ILoggerProvider
{
    internal LoggerProviderConfiguration loggerProviderConfiguration;
    internal Action<string> verbose;
    internal StatefullLoggerProvider() {}

    internal void Set(Action<string> verbose, LoggerProviderConfiguration loggerProviderConfiguration)
    {
        this.verbose = verbose;
        this.loggerProviderConfiguration = loggerProviderConfiguration;
    }

    public ILogger CreateLogger(string categoryName) =>
        new Logger(categoryName, this);

    void IDisposable.Dispose(){}
}

public class MyDbContext : DbContext
{
    readonly Action<DbContextOptionsBuilder> buildOptionsBuilder;
    readonly Action<string> verbose;
    public MyDbContext(Action<DbContextOptionsBuilder> buildOptionsBuilder, Action<string> verbose=null): base()
    {
        this.buildOptionsBuilder = buildOptionsBuilder;
        this.verbose = verbose;
    }

     private Action returnLoggerFactory;
    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        if (verbose != null)
        {
            var loggerFactory = StatefullLoggerFactoryPool.Instance.Get(verbose, new LoggerProviderConfiguration { Enabled = true, CommandBuilderOnly = false });
            returnLoggerFactory = () => StatefullLoggerFactoryPool.Instance.Return(loggerFactory);
            optionsBuilder.UseLoggerFactory(loggerFactory);
        }
        buildOptionsBuilder(optionsBuilder);
    }

    // NOTE: not threadsafe way of disposing
    public override void Dispose()
    {
        returnLoggerFactory?.Invoke();
        returnLoggerFactory = null;
        base.Dispose();
    }
}

    private static Action<DbContextOptionsBuilder> BuildOptionsBuilder(string connectionString, bool inMemory)
    {
        return (optionsBuilder) =>
        {
            if (inMemory)
                optionsBuilder.UseInMemoryDatabase(
                  "EfCore_NETFramework_Sandbox"
                );
            else
                //Assembly.GetAssembly(typeof(Program))
                optionsBuilder.UseSqlServer(
                        connectionString,
                        sqlServerDbContextOptionsBuilder => sqlServerDbContextOptionsBuilder.MigrationsAssembly("EfCore.NETFramework.Sandbox")
                        );
        };
    }

class Logger : ILogger
{
    readonly string categoryName;
    readonly StatefullLoggerProvider statefullLoggerProvider;
    public Logger(string categoryName, StatefullLoggerProvider statefullLoggerProvider)
    {
        this.categoryName = categoryName;
        this.statefullLoggerProvider = statefullLoggerProvider;
    }

    public IDisposable BeginScope<TState>(TState state) =>
        null;

    public bool IsEnabled(LogLevel logLevel) =>
        statefullLoggerProvider?.verbose != null;

    static readonly List<string> events = new List<string> {
            "Microsoft.EntityFrameworkCore.Database.Connection.ConnectionClosing",
            "Microsoft.EntityFrameworkCore.Database.Connection.ConnectionClosed",
            "Microsoft.EntityFrameworkCore.Database.Command.DataReaderDisposing",
            "Microsoft.EntityFrameworkCore.Database.Connection.ConnectionOpened",
            "Microsoft.EntityFrameworkCore.Database.Connection.ConnectionOpening",
            "Microsoft.EntityFrameworkCore.Infrastructure.ServiceProviderCreated",
            "Microsoft.EntityFrameworkCore.Infrastructure.ContextInitialized"
        };

    public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter)
    {
        if (statefullLoggerProvider?.verbose != null)
        {
            if (!statefullLoggerProvider.loggerProviderConfiguration.CommandBuilderOnly ||
                (statefullLoggerProvider.loggerProviderConfiguration.CommandBuilderOnly && events.Contains(eventId.Name) ))
            {
                var text = formatter(state, exception);
                statefullLoggerProvider.verbose($"MESSAGE; categoryName={categoryName} eventId={eventId} logLevel={logLevel}" + Environment.NewLine + text);
            }
        }
    }
}
3
Roman Pokrovskij