LoginSignup
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

@mxProject

データベースを用いたデータリポジトリパターンを実装する

Last updated at Posted at 2025-03-28

はじめに

前回の記事で紹介したリポジトリパターンライブラリを使用したデータベース用リポジトリを紹介します。

エンティティやキーの型に対して制約や規約は要求せず、特定のO/Rマッパーにも依存しない基底クラスとして実装しています。

公開先

サンプル

データ取得

主キーによるデータ取得を行うリポジトリです。

// create a repository.
using var repo = new SampleEntityReadRepository(CreateConnection, true);

// get the entity with ID 1.
var entity = repo.Get(1);

if (entity != null)
{
    Console.WriteLine($"Id:{entity.Id}, Code:{entity.Code}, Name:{entity.Name}");
}
SampleEntityReadRepository クラスの実装はこちら 
/// <summary>
/// Provides methods to read SampleEntity from the database.
/// </summary>
internal class SampleEntityReadRepository : DbReadRepositoryBase<SampleEntity, int>
{
    /// <summary>
    /// Initializes a new instance of the <see cref="SampleEntityReadRepository"/> class.
    /// </summary>
    /// <param name="connectionActivator">The method to activate a connection.</param>
    /// <param name="useTransactionScope">A value that indicates whether to use ambient transactions using TransactionScope.</param>
    public SampleEntityReadRepository(Func<IDbConnection> connectionActivator, bool useTransactionScope)
        : base(connectionActivator, useTransactionScope)
    {
    }

    /// <summary>
    /// Gets the entity corresponding to the specified key.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="key">The key.</param>
    /// <returns>The entity.</returns>
    protected override SampleEntity? Get(Func<IDbCommand> commandActivator, int key)
    {
        return GetSampleEntities(commandActivator, new[] { key }).FirstOrDefault();
    }

    /// <summary>
    /// Gets the entities corresponding to the specified keys.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="keys">The keys.</param>
    /// <returns>The entities.</returns>
    protected override IEnumerable<SampleEntity> GetRange(Func<IDbCommand> commandActivator, IEnumerable<int> keys)
    {
        return GetSampleEntities(commandActivator, keys);
    }

    /// <summary>
    /// Gets all entities.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <returns>The entities.</returns>
    protected override IEnumerable<SampleEntity> GetAll(Func<IDbCommand> commandActivator)
    {
        return GetSampleEntities(commandActivator, Array.Empty<int>());
    }

    /// <summary>
    /// Gets all keys.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <returns>The keys.</returns>
    protected override IEnumerable<int> GetAllKeys(Func<IDbCommand> commandActivator)
    {
        using var command = commandActivator();

        var sql = new StringBuilder();

        sql.AppendLine("select");
        sql.AppendLine("ID");
        sql.AppendLine("from");
        sql.AppendLine("SAMPLE_TABLE");
        sql.AppendLine("where");

        command.CommandText = sql.ToString();

        using var reader = command.ExecuteReader();

        while (reader.Read())
        {
            yield return reader.GetInt32(reader.GetOrdinal("ID"));
        }
    }

    /// <summary>
    /// Gets the entities corresponding to the specified keys.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="keys">The keys.</param>
    /// <returns>The entities.</returns>
    private IEnumerable<SampleEntity> GetSampleEntities(Func<IDbCommand> commandActivator, IEnumerable<int> keys)
    {
        using var command = commandActivator();

        var sql = new StringBuilder();

        sql.AppendLine("select");
        sql.AppendLine("ID");
        sql.AppendLine(", CODE");
        sql.AppendLine(", NAME");
        sql.AppendLine("from");
        sql.AppendLine("SAMPLE_TABLE");
        sql.AppendLine("where 1=1");

        if (keys != null && keys.Any())
        {
            var array = keys.ToArray();

            if (array.Length == 1)
            {
                sql.AppendLine("ID = @ID");
                command.AddParameter("@ID", array[0]);
            }
            else
            {
                sql.Append("ID in (");

                for (int i = 0; i < array.Length; ++i)
                {
                    if (i > 0) { sql.Append(", "); }
                    sql.Append($"@ID{i}");
                    command.AddParameter($"@ID{i}", array[i]);
                }

                sql.AppendLine(")");
            }
        }

        command.CommandText = sql.ToString();

        using var reader = command.ExecuteReader();

        while (reader.Read())
        {
            yield return new SampleEntity
            {
                Id = reader.GetInt32(reader.GetOrdinal("ID")),
                Code = reader.GetString(reader.GetOrdinal("CODE")),
                Name = reader.GetString(reader.GetOrdinal("NAME"))
            };
        }
    }
}

データ取得／更新リポジトリ

主キーによるデータ取得とデータ更新を行うリポジトリです。

暗黙のトランザクション

コネクションが TransactionScope による暗黙のトランザクションをサポートしている場合、次のように実装することができます。

// create a repository.
using var repo = new SampleEntityRepository(CreateConnection, true);

var entity = new SampleEntity()
{
    Id = 1,
    Code = "00001",
    Name = "item1"
};

// use ambient transaction.
using var scope = CreateTransactionScope();

// insert the entity.
repo.Insert(entity)

// commit transaction.
scope.Complete();
SampleEntityRepository クラスの実装はこちら 
/// <summary>
/// Repository class for sample entities.
/// </summary>
internal class SampleEntityRepository : DbReadWriteRepositoryBase<SampleEntity, int>
{
    /// <summary>
    /// Creates a new instance.
    /// </summary>
    /// <param name="connectionActivator">The method to activate a connection.</param>
    /// <param name="useTransactionScope">A value indicating whether to use TransactionScope.</param>
    public SampleEntityRepository(Func<IDbConnection> connectionActivator, bool useTransactionScope)
        : base(connectionActivator, useTransactionScope)
    {
    }

    #region get

    // omission.
    // This implementation is the same as SampleEntityReadRepository.

    #endregion

    #region insert

    /// <summary>
    /// Inserts the entity.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="entity">The entity.</param>
    /// <returns>Number of affected rows.</returns>
    protected override int Insert(Func<IDbCommand> commandActivator, SampleEntity entity)
    {
        return InsertSampleEntities(commandActivator, new[] { entity });
    }

    /// <summary>
    /// Inserts the entities.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="entities">The entities.</param>
    /// <returns>Number of affected rows.</returns>
    protected override int InsertRange(Func<IDbCommand> commandActivator, IEnumerable<SampleEntity> entities)
    {
        return InsertSampleEntities(commandActivator, entities);
    }

    /// <summary>
    /// Inserts the entities.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="entities">The entities.</param>
    /// <returns>Number of affected rows.</returns>
    private int InsertSampleEntities(Func<IDbCommand> commandActivator, IEnumerable<SampleEntity> entities)
    {
        var sql = new StringBuilder();

        sql.AppendLine("insert into SAMPLE_TABLE (");
        sql.AppendLine("ID");
        sql.AppendLine(", CODE");
        sql.AppendLine(", NAME");
        sql.AppendLine(") values (");
        sql.AppendLine("@ID");
        sql.AppendLine(", @CODE");
        sql.AppendLine(", @NAME");
        sql.AppendLine(")");

        using var command = commandActivator();

        command.AddParameter("@CODE", "");
        command.AddParameter("@NAME", "");
        command.AddParameter("@ID", 0);
        command.CommandText = sql.ToString();

        int affectedRows = 0;

        foreach (var entity in entities)
        {
            command.SetParameterValue("@CODE", entity.Code);
            command.SetParameterValue("@NAME", entity.Name);
            command.SetParameterValue("@ID", entity.Id);

            affectedRows += command.ExecuteNonQuery();
        }

        return affectedRows;
    }

    #endregion

