Dapper 微型orm的光

介绍

Dapper是一个轻量级的ORM（对象关系映射）框架，它可以方便地将数据库查询结果映射到.NET对象上，同时也支持执行原生SQL查询。下面我将详细介绍Dapper的使用方法。

安装Dapper

首先，你需要通过NuGet包管理器将Dapper添加到你的项目中。你可以在Visual Studio中的NuGet包管理器控制台中运行以下命令来添加Dapper：

Install-Package Dapper

创建数据库连接

在使用Dapper之前，你需要创建数据库连接。可以使用.NET Core中的任何数据库提供程序来创建连接对象。例如，对于SQL Server数据库，可以使用SqlConnection类来创建连接对象：

using System.Data.SqlClient;

var connectionString = "your_connection_string";
using (var connection = new SqlConnection(connectionString))
{
    // 在此处使用Dapper
}

请确保将上述代码中的your_connection_string替换为你的数据库连接字符串。

查询数据

使用Dapper进行数据库查询非常简洁方便。以下是一些查询数据的示例：

1. Query方法：执行数据库查询，并将结果映射到.NET对象的集合中。

var sql = "SELECT * FROM Customers";
var customers = connection.Query<Customer>(sql).ToList();

// 异步版本
var asyncCustomers = await connection.QueryAsync<Customer>(sql);

2. QueryFirstOrDefault方法：执行数据库查询，并将结果的第一行映射到.NET对象。

var sql = "SELECT * FROM Customers WHERE Id = @id";
var customer = connection.QueryFirstOrDefault<Customer>(sql, new { id = 1 });

// 异步版本
var asyncCustomer = await connection.QueryFirstOrDefaultAsync<Customer>(sql, new { id = 1 });

3. QuerySingleOrDefault方法：执行数据库查询，并将结果的单行映射到.NET对象。如果结果集不唯一，则抛出异常。

var sql = "SELECT * FROM Customers WHERE Email = @email";
var customer = connection.QuerySingleOrDefault<Customer>(sql, new { email = "test@example.com" });

// 异步版本
var asyncCustomer = await connection.QuerySingleOrDefaultAsync<Customer>(sql, new { email = "test@example.com" });

4. Execute方法：执行数据库操作，例如插入、更新或删除记录。

var sql = "INSERT INTO Customers (Name, Email) VALUES (@Name, @Email)";
var parameters = new { Name = "John Doe", Email = "johndoe@example.com" };
connection.Execute(sql, parameters);

// 异步版本
await connection.ExecuteAsync(sql, parameters);

5. ExecuteScalar方法：执行数据库查询，并返回结果的第一行第一列的值。

var sql = "SELECT COUNT(*) FROM Customers";
var count = connection.ExecuteScalar<int>(sql);

// 异步版本
var asyncCount = await connection.ExecuteScalarAsync<int>(sql);

6. QueryMultiple方法：执行多个查询语句，并将结果存储在SqlMapper.GridReader对象中。

var sql = "SELECT * FROM Customers; SELECT * FROM Orders";
using (var multi = connection.QueryMultiple(sql))
{
    var customers = multi.Read<Customer>().ToList();
    var orders = multi.Read<Order>().ToList();
}

// 异步版本
var multi = await connection.QueryMultipleAsync(sql);
var customers = multi.Read<Customer>().ToList();
var orders = multi.Read<Order>().ToList();

这些示例展示了Dapper常用方法以及它们的异步版本的使用情况。异步方法可以更好地支持并发操作，提高应用程序的性能。

这里的Customer是一个自定义的实体类，用于映射数据库中的表结构。Query方法将会自动执行SQL查询，并将结果映射到Customer对象的集合中。

如果你需要使用参数化查询，可以使用Query方法的第二个参数来传递查询参数：

var sql = "SELECT * FROM Customers WHERE Age > @age";
var parameters = new { age = 18 };
var customers = connection.Query<Customer>(sql, parameters).ToList();

