DrylocにDbContextを設定したい。

Question

前提・実現したいこと

DrylocにDbContextを設定したいです、ASP.NET Core MVCはデフォルトのコンテナを利用しましたが、
WPFアプリ(.NET 5)の場合はなかったので、Drylocを使用したいですが、ネットで調べてもやり方がわかりませんでした。

// App.xaml.cs

protected override void RegisterTypes(IContainerRegistry containerRegistry) {
    // appsettings.jsonから接続文字列を取得
    IConfiguration configuration = new ConfigurationBuilder()
        .SetBasePath(Directory.GetCurrentDirectory())
        .AddJsonFile(path: "appsettings.json", optional: true, reloadOnChange: true)
        .Build();

    string connectionString = configuration.GetConnectionString("DbConnection");

    // コンテナのインスタンスを取得する(Dryloc)
    IContainer container = containerRegistry.GetContainer();

    // TestDbContext ※Drylocの場合のやり方がわからない。
    // container.Register<TestDbContext>(ifAlreadyRegistered: IfAlreadyRegistered.AppendNotKeyed);

    /*
    ASP.NET Core MVC(.NET 5)の場合
    services.AddDbContext<TestDbContext>(options => {
        options.UseLazyLoadingProxies();
        options.UseSqlServer(Configuration.GetConnectionString("DbConnection"))
    };
     */ 
}

public class TestDbContext : DbContext {
    public TestDbContext(DbContextOptions<AddDbContext> options) : base(options) {
        
    }
}

(追記)
Microsoft.Extensions.DependencyInjectionにてDbContextを使用する場合。

//　Microsoft.Extensions.DependencyInjection の場合
IConfiguration configuration = new ConfigurationBuilder()
    .SetBasePath(Directory.GetCurrentDirectory())   
    .AddJsonFile(path: "appsettings.json", optional: true, reloadOnChange: true)
    .Build();

IServiceCollection services = new ServiceCollection();
services.AddDbContext<TestDbContext>(options => {
    options.UseLazyLoadingProxies();
    options.UseSqlServer(configuration.GetConnectionString("DbConnection"));
});

ただし、WPFで使用しているPrismフレームワークがDrylocを使用していて、上記のMicrosoft.Extensions.DependencyInjectionが使えないため、Dryloc(またはUnity)が使えればよいのですが。

どなたかご教授お願いします。

(追記　修正)　※元のコードは間違いのため削除しました。
BluOxyさんの回答を元に実際のコードを記載しました。

// ITestDbContext

using Microsoft.EntityFrameworkCore;
using System.Threading;
using System.Threading.Tasks;

namespace DomainModel {
    public interface ITestDbContext {
        // インターフェースのプロパティ・メソッドを使うわけではなさそうなので、
        // DbContextに追加したメソッドは全て定義しなければいけないのかは不明

        // public Task<int> SaveChangesAsync(CancellationToken cancellationToken = new CancellationToken());

        // DbSet<Department> Departments { get; set; }
    }
}

// TestDbContext

using Microsoft.EntityFrameworkCore;
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Diagnostics;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;

namespace DomainModel {
    public class TestDbContext : DbContext, ITestDbContext {

        public TestDbContext(DbContextOptions<TestDbContext> options) : base(options) {
            
        }

        public async override Task<int> SaveChangesAsync(CancellationToken cancellationToken = new CancellationToken()) {
            // ...
        }

        /// <summary>
        /// Override OnModelCreating
        /// </summary>
        /// <param name="modelBuilder"></param>
        protected override void OnModelCreating(ModelBuilder modelBuilder) {
            // ...

            base.OnModelCreating(modelBuilder);
        }

        protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder) {
            string connectionString = "Data Source=...";
            
            optionsBuilder.UseSqlServer(connectionString);
            optionsBuilder.UseLazyLoadingProxies();

            base.OnConfiguring(optionsBuilder);
        }

        // Test用の適当なクラス
        public DbSet<Department> Departments { get; set; }
    }
}

// App.xaml

using DomainModel;
using DryIoc;
using Microsoft.Extensions.Configuration;
using Prism.DryIoc;
using Prism.Ioc;
using System.IO;
using System.Windows;
using UserInterface.Views;

namespace UserInterface {
    /// <summary>
    /// Interaction logic for App.xaml
    /// </summary>
    public partial class App {
        protected override Window CreateShell() {
            return Container.Resolve<MainWindow>();
        }