    #region update  

    /// <summary>
    /// Updates the entity.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="entity">The entity.</param>
    /// <returns>Number of affected rows.</returns>
    protected override int Update(Func<IDbCommand> commandActivator, SampleEntity entity)
    {
        return UpdateSampleEntities(commandActivator, new[] { entity });
    }

    /// <summary>
    /// Updates the entities.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="entities">The entities.</param>
    /// <returns>Number of affected rows.</returns>
    protected override int UpdateRange(Func<IDbCommand> commandActivator, IEnumerable<SampleEntity> entities)
    {
        return UpdateSampleEntities(commandActivator, entities);
    }

    /// <summary>
    /// Updates the entities.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="entities">The entities.</param>
    /// <returns>Number of affected rows.</returns>
    private int UpdateSampleEntities(Func<IDbCommand> commandActivator, IEnumerable<SampleEntity> entities)
    {
        var sql = new StringBuilder();

        sql.AppendLine("update SAMPLE_TABLE set");
        sql.AppendLine("CODE = @CODE");
        sql.AppendLine(", NAME = @NAME");
        sql.AppendLine("where ID = @ID");

        using var command = commandActivator();

        command.AddParameter("@CODE", "");
        command.AddParameter("@NAME", "");
        command.AddParameter("@ID", 0);
        command.CommandText = sql.ToString();

        int affectedRows = 0;

        foreach (var entity in entities)
        {
            command.SetParameterValue("@CODE", entity.Code);
            command.SetParameterValue("@NAME", entity.Name);
            command.SetParameterValue("@ID", entity.Id);

            affectedRows += command.ExecuteNonQuery();
        }

        return affectedRows;
    }

    #endregion

    #region delete

    /// <summary>
    /// Deletes the entity.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="entity">The entity.</param>
    /// <returns>Number of affected rows.</returns>
    protected override int Delete(Func<IDbCommand> commandActivator, SampleEntity entity)
    {
        return DeleteSampleEntities(commandActivator, new[] { entity });
    }

    /// <summary>
    /// Deletes the entities.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="entities">The entities.</param>
    /// <returns>Number of affected rows.</returns>
    protected override int DeleteRange(Func<IDbCommand> commandActivator, IEnumerable<SampleEntity> entities)
    {
        return DeleteSampleEntities(commandActivator, entities);
    }

    /// <summary>
    /// Deletes the entities.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="entities">The entities.</param>
    /// <returns>Number of affected rows.</returns>
    private int DeleteSampleEntities(Func<IDbCommand> commandActivator, IEnumerable<SampleEntity> entities)
    {
        var sql = new StringBuilder();

        sql.AppendLine("delete from SAMPLE_TABLE");
        sql.AppendLine("where ID = @ID");

        using var command = commandActivator();

        command.AddParameter("@ID", 0);
        command.CommandText = sql.ToString();

        int affectedRows = 0;

        foreach (var entity in entities)
        {
            command.SetParameterValue("@ID", entity.Id);
            affectedRows += command.ExecuteNonQuery();
        }

        return affectedRows;
    }

    #endregion
}

明示的なトランザクション

TransactionScope による暗黙のトランザクションを利用しない場合、コンテキストクラスを用いてトランザクションを受け渡すように実装します。

using var repo = new SampleEntityRepositoryWithDbContext(null, true);

var entity = new SampleEntity()
{
    Id = 1,
    Code = "00001",
    Name = "item1"
};

// create a connection.
using var connection = CreateConnection();
connection.Open();

// begin transaction.
using var transaction = connection.BeginTransaction();

// create a context.
var context = new SampleDbContext(transaction);

// insert the entity.
repo.Insert(entity, context)

// commit transaction.
transaction.Commit();
SampleEntityRepositoryWithDbContext クラスの実装はこちら

コネクションとトランザクションに関する実装は基底クラスにカプセル化されていますので、実装内容はほとんど SampleEntityRepository クラスと同じです。

/// <summary>
/// Repository class for sample entities.
/// </summary>
internal class SampleEntityRepositoryWithDbContext : DbReadWriteRepositoryWithContextBase<SampleEntity, int, SampleDbContext>
{
    /// <summary>
    /// Creates a new instance.
    /// </summary>
    /// <param name="connectionActivator">The method to activate a connection.</param>
    /// <param name="useTransactionScope">A value indicating whether to use TransactionScope.</param>
    public SampleEntityRepositoryWithDbContext(Func<IDbConnection> connectionActivator, bool useTransactionScope)
        : base(connectionActivator, useTransactionScope)
    {
    }

    #region get

    /// <summary>
    /// Gets the entity corresponding to the specified key.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="key">The key.</param>
    /// <returns>The entity.</returns>
    protected override SampleEntity? Get(Func<IDbCommand> commandActivator, int key, SampleDbContext context)
    {
        return GetSampleEntities(commandActivator, new[] { key }).FirstOrDefault();
    }

    /// <summary>
    /// Gets the entities corresponding to the specified keys.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="keys">The keys.</param>
    /// <returns>The entities.</returns>
    protected override IEnumerable<SampleEntity> GetRange(Func<IDbCommand> commandActivator, IEnumerable<int> keys, SampleDbContext context)
    {
        return GetSampleEntities(commandActivator, keys);
    }

    /// <summary>
    /// Gets all entities.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <returns>The entities.</returns>
    protected override IEnumerable<SampleEntity> GetAll(Func<IDbCommand> commandActivator, SampleDbContext context)
    {
        return GetSampleEntities(commandActivator, Array.Empty<int>());
    }

    /// <summary>
    /// Gets all keys.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <returns>The keys.</returns>
    protected override IEnumerable<int> GetAllKeys(Func<IDbCommand> commandActivator, SampleDbContext context)
    {
        return GetAllSampleEntityKeys(commandActivator);
    }

    /// <summary>
    /// Gets the entities corresponding to the specified keys.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="keys">The keys.</param>
    /// <returns>The entities.</returns>
    private IEnumerable<SampleEntity> GetSampleEntities(Func<IDbCommand> commandActivator, IEnumerable<int> keys)
    {
        using var command = commandActivator();

        var sql = new StringBuilder();

        sql.AppendLine("select");
        sql.AppendLine("ID");
        sql.AppendLine(", CODE");
        sql.AppendLine(", NAME");
        sql.AppendLine("from");
        sql.AppendLine("SAMPLE_TABLE");
        sql.AppendLine("where 1=1");

        if (keys != null && keys.Any())
        {
            var array = keys.ToArray();

            if (array.Length == 1)
            {
                sql.AppendLine("and ID = @ID");
                command.AddParameter("@ID", array[0]);
            }
            else
            {
                sql.Append("and ID in (");

                for (int i = 0; i < array.Length; ++i)
                {
                    if (i > 0) { sql.Append(", "); }
                    sql.Append($"@ID{i}");
                    command.AddParameter($"@ID{i}", array[i]);
                }

                sql.AppendLine(")");
            }
        }

        command.CommandText = sql.ToString();

        using var reader = command.ExecuteReader();

        while (reader.Read())
        {
            yield return new SampleEntity
            {
                Id = reader.GetInt32(reader.GetOrdinal("ID")),
                Code = reader.GetString(reader.GetOrdinal("CODE")),
                Name = reader.GetString(reader.GetOrdinal("NAME"))
            };
        }
    }

    private IEnumerable<int> GetAllSampleEntityKeys(Func<IDbCommand> commandActivator)
    {
        using var command = commandActivator();

        var sql = new StringBuilder();

        sql.AppendLine("select");
        sql.AppendLine("ID");
        sql.AppendLine("from");
        sql.AppendLine("SAMPLE_TABLE");

        command.CommandText = sql.ToString();

        using var reader = command.ExecuteReader();

        while (reader.Read())
        {
            yield return reader.GetInt32(reader.GetOrdinal("ID"));
        }
    }

