Tomato Note

ちょっとしたことメモ

タグ: EFCore

  • 【EF Core】DbContextから接続文字列を取得する方法とその注意点

    Entity Framework Core（EF Core）は、.NETアプリケーションで広く使われているORM（Object Relational Mapper）です。データベースとのやり取りを簡潔に記述できるだけでなく、LINQを活用した型安全なクエリも実現できる強力なライブラリです。

    EF Coreを使ってアプリケーションを構築していると、開発・テスト中やトラブルシューティングの際に「DbContextから接続文字列を取得したい」という場面に遭遇することがあります。本記事では、その方法と実装例、そして実際に使う上での注意点までを丁寧に解説します。

    なぜDbContextから接続文字列を取得したいのか？

    一般的に、接続文字列は appsettings.json などの設定ファイル、または環境変数で管理されることが推奨されています。特に本番環境では、セキュリティや柔軟性の観点からこのアプローチが基本です。

    しかし、以下のようなケースではDbContextから直接接続文字列を取得したくなることがあります。

    • ログやデバッグで現在の接続先を確認したい
    • 動的に生成されたDbContextの接続先を確認したい
    • テストケースで実際に使われている接続情報を検証したい
    • 外部ライブラリとの連携で、接続文字列を使わなければならない

    では、どのようにDbContextから接続文字列を取得できるのでしょうか？

    DbContextから接続文字列を取得する方法

    EF Coreでは、DbContext.Database.GetDbConnection() メソッドを使用することで、現在のDbContextが使用している DbConnection オブジェクトを取得できます。そして、DbConnection.ConnectionString プロパティを参照することで、接続文字列を取得することが可能です。

    コード例

    以下は、MyDbContext というDbContextクラスから接続文字列を取得する基本的なサンプルコードです：

    using (var context = new MyDbContext())
{
    // DbConnection オブジェクトを取得
    var connection = context.Database.GetDbConnection();
    
    // 接続文字列を取得
    string connectionString = connection.ConnectionString;
    
    Console.WriteLine("接続文字列: " + connectionString);

    // ここで接続文字列を使った処理を追加
}

    このように非常に簡単なコードで接続文字列を取得することができます。とはいえ、実際の運用ではいくつかの注意点も存在します。

    注意点とベストプラクティス

    1. 実際の接続文字列と異なる可能性がある

    DbConnection.ConnectionString で取得した接続文字列は、構成ファイルに定義された元の文字列と異なることがあります。

    これは、以下のような理由によるものです：

    • 接続プールの影響で接続情報が最適化されている
    • 特定のフレームワークやライブラリが接続文字列を書き換えている
    • クエリ文字列内でマスク処理や変換処理が施されている

    そのため、「元の接続文字列そのままが欲しい」という目的には、IConfiguration や DbContextOptions から直接取得した方が確実な場合があります。

    2. 接続文字列の一部情報が取得できない可能性がある

    一部の接続文字列プロバイダ（特にクラウド系のセキュア接続）では、セキュリティの観点から パスワードやアクセストークンなどの機密情報が省略される ことがあります。

    たとえばAzure SQL Databaseなどでは、接続確立後にパスワード部分がマスクされることがあるため、ConnectionString プロパティを確認しても完全な文字列ではない場合があります。

    3. セキュリティリスクに注意

    接続文字列には データベースの認証情報（ユーザー名やパスワード） が含まれていることが多いため、安易に出力・ログ・外部出力するのは非常に危険です。

    具体的には以下のようなリスクが存在します：

    • ログファイルが第三者に流出し、接続情報が漏洩する
    • デバッグ情報が本番環境で有効になっていて意図せず情報を露出する
    • 内部ツールに接続文字列をハードコードしてセキュリティホールになる

    ベストプラクティスとしては、以下のように扱いましょう：

    • 接続文字列をログに出力しない
    • デバッグ用に取得する場合でも本番環境では無効にする
    • 必ず SecureString や暗号化された方法で処理することを検討する

    他の接続文字列取得方法

    前述のように、DbContextから直接取得する以外にも、より安全に接続文字列を取得する方法があります。

    1. IConfigurationから取得する

    appsettings.json や環境変数で設定された接続文字列は、以下のようにして取得可能です：

    var configuration = serviceProvider.GetRequiredService<IConfiguration>();
