Dapper.SimpleCRUD 技术文档

本文档将详细介绍如何安装、使用和操作 Dapper.SimpleCRUD 项目。以下是本文档的主要内容：

1. 安装指南

Dapper.SimpleCRUD 可以通过 NuGet 包管理器进行安装。在 Visual Studio 中，打开 NuGet 包管理器并搜索 Dapper.SimpleCRUD。安装后，你将能够在项目中使用 Dapper.SimpleCRUD 的功能。

安装命令如下：

Install-Package Dapper.SimpleCRUD

2. 项目的使用说明

Dapper.SimpleCRUD 是一个单文件扩展，可以扩展 IDbConnection 接口。该扩展提供了以下 CRUD 操作的辅助方法：

• Get<T>(this IDbConnection connection, int id)：根据主键获取一条记录。
• GetList<T>(this IDbConnection connection)：获取表中的所有记录。
• GetList<T>(this IDbConnection connection, object whereConditions)：根据条件获取记录列表。
• GetList<T>(this IDbConnection connection, string conditions, object parameters = null)：根据 SQL 条件获取记录列表。
• GetListPaged<T>(this IDbConnection connection, int pageNumber, int rowsPerPage, string conditions, string orderby, object parameters = null)：根据条件分页获取记录列表。
• Insert(entity)：插入一条记录并返回新的主键。
• Update(entity)：更新一条记录。
• Delete<T>(id)：根据主键删除一条记录。
• Delete(entity)：根据实体删除一条记录。
• DeleteList<T>(object whereConditions)：根据条件删除记录列表。
• DeleteList<T>(string conditions, object parameters = null)：根据 SQL 条件删除记录列表。
• RecordCount<T>(string conditions, object parameters = null)：根据条件获取记录数量。

以下是基本使用示例：

public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
    public int Age { get; set; }
}

var user = connection.Get<User>(1);

这将执行以下 SQL 语句：

Select Id, Name, Age from [User] where Id = 1

3. 项目 API 使用文档

以下是 Dapper.SimpleCRUD 的一些主要 API 方法及其用途：

• Get<T>(this IDbConnection connection, int id)：根据主键获取一条记录。
• GetList<T>(this IDbConnection connection)：获取表中的所有记录。
• GetList<T>(this IDbConnection connection, object whereConditions)：根据条件获取记录列表。
• GetList<T>(this IDbConnection connection, string conditions, object parameters = null)：根据 SQL 条件获取记录列表。
• GetListPaged<T>(this IDbConnection connection, int pageNumber, int rowsPerPage, string conditions, string orderby, object parameters = null)：根据条件分页获取记录列表。
• Insert(entity)：插入一条记录并返回新的主键。
• Update(entity)：更新一条记录。
• Delete<T>(id)：根据主键删除一条记录。
• Delete(entity)：根据实体删除一条记录。
• DeleteList<T>(object whereConditions)：根据条件删除记录列表。
• DeleteList<T>(string conditions, object parameters = null)：根据 SQL 条件删除记录列表。
• RecordCount<T>(string conditions, object parameters = null)：根据条件获取记录数量。

4. 项目安装方式

Dapper.SimpleCRUD 可以通过以下方式安装：

• 在 Visual Studio 中使用 NuGet 包管理器搜索 Dapper.SimpleCRUD 并安装。
• 使用 NuGet 命令行工具：

Install-Package Dapper.SimpleCRUD

安装后，你可以在项目中使用 Dapper.SimpleCRUD 的功能。