    #endregion

    #region insert

    /// <summary>
    /// Inserts the entity.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="entity">The entity.</param>
    /// <returns>Number of affected rows.</returns>
    protected override int Insert(Func<IDbCommand> commandActivator, SampleEntity entity, SampleDbContext context)
    {
        return InsertSampleEntities(commandActivator, new[] { entity });
    }

    /// <summary>
    /// Inserts the entities.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="entities">The entities.</param>
    /// <returns>Number of affected rows.</returns>
    protected override int InsertRange(Func<IDbCommand> commandActivator, IEnumerable<SampleEntity> entities, SampleDbContext context)
    {
        return InsertSampleEntities(commandActivator, entities);
    }

    /// <summary>
    /// Inserts the entities.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="entities">The entities.</param>
    /// <returns>Number of affected rows.</returns>
    private int InsertSampleEntities(Func<IDbCommand> commandActivator, IEnumerable<SampleEntity> entities)
    {
        var sql = new StringBuilder();

        sql.AppendLine("insert into SAMPLE_TABLE (");
        sql.AppendLine("ID");
        sql.AppendLine(", CODE");
        sql.AppendLine(", NAME");
        sql.AppendLine(") values (");
        sql.AppendLine("@ID");
        sql.AppendLine(", @CODE");
        sql.AppendLine(", @NAME");
        sql.AppendLine(")");

        using var command = commandActivator();

        command.AddParameter("@CODE", "");
        command.AddParameter("@NAME", "");
        command.AddParameter("@ID", 0);
        command.CommandText = sql.ToString();

        int affectedRows = 0;

        foreach (var entity in entities)
        {
            command.SetParameterValue("@CODE", entity.Code);
            command.SetParameterValue("@NAME", entity.Name);
            command.SetParameterValue("@ID", entity.Id);

            affectedRows += command.ExecuteNonQuery();
        }

        return affectedRows;
    }

    #endregion

    #region update  

    /// <summary>
    /// Updates the entity.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="entity">The entity.</param>
    /// <returns>Number of affected rows.</returns>
    protected override int Update(Func<IDbCommand> commandActivator, SampleEntity entity, SampleDbContext context)
    {
        return UpdateSampleEntities(commandActivator, new[] { entity });
    }

    /// <summary>
    /// Updates the entities.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="entities">The entities.</param>
    /// <returns>Number of affected rows.</returns>
    protected override int UpdateRange(Func<IDbCommand> commandActivator, IEnumerable<SampleEntity> entities, SampleDbContext context)
    {
        return UpdateSampleEntities(commandActivator, entities);
    }

    /// <summary>
    /// Updates the entities.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="entities">The entities.</param>
    /// <returns>Number of affected rows.</returns>
    private int UpdateSampleEntities(Func<IDbCommand> commandActivator, IEnumerable<SampleEntity> entities)
    {
        var sql = new StringBuilder();

        sql.AppendLine("update SAMPLE_TABLE set");
        sql.AppendLine("CODE = @CODE");
        sql.AppendLine(", NAME = @NAME");
        sql.AppendLine("where ID = @ID");

        using var command = commandActivator();

        command.AddParameter("@CODE", "");
        command.AddParameter("@NAME", "");
        command.AddParameter("@ID", 0);
        command.CommandText = sql.ToString();

        int affectedRows = 0;

        foreach (var entity in entities)
        {
            command.SetParameterValue("@CODE", entity.Code);
            command.SetParameterValue("@NAME", entity.Name);
            command.SetParameterValue("@ID", entity.Id);

            affectedRows += command.ExecuteNonQuery();
        }

        return affectedRows;
    }

    #endregion

    #region delete

    /// <summary>
    /// Deletes the entity.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="entity">The entity.</param>
    /// <returns>Number of affected rows.</returns>
    protected override int Delete(Func<IDbCommand> commandActivator, SampleEntity entity, SampleDbContext context)
    {
        return DeleteSampleEntities(commandActivator, new[] { entity });
    }

    /// <summary>
    /// Deletes the entities.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="entities">The entities.</param>
    /// <returns>Number of affected rows.</returns>
    protected override int DeleteRange(Func<IDbCommand> commandActivator, IEnumerable<SampleEntity> entities, SampleDbContext context)
    {
        return DeleteSampleEntities(commandActivator, entities);
    }

    /// <summary>
    /// Deletes the entities.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="entities">The entities.</param>
    /// <returns>Number of affected rows.</returns>
    private int DeleteSampleEntities(Func<IDbCommand> commandActivator, IEnumerable<SampleEntity> entities)
    {
        var sql = new StringBuilder();

        sql.AppendLine("delete from SAMPLE_TABLE");
        sql.AppendLine("where ID = @ID");

        using var command = commandActivator();

        command.AddParameter("@ID", 0);
        command.CommandText = sql.ToString();

        int affectedRows = 0;

        foreach (var entity in entities)
        {
            command.SetParameterValue("@ID", entity.Id);

            affectedRows += command.ExecuteNonQuery();
        }

        return affectedRows;
    }

    #endregion
}

なお、DbReadWriteRepositoryBase<TEntity, TKey> クラスにはコネクションやトランザクションを引数で受け取る Insert メソッドも実装されています（後述を参照）。それらのメソッドを使えば、上記のようにコンテキストを使用してコネクションやトランザクションを受け渡さなくても、次のようにトランザクション処理を実現できます。IWriteDataRepository<TEntity> インターフェースや IReadDataRepository<TEntity, TKey> インターフェースなどを用いて抽象化する必要がなければ、こちらのほうがシンプルでわかりやすいかもしれません。

using var repo = new SampleEntityRepository(null, true);

var entity = new SampleEntity()
{
    Id = 1,
    Code = "00001",
    Name = "item1"
};

// create a connection.
using var connection = CreateConnection();
connection.Open();

// begin transaction.
using var transaction = connection.BeginTransaction();

// insert the entity.
repo.Insert(entity, transaction)

// commit transaction.
transaction.Commit();

クエリリポジトリ

コマンド・クエリ責務分離（CQRS）を意識したデータ取得リポジトリです。

// create a repository.
using var repo = new SampleEntityQuery(CreateConnection, true);

var condition = new SampleEntityCondition()
{
    MinimumCode = "00002",
    MaximumCode = "00004"
};

// query for entities that match the specified condition.
var entities = repo.Query(condition).ToArray();

foreach (var entity in entities)
{
    Console.WriteLine($"Id:{entity.Id}, Code:{entity.Code}, Name:{entity.Name}");
}
SampleEntityQuery クラスの実装はこちら 
/// <summary>
/// Provides methods to query SampleEntity from the database.
/// </summary>
internal class SampleEntityQuery : DbQueryBase<SampleEntity, SampleEntityCondition>
{
    /// <summary>
    /// Initializes a new instance of the <see cref="SampleEntityQuery"/> class.
    /// </summary>
    /// <param name="connectionActivator">The method to activate a connection.</param>
    /// <param name="useTransactionScope">A value that indicates whether to use ambient transactions using TransactionScope.</param>
    public SampleEntityQuery(Func<IDbConnection> connectionActivator, bool useTransactionScope)
        : base(connectionActivator, useTransactionScope)
    {
    }

    /// <summary>
    /// Gets the count of entities that match the specified condition.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="condition">The query condition.</param>
    /// <returns>The count of entities.</returns>
    public override int GetCount(Func<IDbCommand> commandActivator, SampleEntityCondition condition)
    {
        using var command = CreateCommand(true, commandActivator, condition);
        return Convert.ToInt32(command.ExecuteScalar());
    }

