[VB.NET,.NET8]DbContextを自動生成する

Entity Framework Core（以下EF Core）は、C#を使ったアプリケーション開発で主に利用されるORM（Object-Relational Mapping）フレームワークです。通常、C#を使ってDbContextやエンティティクラスを自動生成しますが、VB.NETユーザーの方でも同様にDbContextを自動生成することができます。
今回は、EF CoreでVB.NETをサポートするための「EntityFrameworkCore.VisualBasic」ライブラリを活用する方法についてご紹介します。

1. EntityFrameworkCore.VisualBasicとは？

EntityFrameworkCore.VisualBasicは、EF CoreでVB.NETをサポートするための拡張ライブラリです。これを利用することで、VB.NET環境でもC#と同様に、データベースのスキーマからDbContextやエンティティクラスを自動生成できるようになります。

通常、EF Coreではdotnet efコマンドを使用してデータベースからコードを生成しますが、このライブラリをインストールすることで、VB.NETプロジェクトにおいても同じ操作が可能になります。

2. 環境準備

VB.NETプロジェクトでEF Coreを使うためには、いくつかの前提条件を整える必要があります。以下の手順に従って、プロジェクトを準備しましょう。

必要なパッケージのインストール

EF Coreのパッケージをインストール
プロジェクトのパッケージマネージャーコンソール（Tools > NuGet Package Manager > Package Manager Console）で以下のコマンドを実行します。

Install-Package Microsoft.EntityFrameworkCore
Install-Package Microsoft.EntityFrameworkCore.SqlServer # SQL Serverを使う場合
Install-Package Microsoft.EntityFrameworkCore.Tools

EntityFrameworkCore.VisualBasicをインストール
VB.NET用のEF Core拡張ライブラリを追加します。

Install-Package EntityFrameworkCore.VisualBasic

これで、VB.NET環境でEF Coreを利用する準備が整いました。

3. DbContextの自動生成手順

次に、DbContextやエンティティクラスを自動生成する手順を解説します。ここでは、SQL Serverデータベースを使用した例を取り上げます。

1. データベース接続情報の設定

最初に、データベース接続情報をappsettings.jsonに追加します。例えば、以下のようにSQL Serverの接続文字列を設定します。

{
  "ConnectionStrings": {
    "DefaultConnection": "Server=YOUR_SERVER;Database=YOUR_DATABASE;Trusted_Connection=True;"
  }
}

YOUR_SERVERやYOUR_DATABASEの部分は、実際のサーバー名やデータベース名に置き換えてください。

2. DbContextとエンティティの自動生成

パッケージマネージャーコンソールで、Scaffold-DbContextコマンドを使ってデータベースからコードを生成します。

Scaffold-DbContext "Server=YOUR_SERVER;Database=YOUR_DATABASE;Trusted_Connection=True;" Microsoft.EntityFrameworkCore.SqlServer -OutputDir Models -ContextDir Contexts -Context YourDbContextName -Language VB

コマンド解説

• Scaffold-DbContext : EF Coreが提供するコマンドで、データベースからDbContextとエンティティを生成します。
• -OutputDir : 自動生成されるエンティティクラスを保存するディレクトリ（ここではModelsフォルダ）。
• -ContextDir : 自動生成されるDbContextクラスを保存するディレクトリ（ここではContextsフォルダ）。
• -Context : 生成されるDbContextクラスの名前（ここではYourDbContextNameとしています）。
• -Language VB : VB.NET用のコードを生成することを指定します。

コマンドを実行すると、指定したディレクトリにVB.NET形式のDbContextおよびエンティティクラスが自動生成されます。

3. 生成されたコードの確認

自動生成が完了すると、指定したディレクトリにYourDbContextName.vbやエンティティクラスが作成されます。これらのクラスはVB.NETコードで記述されており、EF Coreを使用したデータベース操作がすぐに行えるようになっています。

例えば、以下のようなDbContextクラスが生成されるはずです。

Public Partial Class YourDbContextName
    Inherits DbContext

    Public Sub New()
    End Sub

    Public Sub New(options As DbContextOptions(Of YourDbContextName))
        MyBase.New(options)
    End Sub

    ' 各エンティティをDbSetとして定義
    Public Overridable Property Products As DbSet(Of Product)
    Public Overridable Property Categories As DbSet(Of Category)

    Protected Overrides Sub OnModelCreating(modelBuilder As ModelBuilder)
        MyBase.OnModelCreating(modelBuilder)
    End Sub
End Class

これにより、VB.NETでDbContextやエンティティの管理ができるようになります。

4. 最後に

EntityFrameworkCore.VisualBasicを活用することで、VB.NETプロジェクトでもC#と同じようにEF Coreを利用してデータベースのスキーマからコードを自動生成できるようになります。これにより、VB.NET開発者は、より効率的にデータベース操作を行うことができ、C#に依存せずにORMの恩恵を受けることが可能です。

この記事で紹介した手順を参考に、ぜひあなたのVB.NETプロジェクトでもEF Coreを導入してみてください。