【C#】SqlSugar：轻量、高效、灵活的 .NET ORM 框架

SqlSugar 是一个功能强大、使用简单的 .NET ORM（对象关系映射）框架。作为一个开源的 ORM 框架，SqlSugar 提供了与数据库交互的高效解决方案，支持各种数据库如 SQL Server、MySQL、Oracle、SQLite、PostgreSQL 等。它具有强大的查询功能、丰富的表达式支持，以及轻量级的特性，深受 .NET 开发者的青睐。

本文将详细介绍 SqlSugar 的功能、优势以及如何在 .NET 项目中使用它，并提供一些常用的示例代码，帮助开发者快速上手。

💯 SqlSugar 的主要特点

1. 多数据库支持

SqlSugar 支持多种主流数据库，包括 SQL Server、MySQL、SQLite、Oracle 和 PostgreSQL。这使得它非常适合需要跨平台、跨数据库开发的项目。通过 SqlSugar，开发者可以轻松地在不同数据库之间迁移而无需改动大量代码。

2. 链式操作和表达式支持

SqlSugar 提供了类似于 LINQ 的查询语法，支持链式操作和表达式树。开发者可以使用简洁的链式方法来构建查询、更新和插入操作，使代码更具可读性和可维护性。

3. 高效的性能

SqlSugar 的底层实现经过精心优化，能够处理大数据量的查询和复杂的 SQL 操作，同时保持较高的性能。相较于其他 ORM，SqlSugar 提供了更轻量化的性能表现，并在并发查询、批量操作等方面表现优异。

4. 代码优雅且简单

SqlSugar 致力于简化开发，避免了繁琐的 SQL 编写。其 API 设计直观，开发者可以通过简单易用的接口实现复杂的数据查询和操作。同时，它还支持生成 SQL 语句，便于开发者调试和优化查询。

5. 丰富的扩展功能

除了基本的 CRUD 操作，SqlSugar 还支持复杂的功能，如分页查询、事务管理、代码生成器、主从库分离、自动映射等。这些功能能够满足不同类型项目的需求，特别适合数据驱动的企业应用开发。

💯 如何在项目中使用 SqlSugar

1. 安装 SqlSugar

在开始使用 SqlSugar 之前，需要将其添加到 .NET 项目中。你可以通过 NuGet 包管理器来安装 SqlSugar：

Install-Package SqlSugar

2. 基础配置

在项目中，首先需要配置数据库连接。你可以通过 SqlSugarClient 类来初始化数据库连接。以下是一个简单的数据库配置示例：

using SqlSugar;

public class DbContext
{
    // SqlSugar 客户端
    public SqlSugarClient Db;

    public DbContext()
    {
        // 初始化数据库连接
        Db = new SqlSugarClient(new ConnectionConfig()
        {
            ConnectionString = "Server=.;Database=MyDb;Uid=myuser;Pwd=mypassword;",
            DbType = DbType.SqlServer,  // 指定数据库类型
            IsAutoCloseConnection = true // 自动关闭连接
        });

        // 控制台输出 SQL 语句，方便调试
        Db.Aop.OnLogExecuting = (sql, pars) =>
        {
            Console.WriteLine(sql); // 输出执行的 SQL
        };
    }
}

在此示例中，我们创建了 SqlSugarClient 实例，并通过 ConnectionConfig 类来配置数据库连接字符串和数据库类型。同时，通过 Aop.OnLogExecuting 输出 SQL 语句，便于开发者调试。

3. 创建实体类

SqlSugar 使用实体类来与数据库表进行映射。你可以通过简单的 POCO 类定义数据表结构：

public class User
{
    [SugarColumn(IsPrimaryKey = true, IsIdentity = true)] // 主键和自增列
    public int Id { get; set; }
    
    public string Name { get; set; }
    
    public int Age { get; set; }
    
    [SugarColumn(IsNullable = true)] // 可为空列
    public string Email { get; set; }
}