    /// <summary>
    /// Queries the entities that match the specified condition.
    /// </summary>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="condition">The query condition.</param>
    /// <param name="skipCount">The number of entities to skip.</param>
    /// <param name="maximumCount">The maximum number of entities to retrieve.</param>
    /// <returns>The entities that match the condition.</returns>
    public override IEnumerable<SampleEntity> Query(Func<IDbCommand> commandActivator, SampleEntityCondition condition, int skipCount = 0, int? maximumCount = null)
    {
        using var command = CreateCommand(false, commandActivator, condition, skipCount, maximumCount);

        using var reader = command.ExecuteReader();

        while (reader.Read())
        {
            yield return new SampleEntity()
            {
                Id = reader.GetInt32(reader.GetOrdinal("ID")),
                Code = reader.GetString(reader.GetOrdinal("CODE")),
                Name = reader.GetString(reader.GetOrdinal("NAME"))
            };
        }
    }

    /// <summary>
    /// Creates a command based on the specified condition.
    /// </summary>
    /// <param name="forGetCount">Indicates whether the command is for getting the count.</param>
    /// <param name="commandActivator">The method to activate a new command.</param>
    /// <param name="condition">The query condition.</param>
    /// <param name="skipCount">The number of entities to skip.</param>
    /// <param name="maximumCount">The maximum number of entities to retrieve.</param>
    /// <returns>The created command.</returns>
    private IDbCommand CreateCommand(bool forGetCount, Func<IDbCommand> commandActivator, SampleEntityCondition condition, int skipCount = 0, int? maximumCount = null)
    {
        var command = commandActivator();

        var sql = new StringBuilder();

        if (forGetCount)
        {
            sql.AppendLine("select count(*) from (");
        }

        sql.AppendLine("select");
        sql.AppendLine("ID");
        sql.AppendLine(", CODE");
        sql.AppendLine(", NAME");
        sql.AppendLine("from");
        sql.AppendLine("SAMPLE_TABLE");
        sql.AppendLine("where 1=1");

        if (!string.IsNullOrEmpty(condition.MinimumCode))
        {
            sql.AppendLine("and CODE >= @MinimumCode");
            command.AddParameter("@MinimumCode", condition.MinimumCode);
        }

        if (!string.IsNullOrEmpty(condition.MaximumCode))
        {
            sql.AppendLine("and CODE <= @MaximumCode");
            command.AddParameter("@MaximumCode", condition.MaximumCode);
        }

        if (!string.IsNullOrEmpty(condition.NamePattern))
        {
            sql.AppendLine("and NAME like @NamePattern");
            command.AddParameter("@NamePattern", condition.NamePattern);
        }

        if (forGetCount)
        {
            sql.AppendLine(") query");
        }
        else
        {
            sql.AppendLine("order by CODE");
        }

        command.CommandText = sql.ToString();
        return command;
    }
}

クラス図

基底クラス

DbRepositoryBase<TEntity> クラス

データベースを使用するリポジトリの基本実装です。

  • データコネクションを生成するメソッドをコンストラクタで受け取ります。
  • TransactionScope を利用するかどうかをコンストラクタで受け取ります。
    • true : コネクションを生成するとき、アクティブな TransactionScope が存在しなければトランザクションを明示的に開始します。
    • false : コネクションを生成するとき、常にトランザクションを開始します。
public abstract class DbRepositoryBase<TEntity> : IDataRepository<TEntity>
{
    protected DbRepositoryBase(Func<IDbConnection> connectionActivator, bool useTransactionScope)
    {
        // omission
    }

    // Gets the executor.
    protected DbExecutor Executor { get; }
}

DbExecutor クラスはコマンドを実行するときに使用するヘルパークラスです。次の機能を持ちます。

  • 新たなコネクションを生成して指定されたコマンドを実行するメソッド
    • アクティブな TransactionScope が存在しなければトランザクションを明示的に開始します。
  • 指定されたコネクションを使用して指定されたコマンドを実行するメソッド
    • トランザクションは開始しません。
  • 指定されたトランザクションを使用して指定されたコマンドを実行するメソッド
public class DbExecutor
{
    public DbExecutor(Func<IDbConnection> connectionActivator, bool useTransactionScope)
    {
        // omission
    }

    public void ExecuteOnNewConnection(Action<Func<IDbCommand>> action);
    public TResult ExecuteOnNewConnection<TResult>(Func<Func<IDbCommand>, TResult> func)
    public void ExecuteOnNewConnection<TState>(TState state, Action<TState, Func<IDbCommand>> action)
    public TResult ExecuteOnNewConnection<TState, TResult>(TState state, Func<TState, Func<IDbCommand>, TResult> func)

    public void ExecuteOnConnection(IDbConnection connection, Action<Func<IDbCommand>> action)
    public TResult ExecuteOnConnection<TResult>(IDbConnection connection, Func<Func<IDbCommand>, TResult> func)
    public void ExecuteOnConnection<TState>(TState state, IDbConnection connection, Action<TState, Func<IDbCommand>> action)
    public TResult ExecuteOnConnection<TState, TResult>(TState state, IDbConnection connection, Func<TState, Func<IDbCommand>, TResult> func)

    public void ExecuteOnTransaction(IDbTransaction transaction, Action<Func<IDbCommand>> action)
    public TResult ExecuteOnTransaction<TResult>(IDbTransaction transaction, Func<Func<IDbCommand>, TResult> func)
    public void ExecuteOnTransaction<TState>(TState state, IDbTransaction transaction, Action<TState, Func<IDbCommand>> action)
    public TResult ExecuteOnTransaction<TState, TResult>(TState state, IDbTransaction transaction, Func<TState, Func<IDbCommand>, TResult> func)
}

DbRepositoryWithContextBase<TEntity, TContext> クラス

データベースを使用するリポジトリの基本実装です。

  • コンストラクタで指定するオブジェクトは前述の DbRepositoryBase<TEntity> クラスと同じです。
  • TContext で指定される型が IDbRepositoryContext インターフェースを実装している場合、コネクションとトランザクションをコンテキストから取得します。新たなコネクションは生成されません。
public abstract class DbRepositoryWithContextBase<TEntity, TContext> : IDataRepository<TEntity>
    where TContext : IDataRepositoryContext
{
    protected DbRepositoryWithContextBase(Func<IDbConnection> connectionActivator, bool useTransactionScope)
    {
        // omission
    }

    // Gets the executor.
    protected DbExecutorWithContext<TContext> Executor { get; }

    // Gets the current connection from the specified context.
    protected bool TryGetCurrentConnection(TContext context, out IDbConnection connection);

    // Gets the current transaction from the specified context.
    protected bool TryGetCurrentTransaction(TContext context, out IDbTransaction transaction);
}

DbExecutor クラスと同様、DbExecutorWithContext<TContext> クラスもコマンドを実行するときに使用するヘルパークラスです。コマンドを実行するメソッドの引数にコンテキストが追加されています。

