具有单行更改的 C# 重复函数

Question

我注意到我一遍又一遍地重复相同的几行代码，我想重构以防止发生这种情况以进行维护。但是，每次迭代之间的更改都在所有验证的中间，因此我不确定完成此操作的最佳方法。我觉得有一些方法可以编写一个可以接受输入来更改内部代码的通用函数，但我能想到的唯一方法是每个枚举和一个 switch 语句。

有没有更好的方法让这段重复的代码更易读和维护？

在整个过程中重复的特定块：

    if (_read.HasRows)
    {
        while (_read.Read())
        {
            //DO SOMETHING...;
        }
    }
    _read.Close();

示例用法：

public List<object> TableList()
{
    List<object> list = new List<object>();

    _cmd.CommandText = "SELECT * FROM sys.tables";

    try
    {
        _read = _cmd.ExecuteReader();
    }
    catch (Exception e)
    {
                     //please ignore this try catch for now
        list[0] = e; //this is a temporary measure until I finalize error handling
    }

//block to generalize
    if (_read.HasRows)
    {
        while (_read.Read())
        {
            list.Add(_read.GetValue(0)); //unique line
        }
    }


    _read.Close();

    return list;
}

另一个例子：

private List<object[]> _Columns = new List<object[]>()    
private bool SetColumns()
{
    _oldCommand = _cmd.CommandText;
    _cmd.CommandText = "exec sp_columns " + tableName;
        try
        {
            _read = _cmd.ExecuteReader();
        }
        catch (Exception e)
        { }  //again, ignore the messy error handling.  That is coming next.


//block to generalize
    if (_read.HasRows)
    {
        while (_read.Read())
        {
            _Columns.Add(new object[2] { _read.GetValue(3), _read.GetValue(5) }); //unique line
        }
    }



    _read.Close();
    _cmd.CommandText = _oldCommand;
    if (_Columns.Count != 0)
    {
        return true;
    }
    else
    {
        return false;
    }
}

只是在问题的具体范围底部提醒。 如何概括重复的代码块，同时仍然允许不同用途存在唯一行？我只举了两个例子，但这个问题在整个过程中有几个例子，我想在深入之前进行重构。

看到答案后的最终实现：

    /// <summary>
    /// Sets a list of tables in the connected database.
    /// </summary>
    /// <returns>Returns a List<string> of the tables.  If there is an error, then the first element of the list will conatin the exception.</returns>
    public List<string> TableList()
    {
        List<string> list = new List<string>();

        _cmd.CommandText = "SELECT * FROM sys.tables";

        ExecuteReader(_read => { list.Add(_read.GetString(0)); });

        _read.Close();

        return list;
    }


    /// <summary>
    /// sets column names and types to the _columns private variable [0] = name, [1] = type
    /// </summary>
    private void SetColumns()
    {
        _oldCommand = _cmd.CommandText;

        _cmd.CommandText = "exec sp_columns " + TableName;

        ExecuteReader(_read => columns.Add(new string[2] { _read.GetString(3), _read.GetString(5) }));

        _cmd.CommandText = _oldCommand;

        _read.Close();

    }


    /// <summary>
    /// Executes the reader with error handling and type returns.
    /// </summary>
    /// <param name="readline">the code that actually pulls the data from each line of the reader</param>
    private void ExecuteReader(Action<SqlDataReader> readline)
    {
        if (_con.State.HasFlag(ConnectionState.Closed)) { _con.Open(); }

        _read = _cmd.ExecuteReader();

        while (_read.Read())
        {
            readline(_read);
        }

        _con.Close();

    }

我选择了这种方法，因为它在我的经验水平上感觉最易读。正如许多其他人所推荐的那样，我已经对 Dapper 进行了一些研究。我很可能会在未来的项目中使用它，因为出于我自己的经验，我喜欢至少编写一次自己的样板代码。

感谢大家的精彩回答。我希望将来其他人会发现这对您有所帮助。

Answer 1

您可以通过传入 lambda 表达式来分解填充代码，例如：

SetColumns(reader => _Columns.Add(new object[2] { _read.GetValue(3), _read.GetValue(5) }));

SetColumns(reader => list.Add(reader.GetValue(0)));

查看 while 循环内的更新行：

private List<object[]> _Columns = new List<object[]>();
private bool SetColumns(Action<DbDataReader> populateColumns)
{
    _oldCommand = _cmd.CommandText;
    _cmd.CommandText = "exec sp_columns " + tableName;
        try
        {
            _read = _cmd.ExecuteReader();
        }
        catch (Exception e)
        { }  //again, ignore the messy error handling.  That is coming next.


//block to generalize
    if (_read.HasRows)
    {
        while (_read.Read())
        {
            populateColumns(_read);
        }
    }



    _read.Close();
    _cmd.CommandText = _oldCommand;
    if (_Columns.Count != 0)
    {
        return true;
    }
    else
    {
        return false;
    }
}

Answer 2

当您考虑重用时，脑海中有两种方法。

• 只需将其作为一种方法，即可在任何地方使用。
• 继承

现在在这种情况下，继承听起来有点咄咄逼人。但是制作一个方法是正确的。

这是我的镜头：

public class FillerFromDb
{
    public IList ListToBeFilled { get; set; }
    SqlCommand Command { get; set; }
    SqlDataReader Reader { get; set; }
    public FillerFromDb ( IList listToBeFilled, SqlCommand commandToRun )
    {
        ListToBeFilled = listToBeFilled;
        Command = commandToRun;
    }

    public void RunFor ( Func<SqlDataReader, object> rowProcessing )
    {
        ReadFromDb();
        ProcessRow(rowProcessing);
    }

    private void ReadFromDb ()
    {
        try
        {
            Reader = Command.ExecuteReader();
        }
        catch ( Exception e )
        {
            // handle the exception
        }
    }

    private void ProcessRow ( Func<SqlDataReader, object> rowProcessing )
    {
        if ( Reader.HasRows )
        {
            while ( Reader.Read() )
            {
                var result = rowProcessing(Reader);
                ListToBeFilled.Add(result);
            }
        }

        Reader.Close();
    }
}

和被调用者：

var filler = new FillerFromDb(list/*or _Columns*/, _cmd);

filler.RunFor(row => row.GetValue(0));

如果您要进行重构，将工作函数封装在这样的类中，您会感觉更好。

Answer 3

试试这个：

private void CommonBlock(Action act)
    {
        // some code
        if (act!=null) act.Invoke();
        //next code
    }

使用具体代码调用：

CommonBlock(()=>{Debug.WriteLine("you action");/*Anything you want to do*/});

Answer 4

最简单的方法是创建一个扩展方法：

public static class Extensions
{
  public static IDataReader Read(this IDataReader reader, Action<IDataReader> action)
  {
    if(reader.HasRows)
    {
      while(reader.Read())
      {
        action(reader);
      }
    }
  }
}

使用您的原始样本的示例如下：

public List<object> TableList()
{
    List<object> list = new List<object>();

    _cmd.CommandText = "SELECT * FROM sys.tables";

    try
    {
        _read = _cmd.ExecuteReader();
    }
    catch (Exception e)
    {
                     //please ignore this try catch for now
        list[0] = e; //this is a temporary measure until I finalize error handling
    }

    _read.Read(r => list.Add(r.GetValue(0)));        
    _read.Close();

    return list;
}

Answer 5

通过 Action 或 Func 将差异传递给函数。编写一个通用版本，然后传入要执行的不同版本。