ASP.NET Core 2.1ではDapperによるデータ検索

もしあなたがオリジナルのSql文が好きで、ORMの簡単さが好きならば、あなたはきっとDapperというデータアクセスコンポーネントが好きになります.
始めましょう、dapperをインストールします.

$ dotnet add package dapper

ここにorgという時計があります.depart(部門表)は、部門コード、部門名などを含み、ここではクラスDepartを用いてマッピングする

まずクラスDepartを作成します

    public class Depart
    {
        public int recid { get; set; }
        public string deptid { get; set; }
        public string deptname { get; set; }
        public int ref_id { get; set; }
        public DateTime established { get; set; }
        public DateTime create_date { get; set; }
        public string create_by { get; set; }
        public DateTime update_date { get; set; }
        public string update_by { get; set; }
    }

次に、DepartRepositoryという名前のRepositoryを作成し、インプリメンテーションを作成する前にインタフェースIDepartRepositoryを作成する必要があります.Netcoreの依存注入をインスタンス化する.

public interface IDepartRepository {
    Task  GetDepartByID(int recid);

    Task > GetDepartList(string keyword, int ref_id, int currentPage, int pageSize);

    Task  AddDepart(Depart depart);

    Task  UpdateDepart(int recid, Depart depart);

    bool DeleteDepart(int recid);
}

ここではasync実装の方法が多いことに気づいたかもしれませんが、Task<>を使用しています.詳しくはこちらをご覧ください

次に簡単な実装例を示します

public class DepartRepository : IDepartRepository
{        
        public async Task AddDepart(Depart depart)
        {   
           
        }
         
        public async Task> GetDepartList(string keyword, int ref_id, int currentPage, int pageSize)
        {
            
            
            
        }
        
}

Startupを更新する必要があります.cs、新しく作成したDepartRepositoryをサービス層に注入

public class Startup
{
    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public IConfiguration Configuration { get; }

    public void ConfigureServices(IServiceCollection services)
    {
        //       
        services.AddTransient();

   services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
    }

    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        //...
    }
}

注入IConfiguration

普通Netcoreの構成はappSettingsに保存する.jsonファイル

{
  "Logging": {
    "LogLevel": {
      "Default": "Debug",
      "System": "Information",
      "Microsoft": "Information"
    }
  },
  "ConnectionStrings": {
    "MyConnectionString": "MyConnectionString"
  }
}

問題は、Dapper用に接続文字列をDepartRepositoryに渡す方法です.NetcoreはIConfigurationクラスを導入し,他のクラスに注入できる.この注入の例は、接続文字列を得ることができるGetConnectionStringの方法を含む.次の例を見てみましょう

public class DepartRepository : IDepartRepository
{  
    private readonly IConfiguration _config;

    public DepartRepository(IConfiguration config)
    {
        _config = config;
    }
    
    
}

上記の例では、構造注入方式を採用している.

SqlConnectionの作成

public class DepartRepository : IDepartRepository
{
    private readonly IConfiguration _config;

    public DepartRepository(IConfiguration config)
    {
        _config = config;
    }

    public IDbConnection Connection
    {
        get
        {
            return new SqlConnection(_config.GetConnectionString("MyConnectionString"));
        }
    }
    
}

部門メソッドの追加

public class DepartRepository : IDepartRepository
{
    public async Task AddDepart(Depart depart)
        {   
            using (IDbConnection conn = Connection)
          {
            string sql = "insert into org_depart(deptid,deptname,ref_id,established,create_date,create_by,update_date,update_by) ";
            sql += "VALUES (@deptid,@deptname,@ref_id,@established,@create_date,@create_by,@update_date,@update_by); ";
            sql += "SELECT CAST(SCOPE_IDENTITY() AS INT)";
            var id = await conn.QueryAsync(sql, depart);
            return  id.Single();
          }
      }
}

リストクエリの実装

public class DepartRepository: IDepartRepository {
    public async Task < PagedList < Depart >> GetDepartList(int currentPage, int pageSize) {
        using(IDbConnection conn = Connection) {

            string sql = "select * from org_depart where 1 = 1 ";

            int offset = pageSize * (currentPage - 1);

            sql = sql + " order by recid offset " + offset + " rows fetch next " + pageSize + " rows only";

            string sql_count = "select count(*) as c from org_depart where 1 = 1 ";

            int total = await conn.ExecuteScalarAsync < int > (sql_count);

            var items = await conn.QueryAsync < Depart > (sql);

            PagedList < Depart > result = new PagedList < Depart > (items.ToArray(), total);

            return result;
        }
    }
}

インプリメンテーションコントローラ

最後にコントローラを作成し、DepartRepositoryを注入します.

[Route("api/[controller]")]
[ApiController] 
public class DepartController: ControllerBase {
        private readonly IDepartRepository _departRepo;
        public DepartController(IDepartRepository departRepo) {
          _departRepo = departRepo;
       } 
    
        [Route("AddDepart")]
        [HttpPost]
         public async Task < ApiResult > AddDepart(Depart model) {
        if (!ModelState.IsValid) {
            return ApiResultUtil.Fail("     !");
        }
        try {
            var result = await _departRepo.AddDepart(model);

            if (result > 0) {
                return ApiResultUtil.Success < int > (result);
            } else {
                return ApiResultUtil.Fail("      ！");
            }

        } catch(Exception ex) {
            return ApiResultUtil.Fail("      ！");
        }
      }
}

Githubのサンプル
以下から抜粋:https://exceptionnotfound.net/using-dapper-asynchronously-in-asp-net-core-2-1/