var connectionString = configuration.GetConnectionString("DefaultConnection");

    こちらの方法であれば、元の定義どおりの接続文字列が取得できますし、管理もしやすくなります。

    2. DbContextOptionsから取得する

    依存性注入（DI）を活用している場合は、DbContextOptions<TContext> 経由で接続文字列を取得できます：

    public class MyService
{
    private readonly MyDbContext _context;

    public MyService(MyDbContext context)
    {
        _context = context;

        var connectionString = _context.Database.GetDbConnection().ConnectionString;
    }
}

    ただし、オプションを直接参照したい場合は、コンストラクタで DbContextOptions<MyDbContext> を受け取ることで、より柔軟に設定へアクセス可能です。

    結論

    DbContext から接続文字列を取得することは、開発やデバッグの場面で役に立ちますが、以下の点をしっかり理解しておく必要があります。

    • 取得できる接続文字列は必ずしも元の構成と一致しない
    • セキュリティ上のリスクが存在するため取り扱いに注意が必要
    • 本番コードには原則として使用せず、設定ファイルや環境変数を使うのが安全

    開発の効率化やトラブルシューティングを行う際には非常に便利な手法ではありますが、セキュリティと再現性の観点からも 「一時的な利用に留める」 のが良いでしょう。

    おわりに

    接続文字列の取り扱いは、アプリケーションのセキュリティや可搬性に直結します。安易なログ出力やハードコーディングを避け、ベストプラクティスに基づいた実装を心がけましょう。

    今後もEF Coreを活用した開発において、安全で拡張性の高い構成を目指していきましょう！

  • [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を導入してみてください。

  • [VB.NET]動的なテーブル名を使用した単体テストの方法

    はじめに

    データベースの値を検証する単体テストを作成する際、テーブル名が動的に決まる場合はEntity Framework Core（EF Core）が使用できません。そのような状況で、どのようにテストコードを書けばよいのでしょうか。本記事では、ADO.NETを使用して動的なテーブル名でデータベースの値をチェックする方法を詳しく解説します。

    ADO.NETを使用したデータベースアクセス

    ADO.NETは、.NET Frameworkに組み込まれたデータアクセス技術で、データベースとの直接的なやり取りが可能です。EF CoreのようなORMを使用しないため、動的なテーブル名にも柔軟に対応できます。

    サンプルコードの解説

    以下に、動的なテーブル名を使用してデータベースの値を検証する単体テストコードを示します。

    Imports System.Data.SqlClient
Imports Microsoft.VisualStudio.TestTools.UnitTesting

<TestClass>
Public Class DatabaseValueTest

    Private ReadOnly connectionString As String = "YourConnectionStringHere"

    <TestMethod>
    Public Sub TestDatabaseValue()
        Dim tableName As String = GetDynamicTableName() ' 動的にテーブル名を取得
        Dim query As String = $"SELECT TOP 1 * FROM [{tableName}] ORDER BY SomeColumn"

        Using connection As New SqlConnection(connectionString)
            Using command As New SqlCommand(query, connection)
                connection.Open()

                Using reader As SqlDataReader = command.ExecuteReader()
                    If reader.Read() Then
                        ' データの検証
                        Dim actualValue As Object = reader("ColumnName")
                        Dim expectedValue As Object = GetExpectedValue()
                        Assert.AreEqual(expectedValue, actualValue)
                    Else
                        Assert.Fail("レコードが存在しません。")
                    End If
                End Using
            End Using
        End Using
    End Sub

    Private Function GetDynamicTableName() As String
        ' テーブル名を動的に取得するロジックを実装
        Return "YourDynamicTableName"
    End Function

    Private Function GetExpectedValue() As Object
        ' 期待される値を取得または計算
        Return "ExpectedValue"
    End Function

End Class

    コードのポイント

    • Imports文：System.Data.SqlClientとMicrosoft.VisualStudio.TestTools.UnitTestingをインポートしています。
    • connectionString：データベースへの接続文字列を指定します。
    • GetDynamicTableNameメソッド：動的にテーブル名を取得します。
    • SQLクエリの作成：SELECT TOP 1 * FROM [{tableName}] ORDER BY SomeColumnで一番上のレコードのみを取得します。今回は、一番上のレコードのみ検証したいため、これを入れています。
    • データの検証：Assert.AreEqualを使用して、実際の値と期待される値を比較します。

    注意点とベストプラクティス

    SQLインジェクションの防止

    テーブル名はパラメータ化できないため、動的に生成する際には入力値を厳密に検証する必要があります。不正なテーブル名が入力されると、SQLインジェクション攻撃のリスクがあります。

    接続文字列の管理

    connectionStringにはデータベースへの正しい接続情報を設定してください。接続文字列は機密情報を含む場合が多いため、ソースコードに直接書き込まず、設定ファイルや環境変数から取得することをおすすめします。

    エラーハンドリング

    本番環境では、例外処理を適切に行い、接続やコマンドのリソースを確実に解放するように注意してください。Usingブロックを使用することで、自動的にリソースが解放されます。

    まとめ

    動的なテーブル名を使用した単体テストの実装方法について解説しました。ADO.NETを使用することで、EF Coreでは対応できないシナリオにも柔軟に対応できます。

    • ADO.NETの活用：SqlConnection、SqlCommand、SqlDataReaderを使用してデータベースにアクセス。
    • 一番上のレコードの取得：SELECT TOP 1句とORDER BY句を組み合わせて特定のレコードを取得。
    • テストデータの管理：テスト用データベースやトランザクションを使用してテストの再現性を確保。
    • セキュリティ対策：動的なSQLを使用する際には、入力値の検証を徹底。

    今回の方法を活用して、より信頼性の高い単体テストを作成してみてください。

  • C#とMySQLでトランザクションを実現する方法

    導入

    データベーストランザクションは、一連の操作を一つの単位として扱い、全ての操作が完了するか、一つでも失敗した場合には全てを元に戻す（ロールバックする）ための仕組みです。これにより、データの整合性と安全性が保たれます。本記事では、C#の.NET8、EFCore8でMySQLデータベースを扱う際のトランザクションの基本的な使い方を解説します。

    環境設定

    .NET8SDKが必要です。インストールしていない場合は、下記からインストールしてください。

    .NET のダウンロード (Linux、macOS、Windows) (microsoft.com)

    続いて、プロジェクト作成後、下記のパッケージを追加します。

    dotnet add package Microsoft.EntityFrameworkCore
dotnet add package MySql.Data.EntityFrameworkCore

    DbContextの設定

    DbContextを設定し、EF Coreがデータベース操作を行えるようにします。以下のコードを参考にしてください。

    今回は簡単のために接続文字列をDbContext に書いていますが、設定ファイル等から読み込めるようにしてください。

    using Microsoft.EntityFrameworkCore;

public class MyDbContext : DbContext
{
    public DbSet<Employee> Employees { get; set; }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        optionsBuilder.UseMySQL("server=localhost;database=myDatabase;user=myUser;password=myPassword");
    }
}