public class DbExecutorWithContext<TContext>
    where TContext : IDataRepositoryContext
{
    public DbExecutorWithContext(Func<IDbConnection> connectionActivator, bool useTransactionScope)
    {
        // omission
    }

    public void ExecuteOnNewConnection(Action<Func<IDbCommand>, TContext> action, TContext context);
    public TResult ExecuteOnNewConnection<TResult>(Func<Func<IDbCommand>, TContext, TResult> func, TContext context);
    public void ExecuteOnNewConnection<TState>(TState state, Action<TState, Func<IDbCommand>, TContext> action, TContext context);
    public TResult ExecuteOnNewConnection<TState, TResult>(TState state, Func<TState, Func<IDbCommand>, TContext, TResult> func, TContext context);

    public void ExecuteOnConnection(IDbConnection connection, Action<Func<IDbCommand>, TContext> action, TContext context);
    public TResult ExecuteOnConnection<TResult>(IDbConnection connection, Func<Func<IDbCommand>, TContext, TResult> func, TContext context);
    public void ExecuteOnConnection<TState>(TState state, IDbConnection connection, Action<TState, Func<IDbCommand>, TContext> action, TContext context);
    public TResult ExecuteOnConnection<TState, TResult>(TState state, IDbConnection connection, Func<TState, Func<IDbCommand>, TContext, TResult> func, TContext context);

    public void ExecuteOnTransaction(IDbTransaction transaction, Action<Func<IDbCommand>, TContext> action, TContext context);
    public TResult ExecuteOnTransaction<TResult>(IDbTransaction transaction, Func<Func<IDbCommand>, TContext, TResult> func, TContext context);
    public void ExecuteOnTransaction<TState>(TState state, IDbTransaction transaction, Action<TState, Func<IDbCommand>, TContext> action, TContext context);
    public TResult ExecuteOnTransaction<TState, TResult>(TState state, IDbTransaction transaction, Func<TState, Func<IDbCommand>, TContext, TResult> func, TContext context);
}

基本形のリポジトリ

DbRepositoryBase<TEntity> クラスを継承し、各リポジトリのインターフェースを実装しています。

  • インターフェースが提供するメソッドに対して、コネクションとトランザクションを引数に追加したオーバーロードメソッドを実装しています。これらは複数のリポジトリを連携して複合的なエンティティを生成するケースで利用することを想定したものです。

DbReadRepositoryBase<TEntity, TKey> クラス

  • IReadDataRepository<TEntity, TKey> インターフェースの基本実装です。
  • DbRepositoryBase<TEntity> クラスを継承します。
  • リポジトリの各メソッドはオーバーロード構成になっています。
    • インターフェースのメソッドを実装しているメソッド
      • 新たなコネクションを生成して処理を実行します。アクティブな TransactionScope が存在しなければトランザクションを明示的に開始します。
    • コネクションを受け取るメソッド
      • 指定されたコネクションを使用して処理を実行します。トランザクションは開始しません。
    • トランザクションを受け取るメソッド
      • 指定されたトランザクションを使用して処理を実行します。
    • コマンドを実行する主処理を表す抽象メソッド
      • コマンドのインスタンスを生成し、コマンドテキストを組み立ててデータを抽出するように実装してください。
public abstract class DbReadRepositoryBase<TEntity, TKey> : DbRepositoryBase<TEntity>, IReadDataRepository<TEntity, TKey>
{
    public TEntity? Get(TKey key);
    public TEntity? Get(IDbConnection connection, TKey key);
    public TEntity? Get(IDbTransaction transaction, TKey key);
    protected abstract TEntity? Get(Func<IDbCommand> commandActivator, TKey key);

    public IEnumerable<TEntity> GetRange(IEnumerable<TKey> keys);
    public IEnumerable<TEntity> GetRange(IDbConnection connection, IEnumerable<TKey> keys);
    public IEnumerable<TEntity> GetRange(IDbTransaction transaction, IEnumerable<TKey> keys);
    protected abstract IEnumerable<TEntity> GetRange(Func<IDbCommand> commandActivator, IEnumerable<TKey> keys);

    public IEnumerable<TEntity> GetAll();
    public IEnumerable<TEntity> GetAll(IDbConnection connection);
    public IEnumerable<TEntity> GetAll(IDbTransaction transaction);
    protected abstract IEnumerable<TEntity> GetAll(Func<IDbCommand> commandActivator);

    public IEnumerable<TKey> GetAllKeys();
    public IEnumerable<TKey> GetAllKeys(IDbConnection connection);
    public IEnumerable<TKey> GetAllKeys(IDbTransaction transaction);
    protected abstract IEnumerable<TKey> GetAllKeys(Func<IDbCommand> commandActivator);
}

DbReadRepositoryWithUniqueKeyBase<TEntity, TPrimaryKey, TUniqueKey> クラス

  • IReadDataRepositoryWithUniqueKey<TEntity, TPrimaryKey, TUniqueKey> インターフェースの基本実装です。
  • DbRepositoryBase<TEntity> クラスを継承します。
  • リポジトリの各メソッドはオーバーロード構成になっています。
    • インターフェースのメソッドを実装しているメソッド
      • 新たなコネクションを生成して処理を実行します。アクティブな TransactionScope が存在しなければトランザクションを明示的に開始します。
    • コネクションを受け取るメソッド
      • 指定されたコネクションを使用して処理を実行します。トランザクションは開始しません。
    • トランザクションを受け取るメソッド
      • 指定されたトランザクションを使用して処理を実行します。
    • コマンドを実行する主処理を表す抽象メソッド
      • コマンドのインスタンスを生成し、コマンドテキストを組み立ててデータを抽出するように実装してください。
public abstract class DbReadRepositoryWithUniqueKeyBase<TEntity, TPrimaryKey, TUniqueKey> : DbRepositoryBase<TEntity>, IReadDataRepositoryWithUniqueKey<TEntity, TPrimaryKey, TUniqueKey>
{
    public TEntity? GetByPrimaryKey(TPrimaryKey primaryKey);
    public TEntity? GetByPrimaryKey(IDbConnection connection, TPrimaryKey primaryKey);
    public TEntity? GetByPrimaryKey(IDbTransaction transaction, TPrimaryKey primaryKey);
    protected abstract TEntity? GetByPrimaryKey(Func<IDbCommand> commandActivator, TPrimaryKey primaryKey);

    public TEntity? GetByUniqueKey(TUniqueKey uniqueKey);
    public TEntity? GetByUniqueKey(IDbConnection connection, TUniqueKey uniqueKey);
    public TEntity? GetByUniqueKey(IDbTransaction transaction, TUniqueKey uniqueKey);
    protected abstract TEntity? GetByUniqueKey(Func<IDbCommand> commandActivator, TUniqueKey uniqueKey);

    public IEnumerable<TEntity> GetRangeByPrimaryKey(IEnumerable<TPrimaryKey> primaryKeys)
    public IEnumerable<TEntity> GetRangeByPrimaryKey(IDbConnection connection, IEnumerable<TPrimaryKey> primaryKeys)
    public IEnumerable<TEntity> GetRangeByPrimaryKey(IDbTransaction transaction, IEnumerable<TPrimaryKey> primaryKeys);
    protected abstract IEnumerable<TEntity> GetRangeByPrimaryKey(Func<IDbCommand> commandActivator, IEnumerable<TPrimaryKey> primaryKeys);

    public IEnumerable<TEntity> GetRangeByUniqueKey(IEnumerable<TUniqueKey> uniqueKeys);
    public IEnumerable<TEntity> GetRangeByUniqueKey(IDbConnection connection, IEnumerable<TUniqueKey> uniqueKeys);
    public IEnumerable<TEntity> GetRangeByUniqueKey(IDbTransaction transaction, IEnumerable<TUniqueKey> uniqueKeys);
    protected abstract IEnumerable<TEntity> GetRangeByUniqueKey(Func<IDbCommand> commandActivator, IEnumerable<TUniqueKey> uniqueKeys);

    public IEnumerable<TEntity> GetAll();
    public IEnumerable<TEntity> GetAll(IDbConnection connection);
    public IEnumerable<TEntity> GetAll(IDbTransaction transaction);
    protected abstract IEnumerable<TEntity> GetAll(Func<IDbCommand> commandActivator);