这个 User 类定义了一个用户表，包含 Id、Name、Age 和 Email 字段。通过注解 SugarColumn，我们可以指定字段的属性，如主键、自增列和可为空等。

4. 基础 CRUD 操作

使用 SqlSugar，可以非常方便地进行 CRUD 操作。以下是一些常用的增、删、改、查操作示例：

插入数据

var dbContext = new DbContext();
var user = new User()
{
    Name = "John Doe",
    Age = 30,
    Email = "john@example.com"
};

// 插入单条记录
dbContext.Db.Insertable(user).ExecuteCommand();

查询数据

var dbContext = new DbContext();

// 查询所有用户
var allUsers = dbContext.Db.Queryable<User>().ToList();

// 查询单个用户
var singleUser = dbContext.Db.Queryable<User>().Where(u => u.Id == 1).Single();

更新数据

var dbContext = new DbContext();

// 更新指定用户的信息
var userToUpdate = new User { Id = 1, Name = "Jane Doe", Age = 28 };
dbContext.Db.Updateable(userToUpdate).ExecuteCommand();

删除数据

var dbContext = new DbContext();

// 删除指定用户
dbContext.Db.Deleteable<User>().Where(u => u.Id == 1).ExecuteCommand();

5. 分页查询

SqlSugar 提供了简洁的分页查询方法。以下是一个分页查询的示例，假设每页显示 10 条记录：

var dbContext = new DbContext();
int pageIndex = 1;
int pageSize = 10;
int totalCount = 0;

// 分页查询
var pagedUsers = dbContext.Db.Queryable<User>()
    .OrderBy(u => u.Id) // 根据 Id 排序
    .ToPageList(pageIndex, pageSize, ref totalCount);

Console.WriteLine($"总记录数: {totalCount}");
foreach (var user in pagedUsers)
{
    Console.WriteLine($"用户: {user.Name}, 年龄: {user.Age}");
}

6. 事务支持

SqlSugar 支持事务管理，确保数据操作的原子性。以下是一个使用事务的示例：

var dbContext = new DbContext();

try
{
    dbContext.Db.Ado.BeginTran(); // 开始事务

    // 插入一条记录
    dbContext.Db.Insertable(new User { Name = "Alice", Age = 25 }).ExecuteCommand();

    // 更新另一条记录
    dbContext.Db.Updateable(new User { Id = 2, Name = "Bob Updated", Age = 32 }).ExecuteCommand();

    dbContext.Db.Ado.CommitTran(); // 提交事务
}
catch (Exception ex)
{
    dbContext.Db.Ado.RollbackTran(); // 回滚事务
    Console.WriteLine($"发生错误: {ex.Message}");
}

在此示例中，所有的数据库操作都被包装在事务中，如果出现异常，事务会回滚以确保数据一致性。

💯 应用场景

1. 企业级应用：SqlSugar 适用于需要与多种数据库打交道的企业级应用，特别是在需要快速处理 CRUD 操作和复杂 SQL 查询的场景中表现出色。

2. Web API 开发：在构建 RESTful API 时，SqlSugar 提供了简单高效的 ORM 功能，帮助开发者快速实现数据交互和业务逻辑。

3. 跨数据库项目：由于 SqlSugar 支持多种数据库类型，因此它非常适合需要在不同数据库之间迁移和扩展的项目。

📥 下载地址

SqlSugar 最新版 下载地址

💬 结语

SqlSugar 是一个轻量级且功能强大的 ORM 框架，它通过简单易用的 API 帮助 .NET 开发者高效地进行数据库操作。无论是基础的 CRUD 操作、复杂的查询，还是事务管理，SqlSugar 都能提供直观的解决方案。同时，它的多数据库支持和丰富的扩展功能使得它在企业级应用开发中具有广泛的应用场景。

如果你正在寻找一个高效、灵活的 .NET ORM 框架，SqlSugar 无疑是一个非常值得考虑的选择。

📒 参考文献

• SqlSugar 官方文档
• SqlSugar GitHub仓库