插入记录

var sql = "INSERT INTO Customers (Name, Email) VALUES (@Name, @Email)";
var parameters = new { Name = "John Doe", Email = "johndoe@example.com" };
connection.Execute(sql, parameters);

更新记录

var sql = "UPDATE Customers SET Email = @Email WHERE Id = @Id";
var parameters = new { Email = "newemail@example.com", Id = 1 };
connection.Execute(sql, parameters);

删除记录

var sql = "DELETE FROM Customers WHERE Id = @Id";
var parameters = new { Id = 1 };
connection.Execute(sql, parameters);

通过使用Execute方法，你可以执行任何对数据库的增加、删除和修改操作，只需提供相应的SQL语句和参数即可。

当然，你也可以使用其他方法来执行上述操作，例如使用ExecuteScalar方法获取插入操作的自增长ID，或者使用QueryFirstOrDefault方法来检查是否成功执行了修改操作等。

执行操作

除了查询数据，Dapper也支持执行数据库操作，例如插入、更新或删除记录。以下是一些示例：

var sql = "INSERT INTO Customers (Name, Email) VALUES (@Name, @Email)";
var parameters = new { Name = "John Doe", Email = "johndoe@example.com" };
connection.Execute(sql, parameters);

在上述示例中，我们执行了一个插入操作，将新的顾客记录插入到数据库中。

存储过程

如果你需要执行存储过程，Dapper也提供了相应的支持。以下是一个示例：

var parameters = new DynamicParameters();
parameters.Add("@productId", 1);
parameters.Add("@quantity", 10, DbType.Int32, ParameterDirection.InputOutput);

connection.Execute("UpdateStock", parameters, commandType: CommandType.StoredProcedure);

var updatedQuantity = parameters.Get<int>("@quantity");

在上述示例中，我们通过DynamicParameters类创建了存储过程的参数。然后，通过Execute方法执行了存储过程。在存储过程执行后，我们可以通过Get方法获取输出参数的值。

事务

当在Dapper中执行多个数据库操作时，你可以使用事务来保证这些操作要么全部成功，要么全部回滚。Dapper提供了简单且灵活的方式来处理事务。

下面是一个使用Dapper执行事务的示例：

using (var connection = new SqlConnection(connectionString))
{
    connection.Open(); // 事务开启

    using (var transaction = connection.BeginTransaction())
    {
        try
        {
            var insertSql = "INSERT INTO Customers (Name, Email) VALUES (@Name, @Email)";
            var updateSql = "UPDATE Orders SET Status = @Status WHERE CustomerId = @CustomerId";

            var insertParameters = new { Name = "John Doe", Email = "johndoe@example.com" };
            var updateParameters = new { Status = "Completed", CustomerId = 1 };

            connection.Execute(insertSql, insertParameters, transaction);
            connection.Execute(updateSql, updateParameters, transaction);

            transaction.Commit(); // 事务提交
        }
        catch
        {
            transaction.Rollback(); // 事务回滚
            throw;
        }
    }
}

在这个示例中，我们首先创建了一个SqlConnection对象，并打开连接。然后，我们使用BeginTransaction方法开始一个事务。

在事务内部，我们可以执行任意数量的数据库操作。在本例中，我们执行了一个插入操作和一个更新操作。每个操作都使用Execute方法在同一个事务中执行，并传递了transaction参数。

如果所有的操作都成功执行，我们调用Commit方法提交事务。如果在任何操作期间出现错误，我们使用Rollback方法回滚事务，并重新抛出异常。

通过使用事务，你可以确保在执行一系列数据库操作时保持数据的一致性和完整性。

请注意，在上述示例中，我们使用了SqlConnection和SqlTransaction类，这是因为Dapper使用ADO.NET提供程序作为底层数据库访问。因此，你仍然可以通过Dapper使用事务处理。