    public IEnumerable<TPrimaryKey> GetAllPrimaryKeys();
    public IEnumerable<TPrimaryKey> GetAllPrimaryKeys(IDbConnection connection);
    public IEnumerable<TPrimaryKey> GetAllPrimaryKeys(IDbTransaction transaction);
    protected abstract IEnumerable<TPrimaryKey> GetAllPrimaryKeys(Func<IDbCommand> commandActivator);

    public IEnumerable<TUniqueKey> GetAllUniqueKeys();
    public IEnumerable<TUniqueKey> GetAllUniqueKeys(IDbConnection connection);
    public IEnumerable<TUniqueKey> GetAllUniqueKeys(IDbTransaction transaction);
    protected abstract IEnumerable<TUniqueKey> GetAllUniqueKeys(Func<IDbCommand> commandActivator);
}

DbReadWriteRepositoryBase<TEntity, TKey> クラス

  • IWriteDataRepository<TEntity> インターフェースの基本実装です。
  • DbReadRepositoryBase<TEntity, TKey> クラスを継承します。
  • リポジトリの各メソッドはオーバーロード構成になっています。
    • インターフェースのメソッドを実装しているメソッド
      • 新たなコネクションを生成して処理を実行します。アクティブな TransactionScope が存在しなければトランザクションを明示的に開始します。
    • コネクションを受け取るメソッド
      • 指定されたコネクションを使用して処理を実行します。トランザクションは開始しません。
    • トランザクションを受け取るメソッド
      • 指定されたトランザクションを使用して処理を実行します。
    • コマンドを実行する主処理を表す抽象メソッド
      • コマンドのインスタンスを生成し、コマンドテキストを組み立ててデータを抽出するように実装してください。
public abstract class DbReadWriteRepositoryBase<TEntity, TKey> : DbReadRepositoryBase<TEntity, TKey>, IWriteDataRepository<TEntity>
{
    public int Insert(TEntity entity);
    public int Insert(IDbConnection connection, TEntity entity);
    public int Insert(IDbTransaction transaction, TEntity entity);
    protected abstract int Insert(Func<IDbCommand> commandActivator, TEntity entity);

    public int InsertRange(IEnumerable<TEntity> entities);
    public int InsertRange(IDbConnection connection, IEnumerable<TEntity> entities);
    public int InsertRange(IDbTransaction transaction, IEnumerable<TEntity> entities);
    protected abstract int InsertRange(Func<IDbCommand> commandActivator, IEnumerable<TEntity> entities);

    public int Update(TEntity entity);
    public int Update(IDbConnection connection, TEntity entity);
    public int Update(IDbTransaction transaction, TEntity entity);
    protected abstract int Update(Func<IDbCommand> commandActivator, TEntity entity);

    public int UpdateRange(IEnumerable<TEntity> entities);
    public int UpdateRange(IDbConnection connection, IEnumerable<TEntity> entities);
    public int UpdateRange(IDbTransaction transaction, IEnumerable<TEntity> entities);
    protected abstract int UpdateRange(Func<IDbCommand> commandActivator, IEnumerable<TEntity> entities);

    public int Delete(TEntity entity);
    public int Delete(IDbConnection connection, TEntity entity);
    public int Delete(IDbTransaction transaction, TEntity entity);
    protected abstract int Delete(Func<IDbCommand> commandActivator, TEntity entity);

    public int DeleteRange(IEnumerable<TEntity> entities);
    public int DeleteRange(IDbConnection connection, IEnumerable<TEntity> entities);
    public int DeleteRange(IDbTransaction transaction, IEnumerable<TEntity> entities);
    protected abstract int DeleteRange(Func<IDbCommand> commandActivator, IEnumerable<TEntity> entities);
}

DbReadWriteRepositoryWithUniqueKeyBase<TEntity, TPrimaryKey, TUniqueKey> クラス

  • IWriteDataRepository<TEntity> インターフェースの基本実装です。
  • DbReadRepositoryWithUniqueKeyBase<TEntity, TPrimaryKey, TUniqueKey> クラスを継承します。
  • リポジトリの各メソッドはオーバーロード構成になっています。
    • インターフェースのメソッドを実装しているメソッド
      • 新たなコネクションを生成して処理を実行します。アクティブな TransactionScope が存在しなければトランザクションを明示的に開始します。
    • コネクションを受け取るメソッド
      • 指定されたコネクションを使用して処理を実行します。トランザクションは開始しません。
    • トランザクションを受け取るメソッド
      • 指定されたトランザクションを使用して処理を実行します。
    • コマンドを実行する主処理を表す抽象メソッド
      • コマンドのインスタンスを生成し、コマンドテキストを組み立ててデータを抽出するように実装してください。
public abstract class DbReadWriteRepositoryWithUniqueKeyBase<TEntity, TPrimaryKey, TUniqueKey> : DbReadRepositoryWithUniqueKeyBase<TEntity, TPrimaryKey, TUniqueKey>, IWriteDataRepository<TEntity>
{
    public int Insert(TEntity entity);
    public int Insert(IDbConnection connection, TEntity entity);
    public int Insert(IDbTransaction transaction, TEntity entity);
    protected abstract int Insert(Func<IDbCommand> commandActivator, TEntity entity);

    public int InsertRange(IEnumerable<TEntity> entities);
    public int InsertRange(IDbConnection connection, IEnumerable<TEntity> entities);
    public int InsertRange(IDbTransaction transaction, IEnumerable<TEntity> entities);
    protected abstract int InsertRange(Func<IDbCommand> commandActivator, IEnumerable<TEntity> entities);

    public int Update(TEntity entity);
    public int Update(IDbConnection connection, TEntity entity);
    public int Update(IDbTransaction transaction, TEntity entity);
    protected abstract int Update(Func<IDbCommand> commandActivator, TEntity entity);

    public int UpdateRange(IEnumerable<TEntity> entities);
    public int UpdateRange(IDbConnection connection, IEnumerable<TEntity> entities);
    public int UpdateRange(IDbTransaction transaction, IEnumerable<TEntity> entities);
    protected abstract int UpdateRange(Func<IDbCommand> commandActivator, IEnumerable<TEntity> entities);

    public int Delete(TEntity entity);
    public int Delete(IDbConnection connection, TEntity entity);
    public int Delete(IDbTransaction transaction, TEntity entity);
    protected abstract int Delete(Func<IDbCommand> commandActivator, TEntity entity);

    public int DeleteRange(IEnumerable<TEntity> entities);
    public int DeleteRange(IDbConnection connection, IEnumerable<TEntity> entities);
    public int DeleteRange(IDbTransaction transaction, IEnumerable<TEntity> entities);
    protected abstract int DeleteRange(Func<IDbCommand> commandActivator, IEnumerable<TEntity> entities);
}

任意の型のコンテキストを使用するリポジトリ

DbRepositoryWithContextBase<TEntity, TContext> クラスを継承し、各リポジトリのインターフェースを実装しています。前述の基本形のリポジトリと異なるのは、新しいコネクションを生成する条件です。

  • コンテキストからトランザクションを取得できる場合、そのトランザクションを使用して処理を実行します。
  • コンテキストからコネクションを取得できる場合、そのコネクションを使用して処理を実行します。トランザクションは開始しません。
  • 上記以外の場合、新たなコネクションを生成して処理を実行します。アクティブな TransactionScope が存在しなければトランザクションを明示的に開始します。

