C#-Dapper使用教程与原理详解

原创

Damon小智

发布于 2024-07-29 15:06:33

1770

发布于 2024-07-29 15:06:33

文章被收录于专栏：全栈文档库

本文详细介绍了Dapper在C#中的使用方法，包括Dapper的基本概念、与其他持久层框架的比较、基本语法和高级语法的使用，并通过实例讲解了如何在项目中集成和使用Dapper。Dapper以其高效的性能和简洁的API受到开发者的青睐，适用于各种数据库操作需求。本文还将深入探讨Dapper的核心原理，通过内部代码展示其工作机制。最后，总结了Dapper的优缺点及其在实际开发中的应用场景，为开发者提供全面的指导。

一、Dapper介绍

1. Dapper介绍

Dapper是一个轻量级的ORM（对象关系映射）框架，专为.NET设计。它通过扩展IDbConnection接口，使开发者能够方便地执行SQL查询，并将查询结果映射到对象模型中。

2. Dapper原理解析

Dapper的核心原理是通过扩展方法来简化数据访问过程。它的主要工作流程如下：

建立数据库连接：使用ADO.NET的IDbConnection接口建立数据库连接。
执行SQL查询：通过Dapper提供的扩展方法（如Query、Execute等）执行SQL查询。
映射结果集：将查询结果集映射到C#对象模型中，简化数据处理。

Dapper的性能优势主要来源于以下几个方面：

轻量级：Dapper没有复杂的上下文管理和变化跟踪机制，减少了性能开销。
直接执行SQL：Dapper直接执行原生SQL查询，避免了复杂的查询生成过程。
缓存查询计划：Dapper会缓存查询计划，减少SQL解析和执行的开销。

3. Dapper和其他操作数据库的框架比较

为了更清晰地展示Dapper与其他数据库操作框架的比较，以下通过表格进行说明：

特性	Dapper	Entity Framework	NHibernate	ADO.NET
性能	高	中等	中等	高
易用性	高	高	中等	低
映射能力	基本映射	丰富	丰富	无
学习曲线	低	中等	高	低
事务支持	支持	支持	支持	支持
LINQ支持	不支持	支持	支持	不支持
配置灵活性	高	中等	高	高

二、Dapper的基本语法

Dapper提供了多种方法来简化数据库操作。以下是一些常用的基本语法及其示例代码：

1. 查询数据

Dapper使用Query方法执行SQL查询并返回结果集。

using (IDbConnection db = new SqlConnection(connectionString))
{
    string sql = "SELECT * FROM Students";
    var students = db.Query<Student>(sql).ToList();
}

2. 插入数据

Dapper使用Execute方法执行插入操作。

using (IDbConnection db = new SqlConnection(connectionString))
{
    string sql = "INSERT INTO Students (Name, Age) VALUES (@Name, @Age)";
    var result = db.Execute(sql, new { Name = "John", Age = 22 });
}

3. 更新数据

Dapper使用Execute方法执行更新操作。

using (IDbConnection db = new SqlConnection(connectionString))
{
    string sql = "UPDATE Students SET Name = @Name, Age = @Age WHERE Id = @Id";
    var result = db.Execute(sql, new { Name = "John", Age = 23, Id = 1 });
}

4. 删除数据

Dapper使用Execute方法执行删除操作。

using (IDbConnection db = new SqlConnection(connectionString))
{
    string sql = "DELETE FROM Students WHERE Id = @Id";
    var result = db.Execute(sql, new { Id = 1 });
}

5. 存储过程

Dapper可以轻松调用存储过程。

using (IDbConnection db = new SqlConnection(connectionString))
{
    var result = db.Query<Student>("GetStudentById", new { Id = 1 }, commandType: CommandType.StoredProcedure).FirstOrDefault();
}

三、Dapper的高级功能

Dapper除了基本的CRUD操作外，还提供了一些高级功能，以满足复杂的数据库操作需求。

1. 多映射

Dapper支持多表查询并将结果映射到多个对象。

string sql = "SELECT * FROM Students s INNER JOIN Classes c ON s.ClassId = c.Id";
var studentDictionary = new Dictionary<int, Student>();

using (IDbConnection db = new SqlConnection(connectionString))
{
    var students = db.Query<Student, Class, Student>(sql, (student, @class) => {
        student.Class = @class;
        return student;
    }, splitOn: "Id").Distinct().ToList();
}

2. 参数化查询

Dapper支持参数化查询，有效防止SQL注入。

using (IDbConnection db = new SqlConnection(connectionString))
{
    string sql = "SELECT * FROM Students WHERE Age > @Age";
    var students = db.Query<Student>(sql, new { Age = 20 }).ToList();
}

3. 事务处理

Dapper支持数据库事务，确保数据操作的一致性。

using (IDbConnection db = new SqlConnection(connectionString))
{
    db.Open();
    using (var transaction = db.BeginTransaction())
    {
        string insertSql = "INSERT INTO Students (Name, Age) VALUES (@Name, @Age)";
        db.Execute(insertSql, new { Name = "John", Age = 22 }, transaction);

        string updateSql = "UPDATE Students SET Age = @Age WHERE Name = @Name";
        db.Execute(updateSql, new { Age = 23, Name = "John" }, transaction);

        transaction.Commit();
    }
}

4. 批量操作

Dapper可以高效地进行批量操作。

using (IDbConnection db = new SqlConnection(connectionString))
{
    string sql = "INSERT INTO Students (Name, Age) VALUES (@Name, @Age)";
    var students = new List<Student>
    {
        new Student { Name = "John", Age = 22 },
        new Student { Name = "Jane", Age = 24 },
        new Student { Name = "Mark", Age = 26 }
    };
    db.Execute(sql, students);
}

5. 动态对象

Dapper支持动态对象，适用于不确定返回结构的查询。

using (IDbConnection db = new SqlConnection(connectionString))
{
    string sql = "SELECT * FROM Students";
    var students = db.Query<dynamic>(sql).ToList();
    foreach (var student in students)
    {
        Console.WriteLine($"{student.Name} - {student.Age}");
    }
}

6. 缓存功能

Dapper内置简单的缓存功能，可以提高查询性能。

using (IDbConnection db = new SqlConnection(connectionString))
{
    string sql = "SELECT * FROM Students";
    var students = db.Query<Student>(sql, buffered: true).ToList();
}

四、Dapper使用总结

Dapper作为一个轻量级的ORM框架，在性能和易用性之间找到了平衡点。它适合于需要高效数据访问的应用场景，尤其是在已有数据库项目中快速集成和使用。

Dapper的优势在于其高性能、简单易用和灵活性。它直接执行SQL查询，性能接近手写ADO.NET，且API简洁明了，易于上手。同时，Dapper不需要复杂的配置，适合快速集成和使用。

然而，Dapper也有其局限性。它不支持复杂的对象关系映射，不提供LINQ支持，不适合复杂的业务逻辑处理场景。因此，在选择使用Dapper时，需要根据具体项目需求进行权衡。

优势总结

优势	描述
高性能	直接执行SQL查询，性能接近手写ADO.NET
简单易用	API简洁明了，易于上手
轻量级	不需要复杂的配置，适合快速集成
参数化查询	有效防止SQL注入
支持事务处理	确保数据操作的一致性
灵活性	允许开发者完全控制SQL语句，实现更复杂的查询逻辑