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

1次阅读

没有评论

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

在 C# 开发中，使用 ORM 框架操作存储过程是常见的需求。然而，当使用 SqlSugar 调用存储过程时，手动维护参数列表往往成为开发者的痛点。具体表现为：

参数列表维护困难 ：存储过程的参数可能较多，手动编写参数列表容易遗漏或错误。
类型匹配问题 ：参数类型与数据库类型不匹配时，容易引发运行时错误。
可维护性差 ：当存储过程参数发生变化时，需要手动更新代码，增加了维护成本。

这些问题不仅降低了开发效率，还可能引入潜在的 Bug。因此，需要一种高效、自动化的方法来获取存储过程的所有参数信息。

在解决这一问题时，开发者通常会考虑以下几种方法：

直接查询数据库系统表 ：
优点：可以直接获取到存储过程的参数信息，信息准确。
缺点：需要编写额外的 SQL 查询语句，且不同数据库的系统表结构可能不同，兼容性较差。
使用 SqlSugar 内置方法 ：
优点：SqlSugar 提供了 GetParameter 方法，可以获取存储过程的参数信息，无需手动编写 SQL。
缺点：默认情况下，该方法可能无法获取所有参数信息，需要结合反射机制进一步优化。
反射机制 ：
优点：可以动态获取存储过程的参数信息，灵活性高。
缺点：反射操作可能会带来一定的性能开销。

综合对比，结合 SqlSugar 的 GetParameter 方法和反射机制，可以在保证性能的同时，动态获取存储过程的所有参数信息，是一种较为理想的解决方案。

1. 使用 SqlSugar 的 `GetParameter` 方法

SqlSugar 提供了 GetParameter 方法，可以获取存储过程的参数信息。该方法返回一个 List<DbParameter> 对象，包含参数名、类型、方向等信息。

为了进一步获取参数的详细信息，可以通过反射机制动态解析 DbParameter 对象的属性。具体步骤如下：

调用 GetParameter 方法获取参数列表。
遍历参数列表，通过反射获取每个参数的详细信息，如参数名、类型、方向等。
将解析后的参数信息存储到一个自定义的模型中，便于后续使用。

以下是一个完整的 C# 代码示例，展示了如何动态获取存储过程的所有参数信息：

using System;
using System.Collections.Generic;
using System.Data;
using System.Reflection;
using SqlSugar;

public class StoredProcedureParameterInfo
{public string Name { get; set;}
    public DbType DbType {get; set;}
    public ParameterDirection Direction {get; set;}
    public object Value {get; set;}
}

public class SqlSugarHelper
{
    private readonly SqlSugarScope _db;

    public SqlSugarHelper(string connectionString)
    {
        _db = new SqlSugarScope(new ConnectionConfig
        {
            ConnectionString = connectionString,
            DbType = DbType.SqlServer, // 根据实际情况调整数据库类型
            IsAutoCloseConnection = true
        });
    }

    public List<StoredProcedureParameterInfo> GetStoredProcedureParameters(string storedProcedureName)
    {var parameters = _db.Ado.GetParameters(storedProcedureName);
        var result = new List<StoredProcedureParameterInfo>();

        foreach (var parameter in parameters)
        {
            var parameterInfo = new StoredProcedureParameterInfo
            {
                Name = parameter.ParameterName,
                DbType = parameter.DbType,
                Direction = parameter.Direction,
                Value = parameter.Value
            };

            // 通过反射获取更多参数信息（如果需要）var type = parameter.GetType();
            var properties = type.GetProperties(BindingFlags.Public | BindingFlags.Instance);

            foreach (var property in properties)
            {
                // 可以根据需要获取其他属性
                Console.WriteLine($"{property.Name}: {property.GetValue(parameter)}");
            }

            result.Add(parameterInfo);
        }

        return result;
    }
}

// 使用示例
var helper = new SqlSugarHelper("YourConnectionString");
var parameters = helper.GetStoredProcedureParameters("YourStoredProcedureName");

foreach (var param in parameters)
{Console.WriteLine($"Name: {param.Name}, Type: {param.DbType}, Direction: {param.Direction}");
}