DbReadRepositoryWithContextBase<TEntity, TKey, TContext> クラス

  • IReadDataRepositoryWithContext<TEntity, TKey, TContext> インターフェースの基本実装です。
  • DbRepositoryWithContextBase<TEntity, TContext> クラスを継承します。
  • リポジトリの各メソッドはオーバーロード構成になっています。
    • インターフェースのメソッドを実装しているメソッド
      • コンテキストからトランザクションを取得できる場合、そのトランザクションを使用して処理を実行します。
      • コンテキストからコネクションを取得できる場合、そのコネクションを使用して処理を実行します。トランザクションは開始しません。
      • 上記以外の場合、新たなコネクションを生成して処理を実行します。アクティブな TransactionScope が存在しなければトランザクションを明示的に開始します。
    • コネクションを受け取るメソッド
      • 指定されたコネクションを使用して処理を実行します。トランザクションは開始しません。
    • トランザクションを受け取るメソッド
      • 指定されたトランザクションを使用して処理を実行します。
    • コマンドを実行する主処理を表す抽象メソッド
      • コマンドのインスタンスを生成し、コマンドテキストを組み立ててデータを抽出するように実装してください。
public abstract class DbReadRepositoryWithContextBase<TEntity, TKey, TContext> : DbRepositoryWithContextBase<TEntity, TContext>, IReadDataRepositoryWithContext<TEntity, TKey, TContext>
    where TContext : IDataRepositoryContext
{
    public TEntity? Get(TKey key, TContext context);
    public TEntity? Get(IDbConnection connection, TKey key, TContext context);
    public TEntity? Get(IDbTransaction transaction, TKey key, TContext context);
    protected abstract TEntity? Get(Func<IDbCommand> commandActivator, TKey key, TContext context);

    public IEnumerable<TEntity> GetRange(IEnumerable<TKey> keys, TContext context);
    public IEnumerable<TEntity> GetRange(IDbConnection connection, IEnumerable<TKey> keys, TContext context);
    public IEnumerable<TEntity> GetRange(IDbTransaction transaction, IEnumerable<TKey> keys, TContext context);
    protected abstract IEnumerable<TEntity> GetRange(Func<IDbCommand> commandActivator, IEnumerable<TKey> keys, TContext context);

    public IEnumerable<TEntity> GetAll(TContext context);
    public IEnumerable<TEntity> GetAll(IDbConnection connection, TContext context);
    public IEnumerable<TEntity> GetAll(IDbTransaction transaction, TContext context);
    protected abstract IEnumerable<TEntity> GetAll(Func<IDbCommand> commandActivator, TContext context);

    public IEnumerable<TKey> GetAllKeys(TContext context);
    public IEnumerable<TKey> GetAllKeys(IDbConnection connection, TContext context);
    public IEnumerable<TKey> GetAllKeys(IDbTransaction transaction, TContext context);
    protected abstract IEnumerable<TKey> GetAllKeys(Func<IDbCommand> commandActivator, TContext context);
}

DbReadRepositoryWithUniqueKeyWithContextBase<TEntity, TPrimaryKey, TUniqueKey, TContext> クラス

  • IReadDataRepositoryWithUniqueKeyWithContext<TEntity, TPrimaryKey, TUniqueKey, TContext> インターフェースの基本実装です。
  • DbRepositoryWithContextBase<TEntity, TContext> クラスを継承します。
  • リポジトリの各メソッドはオーバーロード構成になっています。
    • インターフェースのメソッドを実装しているメソッド
      • コンテキストからトランザクションを取得できる場合、そのトランザクションを使用して処理を実行します。
      • コンテキストからコネクションを取得できる場合、そのコネクションを使用して処理を実行します。トランザクションは開始しません。
      • 上記以外の場合、新たなコネクションを生成して処理を実行します。アクティブな TransactionScope が存在しなければトランザクションを明示的に開始します。
    • コネクションを受け取るメソッド
      • 指定されたコネクションを使用して処理を実行します。トランザクションは開始しません。
    • トランザクションを受け取るメソッド
      • 指定されたトランザクションを使用して処理を実行します。
    • コマンドを実行する主処理を表す抽象メソッド
      • コマンドのインスタンスを生成し、コマンドテキストを組み立ててデータを抽出するように実装してください。
public abstract class DbReadRepositoryWithUniqueKeyWithContextBase<TEntity, TPrimaryKey, TUniqueKey, TContext> : DbRepositoryWithContextBase<TEntity, TContext>, IReadDataRepositoryWithUniqueKeyWithContext<TEntity, TPrimaryKey, TUniqueKey, TContext>
    where TContext : IDataRepositoryContext
{
    public TEntity? GetByPrimaryKey(TPrimaryKey primaryKey, TContext context);
    public TEntity? GetByPrimaryKey(IDbConnection connection, TPrimaryKey primaryKey, TContext context);
    public TEntity? GetByPrimaryKey(IDbTransaction transaction, TPrimaryKey primaryKey, TContext context);
    protected abstract TEntity? GetByPrimaryKey(Func<IDbCommand> commandActivator, TPrimaryKey primaryKey, TContext context);

    public TEntity? GetByUniqueKey(TUniqueKey uniqueKey, TContext context);
    public TEntity? GetByUniqueKey(IDbConnection connection, TUniqueKey uniqueKey, TContext context);
    public TEntity? GetByUniqueKey(IDbTransaction transaction, TUniqueKey uniqueKey, TContext context);
    protected abstract TEntity? GetByUniqueKey(Func<IDbCommand> commandActivator, TUniqueKey uniqueKey, TContext context);

    public IEnumerable<TEntity> GetRangeByPrimaryKey(IEnumerable<TPrimaryKey> primaryKeys, TContext context);
    public IEnumerable<TEntity> GetRangeByPrimaryKey(IDbConnection connection, IEnumerable<TPrimaryKey> primaryKeys, TContext context);
    public IEnumerable<TEntity> GetRangeByPrimaryKey(IDbTransaction transaction, IEnumerable<TPrimaryKey> primaryKeys, TContext context);
    protected abstract IEnumerable<TEntity> GetRangeByPrimaryKey(Func<IDbCommand> commandActivator, IEnumerable<TPrimaryKey> primaryKeys, TContext context);;

    public IEnumerable<TEntity> GetRangeByUniqueKey(IEnumerable<TUniqueKey> uniqueKeys, TContext context);
    public IEnumerable<TEntity> GetRangeByUniqueKey(IDbConnection connection, IEnumerable<TUniqueKey> uniqueKeys, TContext context);
    public IEnumerable<TEntity> GetRangeByUniqueKey(IDbTransaction transaction, IEnumerable<TUniqueKey> uniqueKeys, TContext context);
    protected abstract IEnumerable<TEntity> GetRangeByUniqueKey(Func<IDbCommand> commandActivator, IEnumerable<TUniqueKey> uniqueKeys, TContext context);

    public IEnumerable<TEntity> GetAll(TContext context);
    public IEnumerable<TEntity> GetAll(IDbConnection connection, TContext context);
    public IEnumerable<TEntity> GetAll(IDbTransaction transaction, TContext context);
    protected abstract IEnumerable<TEntity> GetAll(Func<IDbCommand> commandActivator, TContext context);

    public IEnumerable<TPrimaryKey> GetAllPrimaryKeys(TContext context);
    public IEnumerable<TPrimaryKey> GetAllPrimaryKeys(IDbConnection connection, TContext context);
    public IEnumerable<TPrimaryKey> GetAllPrimaryKeys(IDbTransaction transaction, TContext context);
    protected abstract IEnumerable<TPrimaryKey> GetAllPrimaryKeys(Func<IDbCommand> commandActivator, TContext context);

    public IEnumerable<TUniqueKey> GetAllUniqueKeys(TContext context);
    public IEnumerable<TUniqueKey> GetAllUniqueKeys(IDbConnection connection, TContext context);
    public IEnumerable<TUniqueKey> GetAllUniqueKeys(IDbTransaction transaction, TContext context);
    protected abstract IEnumerable<TUniqueKey> GetAllUniqueKeys(Func<IDbCommand> commandActivator, TContext context);
}