        protected override void RegisterTypes(IContainerRegistry containerRegistry) {
            // appsettings.jsonはDbContextのDomainModelレイヤーに用意して読み込ませるかも
            // (または依存関係が逆転しない他の方法)
            // IConfiguration configuration = new ConfigurationBuilder()
            //     .SetBasePath(Directory.GetCurrentDirectory())
            //     .AddJsonFile(path: "appsettings.json", optional: true, reloadOnChange: true)
            //     .Build();

            // Drylocを利用する場合
            var container = containerRegistry.GetContainer();
            container.Register<ITestDbContext, TestDbContext>();
        }
    }
}

appsettings.jsonはDbContextのDomainModelレイヤーに用意して読み込ませることを検討しようと思います。
(または依存関係が逆転しない他の方法)

DbContextインターフェースには、DbContextに追加したメソッドは全て定義しなければいけないのかはまだ不明ですが。

また、下記のPMのコマンドが使えなくなってしまいました。プロジェクト(レイヤー)の指定は間違っていないのですが。
※標準のDI(Microsoft.Extensions.DependencyInjectionの時)に使えていたPMコマンドではありますが。

PM > Add-Migration init -Context TestDbContext -o "Migrations/TestDb"
PM > Update-Database -Context TestDbContext

エラー内容

Build started...
Build succeeded.
Unable to create an object of type 'TestDbContext'. For the different patterns supported at design time, see https://go.microsoft.com/fwlink/?linkid=851728

(追記)PMコマンドでエラーしたので、デフォルトの引数無しコンストラクタを追加して対処しました。
PMコマンドが実行できるようになりました。

// TestDbContext

using Microsoft.EntityFrameworkCore;
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Diagnostics;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;

namespace DomainModel {
    public class TestDbContext : DbContext, ITestDbContext {

        public TestDbContext() {

        }

        public TestDbContext(DbContextOptions<TestDbContext> options) : base(options) {
            
        }

        public async override Task<int> SaveChangesAsync(CancellationToken cancellationToken = new CancellationToken()) {
            // ...
        }

        /// <summary>
        /// Override OnModelCreating
        /// </summary>
        /// <param name="modelBuilder"></param>
        protected override void OnModelCreating(ModelBuilder modelBuilder) {
            // ...

            base.OnModelCreating(modelBuilder);
        }

        protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder) {
            string connectionString = "Data Source=...";
            
            optionsBuilder.UseSqlServer(connectionString);
            optionsBuilder.UseLazyLoadingProxies();

            base.OnConfiguring(optionsBuilder);
        }

        public DbSet<Department> Departments { get; set; }
    }
}

Comments

[退会済みユーザー]

このスレッドの課題（WPF アプリに DI 機能の実装）は下の回答で解決できたと理解していますが、そうであればこのスレッドはクローズ願います。

[退会済みユーザー]

DIがDrylocでDbContextを利用することが、質問の目的です。
WPFで使用しているPrismフレームワークがDrylocを使用していて、Microsoft.Extensions.DependencyInjectionは使えないようです。

MSのDIは選択肢としては良いと思いますが、どう進めるか考えてます。

[退会済みユーザー]

> DIがDrylocでDbContextを利用することが、質問の目的です。

了解しました・・・が、それが条件で代案は不要であれば最初の質問にその旨書き添えておいていただけたらと思います。自分も回答に余計な時間を使わずスルーできていたので。

[退会済みユーザー]

いえ。DIの貴重なご意見ありがとうございます。もう少しだけ質問をオープンにさせてください。

[退会済みユーザー]

「もう少しだけ質問をオープン」ということですがもう十分では？　放置しておかないで、自分で回答欄に何か書いてクローズできませんか。

[退会済みユーザー]

回答をクローズさせていただきました。

[退会済みユーザー]

回答を再オープンさせていただきました。

Answer 1

下記リンクは今回の要件に沿うのではないでしょうか。DbContext を DI するには DbContext のインタフェースを定義する必要があります。

[C#][WPF][EF]Entity Framework で DB にアクセスする際コンテキストのオブジェクトが自動的に注入されるよう DI 機能を WPF アプリに実装したい

---

サービス層のプロジェクトにappsettings.jsonを置くのはどうかなと思い、悩み中です。

外からオブジェクトをもらっていきましょう。

public class TestDbContext : DbContext {
    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder) {
        optionsBuilder.UseSqlServer("Data Source=tests.db");
        base.OnConfiguring(optionsBuilder);
    }
}

// App.xaml