public class Employee
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Position { get; set; }
}

    トランザクションの開始

    EF CoreのDatabaseプロパティを使用してトランザクションを開始し、管理します。

    using var context = new MyDbContext();
using var transaction = context.Database.BeginTransaction();

try
{
    context.Employees.Add(new Employee { Name = "Jane Doe", Position = "Web Developer" });
    context.SaveChanges();

    transaction.Commit();
    Console.WriteLine("Transaction committed successfully.");
}
catch (Exception ex)
{
    transaction.Rollback();
    Console.WriteLine($"An error occurred: {ex.Message}");
}

    2行目でトランザクションを貼っています。

    6行目でDbContextに値を追加し、7行目で確定させます。

    9行目でトランザクションを完了させます。

    13行目で例外があった場合、トランザクションをロールバックさせます。context.SaveChages() 実行後でも、例外が発生すれば、ロールバックさせます。

    ベストプラクティス

    DbContext、トランザクションを使用する際には、その範囲を最小限にすることが推奨されます。また、エラーハンドリングを適切に行い、予期しない失敗からデータを保護することが重要です。

    まとめ

    MySql.Data.EntityFrameworkCoreを使用することで、EF Core 8とC#を用いたMySQLデータベース操作が容易になります。この記事が、より安全で効率的なデータベース管理の実現に役立つことを願っています。