DbReadWriteRepositoryWithContextBase<TEntity, TKey, TContext> クラス

  • IWriteDataRepositoryWithContext<TEntity, TContext> インターフェースの基本実装です。
  • DbReadRepositoryWithContextBase<TEntity, TKey, TContext> クラスを継承します。
  • リポジトリの各メソッドはオーバーロード構成になっています。
    • インターフェースのメソッドを実装しているメソッド
      • コンテキストからトランザクションを取得できる場合、そのトランザクションを使用して処理を実行します。
      • コンテキストからコネクションを取得できる場合、そのコネクションを使用して処理を実行します。トランザクションは開始しません。
      • 上記以外の場合、新たなコネクションを生成して処理を実行します。アクティブな TransactionScope が存在しなければトランザクションを明示的に開始します。
    • コネクションを受け取るメソッド
      • 指定されたコネクションを使用して処理を実行します。トランザクションは開始しません。
    • トランザクションを受け取るメソッド
      • 指定されたトランザクションを使用して処理を実行します。
    • コマンドを実行する主処理を表す抽象メソッド
      • コマンドのインスタンスを生成し、コマンドテキストを組み立ててデータを抽出するように実装してください。
public abstract class DbReadWriteRepositoryWithContextBase<TEntity, TKey, TContext> : DbReadRepositoryWithContextBase<TEntity, TKey, TContext>, IWriteDataRepositoryWithContext<TEntity, TContext>
    where TContext : IDataRepositoryContext
{
    public int Insert(TEntity entity, TContext context);
    public int Insert(IDbConnection connection, TEntity entity, TContext context);
    public int Insert(IDbTransaction transaction, TEntity entity, TContext context);
    protected abstract int Insert(Func<IDbCommand> commandActivator, TEntity entity, TContext context);

    public int InsertRange(IEnumerable<TEntity> entities, TContext context);
    public int InsertRange(IDbConnection connection, IEnumerable<TEntity> entities, TContext context);
    public int InsertRange(IDbTransaction transaction, IEnumerable<TEntity> entities, TContext context);
    protected abstract int InsertRange(Func<IDbCommand> commandActivator, IEnumerable<TEntity> entities, TContext context);

    public int Update(TEntity entity, TContext context);
    public int Update(IDbConnection connection, TEntity entity, TContext context);
    public int Update(IDbTransaction transaction, TEntity entity, TContext context);
    protected abstract int Update(Func<IDbCommand> commandActivator, TEntity entity, TContext context);

    public int UpdateRange(IEnumerable<TEntity> entities, TContext context);
    public int UpdateRange(IDbConnection connection, IEnumerable<TEntity> entities, TContext context);
    public int UpdateRange(IDbTransaction transaction, IEnumerable<TEntity> entities, TContext context);
    protected abstract int UpdateRange(Func<IDbCommand> commandActivator, IEnumerable<TEntity> entities, TContext context);

    public int Delete(TEntity entity, TContext context);
    public int Delete(IDbConnection connection, TEntity entity, TContext context);
    public int Delete(IDbTransaction transaction, TEntity entity, TContext context);
    protected abstract int Delete(Func<IDbCommand> commandActivator, TEntity entity, TContext context);

    public int DeleteRange(IEnumerable<TEntity> entities, TContext context);
    public int DeleteRange(IDbConnection connection, IEnumerable<TEntity> entities, TContext context);
    public int DeleteRange(IDbTransaction transaction, IEnumerable<TEntity> entities, TContext context);
    protected abstract int DeleteRange(Func<IDbCommand> commandActivator, IEnumerable<TEntity> entities, TContext context);
}

DbReadWriteRepositoryWithUniqueKeyWithContextBase<TEntity, TPrimaryKey, TUniqueKey, TContext> クラス

  • IWriteDataRepositoryWithContext<TEntity, TContext> インターフェースの基本実装です。
  • DbReadRepositoryWithUniqueKeyWithContextBase<TEntity, TPrimaryKey, TUniqueKey, TContext> クラスを継承します。
  • リポジトリの各メソッドはオーバーロード構成になっています。
    • インターフェースのメソッドを実装しているメソッド
      • コンテキストからトランザクションを取得できる場合、そのトランザクションを使用して処理を実行します。
      • コンテキストからコネクションを取得できる場合、そのコネクションを使用して処理を実行します。トランザクションは開始しません。
      • 上記以外の場合、新たなコネクションを生成して処理を実行します。アクティブな TransactionScope が存在しなければトランザクションを明示的に開始します。
    • コネクションを受け取るメソッド
      • 指定されたコネクションを使用して処理を実行します。トランザクションは開始しません。
    • トランザクションを受け取るメソッド
      • 指定されたトランザクションを使用して処理を実行します。
    • コマンドを実行する主処理を表す抽象メソッド
      • コマンドのインスタンスを生成し、コマンドテキストを組み立ててデータを抽出するように実装してください。
public abstract class DbReadWriteRepositoryWithUniqueKeyWithContextBase<TEntity, TPrimaryKey, TUniqueKey, TContext> : DbReadRepositoryWithUniqueKeyWithContextBase<TEntity, TPrimaryKey, TUniqueKey, TContext>, IWriteDataRepositoryWithContext<TEntity, TContext>
    where TContext : IDataRepositoryContext
{
    public int Insert(TEntity entity, TContext context);
    public int Insert(IDbConnection connection, TEntity entity, TContext context);
    public int Insert(IDbTransaction transaction, TEntity entity, TContext context);
    protected abstract int Insert(Func<IDbCommand> commandActivator, TEntity entity, TContext context);

    public int InsertRange(IEnumerable<TEntity> entities, TContext context);
    public int InsertRange(IDbConnection connection, IEnumerable<TEntity> entities, TContext context);
    public int InsertRange(IDbTransaction transaction, IEnumerable<TEntity> entities, TContext context);
    protected abstract int InsertRange(Func<IDbCommand> commandActivator, IEnumerable<TEntity> entities, TContext context);

    public int Update(TEntity entity, TContext context);
    public int Update(IDbConnection connection, TEntity entity, TContext context);
    public int Update(IDbTransaction transaction, TEntity entity, TContext context);
    protected abstract int Update(Func<IDbCommand> commandActivator, TEntity entity, TContext context);

    public int UpdateRange(IEnumerable<TEntity> entities, TContext context);
    public int UpdateRange(IDbConnection connection, IEnumerable<TEntity> entities, TContext context);
    public int UpdateRange(IDbTransaction transaction, IEnumerable<TEntity> entities, TContext context);
    protected abstract int UpdateRange(Func<IDbCommand> commandActivator, IEnumerable<TEntity> entities, TContext context);

    public int Delete(TEntity entity, TContext context);
    public int Delete(IDbConnection connection, TEntity entity, TContext context);
    public int Delete(IDbTransaction transaction, TEntity entity, TContext context);
    protected abstract int Delete(Func<IDbCommand> commandActivator, TEntity entity, TContext context);;

    public int DeleteRange(IEnumerable<TEntity> entities, TContext context);
    public int DeleteRange(IDbConnection connection, IEnumerable<TEntity> entities, TContext context);
    public int DeleteRange(IDbTransaction transaction, IEnumerable<TEntity> entities, TContext context);
    protected abstract int DeleteRange(Func<IDbCommand> commandActivator, IEnumerable<TEntity> entities, TContext context);
}

おわりに

リポジトリパターンは過去にも作りかけていたものがあるのですが、型制約を強めに設計していたこともあり、汎用性を欠いていました。一から再設計した結果、ほど良いバランスになったのではないかと思います。制約や規約を前提としたリポジトリが必要になった場合はこれらの基底クラスを継承すればよさそうです。

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?