using DomainService;
using DryIoc;
using Prism.DryIoc;
using Prism.Ioc;
using System.Windows;
using UserInterface.Views;

namespace UserInterface {
    /// <summary>
    /// Interaction logic for App.xaml
    /// </summary>
    public partial class App {
        protected override Window CreateShell() {
            return Container.Resolve<MainWindow>();
        }

        protected override void RegisterTypes(IContainerRegistry containerRegistry) {
            // Drylocを利用する場合
            var container = containerRegistry.GetContainer();
            container.Register<IDbContextService, DbContextService>(ifAlreadyRegistered: IfAlreadyRegistered.AppendNotKeyed);
            container.Register<ITestDbContext, TestDbContext>();
        }
    }
}

// DbContextService

using DomainModel;
using Microsoft.EntityFrameworkCore;

namespace DomainService {

    public class DbContextService : IDbContextService {
        private readonly ITestDbContext _context;
        public DbContextService(ITestDbContext context) {
            this._context = context;
        }
    }
}

Comments

[退会済みユーザー]

教えて頂いたリンクでできそうな感じです。ありがとうございます。

DbContextを隠蔽したServiceクラスとインタフェースを用意して、そのServiceクラスとインタフェースをDIするとできるようです。

一度試してみます。

[退会済みユーザー]

教えて頂いた方法で実行することができました。ありがとうございます。

質問欄の下の方に、実行できたソースを追記させていただきました。

設定ファイルのappsettings.jsonから接続文字列を読込したかったのですが、

レイヤー単位でプロジェクトを分けているため
サービス層のプロジェクトにappsettings.jsonを置くのはどうかなと思い、悩み中です。

[BluOxy]

TestDbContext のインターフェースを作ってそれを Service クラスに DI すれば良いと思います。
追記しました。

[退会済みユーザー]

すみません、DbContextを隠蔽したDbContextServiceを作成すると勘違いしていまして、DbContextのインタフェースを作成する必要がありました。

上記に書いていませんでしたDomainModelレイヤーに、ITestDbContextとTestDbContextを準備し、DIしてみたいと思います。
実装後、再投稿させていただきます。

知識不足ですみませんが、外からオブジェクトを持ってくるのが、よく理解できませんでした。

App.xaml.csでappsettings.jsonを読込ませて利用したいのですが、読込まではできるのですが、それをDbContextに利用する方法がわかりませんでした。
ASP.NET Core MVCだと標準でserviceがついてるので、それが利用できるのですが、WPFは自前で準備しなければならないです。

教えていただいたOnConfiguringを使う方法も試してみたいと思います。

[BluOxy]

ServiceでDbContextの実体を作るのではなく、DIコンテナ等などからDbContextの実体を注入してもらうことを外から持ってくると表現しました。

[BluOxy]

TestDbContext.OnConfiguringの中身を下記にしたら駄目でしょうか。
EFCore を使ったことが無いので力になれず申し訳ないですが、その辺りは雰囲気で書いています。

IConfiguration configuration = new ConfigurationBuilder()
.SetBasePath(Directory.GetCurrentDirectory())
.AddJsonFile(path: "appsettings.json", optional: true, reloadOnChange: true)
.Build();
optionsBuilder.UseSqlServer(configuration.GetConnectionString("DbConnection"));
base.OnConfiguring(optionsBuilder);

[退会済みユーザー]

OnConfiguringはnewせずに実行されるのかなと思ってますが、頂いた方法で雰囲気は似てるような感じがします。
ありがとうございます。
WPFの場合は、App.xaml.csに書くより、DbContextのOnConfiguringの方に書いたほうがいいのかな？と思いました。

App.xaml.csに書く方法ももう少し試してみたいですが、難しいかもしれません。

今日は手元に環境がないため、すみませんが、明日朝に実行してみます。

[退会済みユーザー]

昨日質問欄のコードの追記分について、誤りがありましたので訂正させていただきました。
教えて頂いたDbContextインターフェースとOnConfiguringの方法で対応しました。

DbContextインターフェースには、DbContextに追加したメソッドは全て定義しなければいけないのかは
すみませんが理解できていないです。

また、標準のDI(Microsoft.Extensions.DependencyInjectionの時)に
使えていたPMコマンドが使えなくなってしまいました。

PM > Add-Migration init -Context TestDbContext -o "Migrations/TestDb"
PM > Update-Database -Context TestDbContext

Build started...
Build succeeded.
Unable to create an object of type 'TestDbContext'. For the different patterns supported at design time, see https://go.microsoft.com/fwlink/?linkid=851728

