SQLSugar 批量插入返回ID

1. 导言

在很多情况下，我们需要向数据库中插入大量的数据，并且需要获取插入数据的ID。SQLSugar 是一个轻量级的ORM（对象关系映射）框架，它可以方便地操作数据库。本文将详解如何使用 SQLSugar 批量插入数据并返回插入数据的ID。

2. SQLSugar 简介

SQLSugar 是一个基于 .NET 平台的ORM 框架，提供了许多简化数据访问的功能。它支持多种数据库，如 MySQL、SQL Server、Oracle 等，可以自动生成数据库表结构，还提供了强大的查询语法和事务支持。

SQLSugar 提供了大量的功能，包括表的增删改查、存储过程、分页查询、批量操作等。其中，批量操作是 SQLSugar 的一个重要特性，它可以大大提高数据库操作的效率。

3. 批量插入数据

在实际的开发过程中，我们经常遇到需要向数据库中批量插入数据的情况。通常，我们可以使用循环逐条插入的方式，但这种方式效率低下，特别是当插入的数据量较大时。SQLSugar 提供了一个更高效的批量插入方式，可以一次性插入多条数据。

3.1 准备工作

首先，我们需要在项目中引用 SQLSugar 的 NuGet 包，并创建数据库连接对象和数据表对象。假设我们有一个 User 数据表，结构如下：

CREATE TABLE User (
    Id INT(11) PRIMARY KEY AUTO_INCREMENT,
    Name VARCHAR(50),
    Age INT(11)
)

3.2 批量插入数据

接下来，我们使用 SQLSugar 提供的 SqlBulkCopy 方法来实现批量插入数据。以下是示例代码：

using (var db = new SqlSugarClient(GetDbConnection())) // 创建 SQLSugar 实例
{
    var userList = new List<User>
    {
        new User { Name = "张三", Age = 20 },
        new User { Name = "李四", Age = 25 },
        new User { Name = "王五", Age = 30 }
    };

    var insertable = db.Insertable(userList); // 构建插入数据的对象
    insertable.IgnoreColumns("Id"); // 忽略自增长列
    var result = insertable.ExecuteReturnIdentity(); // 执行插入并返回插入数据的ID

    Console.WriteLine("插入成功，返回ID为：" + result);
}

在上述代码中，我们首先创建了一个名为 userList 的 List<User> 对象，并向其中添加了三条待插入的数据。接下来，我们使用 Insertable 方法构建了插入数据的对象，并通过调用 IgnoreColumns 方法忽略了 Id 列，因为 Id 列是自增长列，不需要手动插入。最后，我们调用 ExecuteReturnIdentity 方法执行插入操作，并将插入数据的ID保存在变量 result 中。最后，我们打印出插入成功的提示和返回的ID。

3.3 批量插入数据的效率

相较于循环逐条插入数据的方式，使用 SQLSugar 的批量插入功能可以大大提高插入数据的效率。下面是一个简单的示例，用于比较两种方式的差异。

using (var db = new SqlSugarClient(GetDbConnection())) // 创建 SQLSugar 实例
{
    Stopwatch sw = new Stopwatch();
    sw.Start();

    for (int i = 0; i < 1000; i++)
    {
        var user = new User { Name = "测试用户" + i, Age = 20 };
        db.Insertable(user).ExecuteReturnIdentity();
    }

    sw.Stop();
    Console.WriteLine("循环逐条插入耗时：" + sw.ElapsedMilliseconds + " 毫秒");

    sw.Restart();

    var userList = new List<User>();
    for (int i = 0; i < 1000; i++)
    {
        userList.Add(new User { Name = "测试用户" + i, Age = 20 });
    }
    db.Insertable(userList).ExecuteReturnIdentity();

    sw.Stop();
    Console.WriteLine("批量插入耗时：" + sw.ElapsedMilliseconds + " 毫秒");
}

在上述代码中，我们首先使用循环逐条插入的方式插入了1000条数据，并通过 Stopwatch 计时器获取了插入的耗时。接下来，我们使用批量插入的方式插入了相同数量的数据，并再次计时。运行示例代码后，可以发现使用批量插入的方式耗时明显少于循环逐条插入的方式。