Dapper官方文档(三)【方法之Query】

r囧r小猫 2021-07-05 01:45 525阅读 0赞

## 描述 ##

`Query`是一个可以从`IDbConnection`类型的任意对象调用的扩展方法，它可以执行查询并映射结果。

结果可以映射到：

*  匿名类型
 *  强类型
 *  多映射（一对一）
 *  多映射（一对多）
 *  多类型

### 参数 ###

下表显示了`Query`方法的不同参数。

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>sql</td> 
   <td>要执行的查询。</td> 
  </tr> 
  <tr> 
   <td>param</td> 
   <td>查询参数（默认为<code>null</code>）。</td> 
  </tr> 
  <tr> 
   <td>transaction</td> 
   <td>需要使用的事务（默认为<code>null</code>）。</td> 
  </tr> 
  <tr> 
   <td>buffered</td> 
   <td>是否从缓冲读取查询结果（默认为<code>true</code>）。</td> 
  </tr> 
  <tr> 
   <td>commandTimeout</td> 
   <td>命令执行超时时间（默认为<code>null</code>）。</td> 
  </tr> 
  <tr> 
   <td>commandType</td> 
   <td>命令类型（默认为<code>null</code>）。</td> 
  </tr> 
 </tbody> 
</table>

## 案例 - 查询匿名类型 ##

原生SQL查询可以使用`Query`方法执行，并将结果映射到动态类型列表。

string sql = "SELECT * FROM Invoice;";
    
    using (var connection = My.ConnectionFactory())
    { 
        connection.Open();
    
        var invoices = connection.Query(sql).ToList();
        
        My.Result.Show(invoices);
        
        //输出：3 anonymous entity returned
    }

## 案例 - 查询强类型 ##

原生SQL查询可以使用`Query`方法执行，并将结果映射到强类型列表。

string sql = "SELECT * FROM Invoice;";
    
    using (var connection = My.ConnectionFactory())
    { 
        connection.Open();
    
        var invoices = connection.Query<Invoice>(sql).ToList();
        
        My.Result.Show(invoices);
        
        //输出：3 invoice(s) returned
    }

## 案例 - 查询多映射（一对一） ##

原生SQL查询可以使用`Query`方法执行，并将结果映射到具有一对一关系的强类型列表。

string sql = "SELECT * FROM Invoice AS A INNER JOIN InvoiceDetail AS B ON A.InvoiceID = B.InvoiceID;";
    
    using (var connection = My.ConnectionFactory())
    { 
        connection.Open();
    
        var invoices = connection.Query<Invoice, InvoiceDetail, Invoice>(
                sql,
                (invoice, invoiceDetail) =>
                { 
                    invoice.InvoiceDetail = invoiceDetail;
                    return invoice;
                },
                splitOn: "InvoiceID")
            .Distinct()
            .ToList();
            
        My.Result.Show(invoices);
        
        //输出：3 invoice(s) returned (Including InvoiceDetail information) 
    }

## 案例 - 查询多映射（一对多） ##

原生SQL查询可以使用`Query`方法执行，并将结果映射到具有一对多关系的强类型列表。

string sql = "SELECT * FROM Invoice AS A INNER JOIN InvoiceItem AS B ON A.InvoiceID = B.InvoiceID;";
    
    using (var connection = My.ConnectionFactory())
    { 
        connection.Open();
    
        var invoiceDictionary = new Dictionary<int, Invoice>();
    
        var invoices = connection.Query<Invoice, InvoiceItem, Invoice>(
                sql,
                (invoice, invoiceItem) =>
                { 
                    Invoice invoiceEntry;
                    
                    if (!invoiceDictionary.TryGetValue(invoice.InvoiceID, out invoiceEntry))
                    { 
                        invoiceEntry = invoice;
                        invoiceEntry.Items = new List<InvoiceItem>();
                        invoiceDictionary.Add(invoiceEntry.InvoiceID, invoiceEntry);
                    }
    
                    invoiceEntry.Items.Add(invoiceItem);
                    return invoiceEntry;
                },
                splitOn: "InvoiceID")
            .Distinct()
            .ToList();
            
        My.Result.Show(invoices);
        
        //输出：3 invoice(s) returned (Including 6 InvoiceItem) 
    }

## 案例 - 查询多类型 ##

原生SQL查询可以使用`Query`方法执行，并将结果映射到不同类型的列表。

string sql = "SELECT * FROM Invoice;";
    
    using (var connection = My.ConnectionFactory())
    { 
        connection.Open();
    
        var invoices = new List<Invoice>();
    
        using (var reader = connection.ExecuteReader(sql))
        { 
            var storeInvoiceParser = reader.GetRowParser<StoreInvoice>();
            var webInvoiceParser = reader.GetRowParser<WebInvoice>();
    
            while (reader.Read())
            { 
                Invoice invoice;
    
                switch ((InvoiceKind) reader.GetInt32(reader.GetOrdinal("Kind")))
                { 
                    case InvoiceKind.StoreInvoice:
                        invoice = storeInvoiceParser(reader);
                        break;
                    case InvoiceKind.WebInvoice:
                        invoice = webInvoiceParser(reader);
                        break;
                    default:
                        throw new Exception(ExceptionMessage.GeneralException);
                }
    
                invoices.Add(invoice);
            }
        }
        
        My.Result.Show(invoices); 
        
        //输出：3 invoice(s) returned (StoreInvoice:1, WebInvoice:2) 
    }