のエラーになってしまってます。もしご存じであればご教授お願いしたく。

[BluOxy]

https://stackoverflow.com/questions/55123853/unable-to-create-an-object-of-type-dbcontexts-name-for-the-different-patte

> In Package Manager Console, set your data access layer (if any) as a default project

を試すとどうでしょうか。EF を使っていて同じようなエラーにはまっていたことがありますが、そのときは上記のような対応をした記憶があります

[退会済みユーザー]

教えて頂いた記事を参考にし、TestDbContextにデフォルトのコンストラクタを作成するとエラーがでなくなりました。ありがとうございます。

public TestDbContext() {

}

質問欄へデフォルトのコンストラクタについて追記しました。

Answer 2

ASP.NET Core MVCはデフォルトのコンテナを利用しましたが、WPFアプリ(.NET 5)の場合はなかったので、Drylocを使用したいですが

「WPFアプリ(.NET 5)の場合はなかった」というのは Visual Studio のテンプレートで作ったプロジェクトには実装されてなかったということだと理解していますが、そういう場合は Microsoft.Extensions.DependencyInjection 名前空間にあるクラス類を使って自力で実装できます。

具体例は、コンソールアプリと Windows Forms の場合ですが、以下の記事を見てください。

.NET Core での Dependency Injection
http://surferonwww.info/BlogEngine/post/2021/01/01/dependency-injection-for-dotnet-core-application.aspx

Windows Forms で IHttpClientFactory 利用 (CORE)
http://surferonwww.info/BlogEngine/post/2021/03/12/how-to-use-ihttpclientfactory-in-windows-forms-application.aspx

Comments

[退会済みユーザー]

ご回答ありがとうございます。
.NET Core での Dependency Injectionの記事を読ませて頂きます。

[退会済みユーザー]

Microsoft.Extensions.DependencyInjection 名前空間にあるクラス類を使って自力で実装してみたところ、下記のコードでエラーが表示されなくなりました。実際に動作させて試してみたいと思います。

IConfiguration configuration = new ConfigurationBuilder()
.SetBasePath(Directory.GetCurrentDirectory())
.AddJsonFile(path: "appsettings.json", optional: true, reloadOnChange: true)
.Build();

IServiceCollection services = new ServiceCollection();
services.AddDbContext<TestDbContext>(options => {
options.UseLazyLoadingProxies();
options.UseSqlServer(configuration.GetConnectionString("DbConnection"));
});

[退会済みユーザー]

上記のコードでコンストラクタ注入が確認できました、ありがとうございます。

Microsoft.Extensions.DependencyInjection　は標準のDIなのでこれは良さそうですね。

Answer 3

下記のように対応しました。

//　Microsoft.Extensions.DependencyInjection の場合

using DomainModel;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using System;
using System.Configuration;
using System.IO;
using System.Windows;
using UserInterface.Views;

namespace UserInterface {
    /// <summary>
    /// Interaction logic for App.xaml
    /// </summary>
    public partial class App {

        public IConfiguration Configuration { get; }
        public IServiceCollection services { get; }

        public App() {
            Configuration = new ConfigurationBuilder()
                .SetBasePath(Directory.GetCurrentDirectory())
                .AddJsonFile(path: "appsettings.json", optional: true, reloadOnChange: true)
                .Build();

            services = new ServiceCollection();
        }

        protected override Window CreateShell() {
            return Container.Resolve<MainWindow>();
        }

        protected override void RegisterTypes(IContainerRegistry containerRegistry) {
            //　Microsoft.Extensions.DependencyInjection の場合
            services.AddDbContext<TestDbContext>(options => {
                options.UseLazyLoadingProxies();
                options.UseSqlServer(Configuration.GetConnectionString("DbConnection"));
            });
        }
    }
}

Comments

[BluOxy]

今この質問に気づきました。
私はWPFのDIコンテナにPrism.Unityを使用しています。Prism.DryIocもあるので、Prismを使うという選択肢もあるということをお伝えしておきます。
https://qiita.com/nori0__/items/ba9f4c84fd3818287ad4

[退会済みユーザー]

コメントありがとうございます。
Prism.Unity　か　Prism.DryIocのどちらかと使いたいと考えていました。

教えて頂いたURLの記事がとても参考になります。確認します。

もしよろしければ、PrismのDI(Unityでも大丈夫です。)　の場合で、
DbContextを使う方法をご存じであれば、ご教授お願いしたいです。

自己解決は未解決に戻させて頂きました。