Dapper(Common) 使用指南

Dapper(Common) 使用指南

1. 项目介绍

Dapper.Common 是一个基于业界知名的 ORM 工具 Dapper 的扩展库，旨在简化 .NET 开发中的数据访问层操作。它遵循 LINQ 查询语法，允许开发人员以链式调用的方式编写更加优雅和直观的数据库交互代码。此扩展特别强调了上手速度、简洁性以及对 MySQL 和 SQL Server 数据库的支持，尽管其当前主要针对这两种数据库，但设计上便于拓展至其他数据库系统。Dapper.Common 还提供了对单表操作、多表联合查询及自定义函数的强大支持，并通过注解如 [Column] 来处理复杂的字段映射逻辑。

2. 项目快速启动

要快速启动使用 Dapper.Common，首先确保你的项目环境已准备好 .NET Core 或者 .NET Framework，并且能够安装 NuGet 包。

安装 Dapper.Common

打开 Package Manager Console 并执行以下命令来安装 Dapper.Common：

Install-Package Dapper.Common -Version 1.5.0

示例代码

接下来，在你的代码中引入必要的命名空间，并进行一次简单的查询示例：

using Dapper.Common;
using System.Data.SqlClient;

public class UserRepository
{
    private readonly string _connectionString;

    public UserRepository(string connectionString)
    {
        _connectionString = connectionString;
    }

    public User GetCurrentUser(int id)
    {
        using (var connection = new SqlConnection(_connectionString))
        {
            connection.Open();
            
            // 示例查询，假设User类已经定义并正确映射
            return connection.QueryFirstOrDefault<User>(@"
                SELECT * FROM Users WHERE Id = @Id", 
                new { Id = id });
        }
    }
}

请注意，这里的代码仅展示了如何使用 Dapper 和 Dapper.Common的基本查询，实际应用中，利用 Lambda 表达式进行更复杂操作的能力更强。

3. 应用案例和最佳实践

映射实体字段

利用 [Column] 特性可以定义字段与数据库列的映射关系，比如标识主键、自动增长字段等：

public class User
{
    [Column(name: "id", key: ColumnKey.Primary, isIdentity: true)]
    public int Id { get; set; }
    
    [Column(name: "nick_name")]
    public string NickName { get; set; }
}

链式查询

利用 Dapper.Common 的链式方法来构建复杂查询，提升可读性和代码的维护性。

var query = new MysqlQuery<User>()
    .Where(u => u.NickName == "ExampleName")
    .OrderByDescending(u => u.Id)
    .Single();

string sql = query.BuildSelect(); // 获取构建好的 SQL 语句

4. 典型生态项目

虽然直接的“典型生态项目”提及不多，但使用 Dapper 和其扩展（包括 Dapper.Common）的项目广泛存在于各种 .NET 应用场景中，特别是在那些需要高性能数据访问且希望保持代码简洁性的场合。例如，Web 应用后台、微服务架构的数据访问层、以及需要大量数据处理的批处理任务中，Dapper 和它的扩展们展现了它们的灵活性和效率。

---

以上就是关于 Dapper.Common 快速上手和基本使用的简要说明。深入实践时，建议详细查阅其官方文档或源码，以便充分利用其所有特性和优化你的应用程序数据访问层。