C# SQLSugar实战：如何高效获取存储过程所有参数信息

1次阅读

共计 2810 个字符，预计需要花费 8 分钟才能阅读完成。

在数据库开发中，存储过程（Stored Procedure）是一种预编译的 SQL 语句集合，它可以提高性能、增强安全性并简化复杂操作。然而，当我们在 C# 中调用存储过程时，经常需要提前知道存储过程的所有参数信息，包括参数名称、数据类型、方向（输入 / 输出）等。传统的方式是通过 ADO.NET 的 SqlCommand 类来获取这些信息，但操作繁琐，代码量大，且容易出错。

常见问题包括：

参数名称拼写错误
参数类型不匹配
遗漏必需的参数
不了解参数的方向性

这些问题会导致运行时错误，增加调试时间，降低开发效率。

SQLSugar 是一个轻量级的 ORM 框架，它提供了简单易用的 API 来操作数据库。相比 Entity Framework 等重量级 ORM，SQLSugar 更加轻量、性能更高，特别适合中小型项目。它的主要优势包括：

语法简洁，学习成本低
性能优异，接近原生 ADO.NET
支持多种数据库（SQL Server, MySQL, Oracle 等）
提供丰富的功能，如分页、事务、缓存等

SQLSugar 提供了 GetProcedureParameters 方法来获取存储过程的所有参数信息。下面是一个完整的示例代码：

using SqlSugar;
using System;
using System.Collections.Generic;

class Program
{static void Main(string[] args)
    {
        // 1. 创建 SQLSugar 客户端
        var db = new SqlSugarClient(new ConnectionConfig()
        {
            ConnectionString = "Server=.;Database=TestDB;User ID=sa;Password=123456;",
            DbType = DbType.SqlServer,
            IsAutoCloseConnection = true
        });

        // 2. 获取存储过程参数
        var parameters = db.Ado.GetProcedureParameters("sp_GetUserInfo");

        // 3. 输出参数信息
        Console.WriteLine("存储过程 sp_GetUserInfo 的参数信息：");
        foreach (var param in parameters)
        {Console.WriteLine($"参数名：{param.ParameterName}");
            Console.WriteLine($"数据类型：{param.DbType}");
            Console.WriteLine($"方向：{param.Direction}");
            Console.WriteLine($"是否可为空：{param.IsNullable}");
            Console.WriteLine($"最大长度：{param.Size}");
            Console.WriteLine("----------------------------");
        }
    }
}

代码说明：

首先创建 SQLSugar 客户端，配置数据库连接信息
使用 GetProcedureParameters 方法获取指定存储过程的所有参数
遍历参数集合，输出每个参数的详细信息

GetProcedureParameters返回的是一个 List<ProcedureParameterInfo> 集合，每个 ProcedureParameterInfo 对象包含以下属性：

ParameterName：参数名称
DbType：参数的数据类型
Direction：参数方向（Input, Output, InputOutput, ReturnValue）
IsNullable：是否允许为空
Size：参数的最大长度

SQLSugar 的 GetProcedureParameters 方法在内部调用了数据库的系统视图（如 SQL Server 的sys.parameters），因此性能较高。但是，以下几点需要注意：

该方法需要与数据库进行交互，因此不适合在频繁调用的循环中使用
对于大型数据库，首次调用可能会有轻微延迟（因为需要查询系统视图）
建议在应用启动时或需要时缓存参数信息，避免重复查询

适用场景：

开发阶段：了解存储过程的结构
运行时：动态构建调用存储过程的参数
代码生成：根据存储过程生成 DTO 或调用代码

在实际项目中使用该技术时，建议遵循以下最佳实践：

参数验证：在调用存储过程前，验证传入的参数是否符合要求

// 验证必需参数
if (string.IsNullOrEmpty(userName))
{throw new ArgumentNullException(nameof(userName), "用户名不能为空");
}

参数映射：使用 DTO 或字典来管理参数，避免硬编码

var parameters = new Dictionary<string, object>
{{ "@UserName", userName},
    {"@Age", age}
};

db.Ado.UseStoredProcedure().ExecuteCommand("sp_UpdateUser", parameters);

错误处理：捕获并处理可能的数据库异常

try
{var result = db.Ado.UseStoredProcedure().GetDataTable("sp_GetUser", parameters);
}
catch (Exception ex)
{
    // 记录日志或通知开发人员
    logger.Error("调用存储过程失败", ex);
    throw;
}

性能优化：对于频繁调用的存储过程，考虑缓存参数信息

// 使用 MemoryCache 缓存参数信息
if (!memoryCache.TryGetValue("sp_params", out List<ProcedureParameterInfo> cachedParams))
{cachedParams = db.Ado.GetProcedureParameters("sp_GetUser");
    memoryCache.Set("sp_params", cachedParams, TimeSpan.FromHours(1));
}