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

1次阅读

没有评论

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

在 C# 开发中使用 SqlSugar 调用存储过程时，手动维护参数列表是一个常见的痛点。很多开发者可能会遇到以下问题：

参数列表易出错 ：手动编写参数时，容易遗漏或写错参数名称、类型或方向。
维护成本高 ：当存储过程参数发生变化时，必须同步修改代码中的参数列表，否则会导致运行时错误。
缺乏动态性 ：某些场景下需要根据存储过程参数动态构建调用逻辑，手动维护参数列表无法满足需求。

这些问题不仅降低了开发效率，还增加了代码的维护难度。因此，我们需要一种更高效的方式来自动获取存储过程的参数信息。

在 C# 中，获取存储过程参数信息的常见方法有以下几种：

直接查询数据库系统表 ：
优点：灵活性高，可以获取完整的参数信息。
缺点：需要编写复杂的 SQL 查询语句，且不同数据库的系统表结构可能不同，兼容性较差。
使用 ADO.NET 的 DeriveParameters 方法 ：
优点：直接通过 ADO.NET 提供的 API 获取参数信息，简单易用。
缺点：依赖于特定的数据库提供程序，某些场景下可能不支持。
使用 SqlSugar 内置方法 ：
优点：SqlSugar 提供了对多种数据库的良好支持，方法封装性高，代码简洁。
缺点：需要结合反射机制才能获取完整的参数信息。

综合来看，结合 SqlSugar 的内置方法和反射机制是最优选择，既保证了兼容性，又能动态获取参数信息。

SqlSugar 提供了 GetParameter 方法，可以获取存储过程的参数信息。结合反射机制，我们可以进一步解析参数的名称、类型和方向。以下是具体实现步骤：

使用 GetParameter 方法获取存储过程的参数列表。
通过反射机制解析参数的详细信息，包括参数名、类型和方向。
将解析后的参数信息封装为易于使用的数据结构。

这种方法不仅简化了代码，还提高了灵活性和可维护性。

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

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

public class StoredProcedureHelper
{
    private readonly SqlSugarClient _db;

    public StoredProcedureHelper(SqlSugarClient db)
    {_db = db;}

    public List<StoredProcedureParameter> GetStoredProcedureParameters(string procedureName)
    {var parameters = new List<StoredProcedureParameter>();

        // 获取存储过程的参数信息
        var sugarParameters = _db.Ado.GetParameter(procedureName);

        foreach (var sugarParam in sugarParameters)
        {
            // 使用反射获取参数的详细信息
            var paramType = sugarParam.GetType();
            var nameProperty = paramType.GetProperty("ParameterName");
            var directionProperty = paramType.GetProperty("Direction");
            var dbTypeProperty = paramType.GetProperty("DbType");

            if (nameProperty != null && directionProperty != null && dbTypeProperty != null)
            {
                var parameter = new StoredProcedureParameter
                {Name = nameProperty.GetValue(sugarParam)?.ToString(),
                    Direction = (ParameterDirection)directionProperty.GetValue(sugarParam),
                    DbType = dbTypeProperty.GetValue(sugarParam)?.ToString()};

                parameters.Add(parameter);
            }
        }

        return parameters;
    }
}

public class StoredProcedureParameter
{public string Name { get; set;}
    public ParameterDirection Direction {get; set;}
    public string DbType {get; set;}
}

public enum ParameterDirection
{
    Input,
    Output,
    InputOutput,
    ReturnValue
}