C#桌面应用中SQL Server存储过程OUT参数的创建与使用（获取自增主键）

嘿，这个问题我熟！你要的就是在插入数据的同时直接返回自增主键，不用额外跑一次数据库查询，对吧？我给你分两步讲，保证清晰好实现。

首先得在数据库里创建存储过程，用OUTPUT参数来返回自增主键。这里要注意用SCOPE_IDENTITY()来获取主键值，它只会返回当前存储过程作用域内刚插入的ID，不会被其他并发操作干扰，比@@IDENTITY或者IDENT_CURRENT更可靠。

假设你的表叫YourTable，自增主键列是Id（bigint类型），还有其他字段比如Name、Description，存储过程可以这么写：

CREATE PROCEDURE InsertYourRecord
    @Name NVARCHAR(100),
    @Description NVARCHAR(500),
    @NewId BIGINT OUTPUT  -- 定义输出参数，用来返回自增主键
AS
BEGIN
    SET NOCOUNT ON;  -- 关闭影响行数的返回，避免额外数据

    INSERT INTO YourTable (Name, Description)
    VALUES (@Name, @Description);

    -- 把刚插入的自增主键赋值给输出参数
    SET @NewId = SCOPE_IDENTITY();
END

接下来在你的C#桌面应用里，用SqlCommand调用这个存储过程，重点是要正确配置输出参数的方向和类型。

using System.Data;
using System.Data.SqlClient;

// 替换成你的数据库连接字符串
string connectionString = "Server=YOUR_SERVER;Database=YOUR_DB;Trusted_Connection=True;";

// 准备要插入的数据
string recordName = "测试名称";
string recordDesc = "测试描述";
long newRecordId = 0;  // 用来存返回的主键

using (SqlConnection conn = new SqlConnection(connectionString))
{
    conn.Open();

    using (SqlCommand cmd = new SqlCommand("InsertYourRecord", conn))
    {
        // 告诉Command这是存储过程，不是普通SQL语句
        cmd.CommandType = CommandType.StoredProcedure;

        // 添加输入参数
        cmd.Parameters.AddWithValue("@Name", recordName);
        cmd.Parameters.AddWithValue("@Description", recordDesc);

        // 配置输出参数：类型要和数据库的bigint对应，方向设为Output
        SqlParameter outputParam = new SqlParameter("@NewId", SqlDbType.BigInt)
        {
            Direction = ParameterDirection.Output
        };
        cmd.Parameters.Add(outputParam);

        // 执行插入操作
        cmd.ExecuteNonQuery();

        // 取出返回的主键值，记得先判断是不是DBNull
        if (outputParam.Value != DBNull.Value)
        {
            newRecordId = Convert.ToInt64(outputParam.Value);
        }
    }
}

// 这里newRecordId就是刚插入的记录的主键啦
Console.WriteLine($"新记录的ID是：{newRecordId}");

可选简化方案：用ExecuteScalar直接返回主键 #

如果你只需要返回这一个主键值，也可以不用OUTPUT参数，让存储过程直接返回主键，然后用ExecuteScalar()获取结果：

修改后的存储过程： #

CREATE PROCEDURE InsertYourRecord
    @Name NVARCHAR(100),
    @Description NVARCHAR(500)
AS
BEGIN
    SET NOCOUNT ON;

    INSERT INTO YourTable (Name, Description)
    VALUES (@Name, @Description);

    -- 直接返回自增主键
    SELECT SCOPE_IDENTITY() AS NewId;
END

对应的C#代码： #

// ... 连接部分和之前一样 ...
using (SqlCommand cmd = new SqlCommand("InsertYourRecord", conn))
{
    cmd.CommandType = CommandType.StoredProcedure;
    cmd.Parameters.AddWithValue("@Name", recordName);
    cmd.Parameters.AddWithValue("@Description", recordDesc);

    // 执行并获取返回的主键
    object result = cmd.ExecuteScalar();
    if (result != DBNull.Value)
    {
        newRecordId = Convert.ToInt64(result);
    }
}

两种方法都能避免额外的数据库往返，因为都是在同一个插入请求里完成主键的获取。OUTPUT参数更灵活，适合需要返回多个值的场景；ExecuteScalar则更简洁，适合只返回单个值的情况。

内容的提问来源于stack exchange，提问作者EdA