重构长方法之提取方法

本篇文章将讲解解决长方法的6钟解决方案中的提取方法 。
1. 什么是长方法

长方法通常指的是代码中功能过于复杂或包含过多逻辑的函数或方法。这种方法往往难以阅读、理解和维护，可能违反单一职责原则。为了提高可读性和可维护性，建议将长方法拆分成多个小方法，每个方法负责一个具体的功能。

2. 提取方法

我们先来看一段代码:

csharp 复制代码

public void ProcessData(List<int> numbers)
{
    if (numbers == null || !numbers.Any())
    {
        Console.WriteLine("No data to process.");
        return;
    }

    int sum = 0;
    int count = 0;
    List<int> processedNumbers = new List<int>();

    foreach (var number in numbers)
    {
        if (number > 0)
        {
            sum += number;
            processedNumbers.Add(number * 2);
            count++;
        }
    }

    double average = count > 0 ? (double)sum / count : 0;

    Console.WriteLine($"Processed {count} positive numbers.");
    Console.WriteLine($"Sum: {sum}, Average: {average}");
    Console.WriteLine("Processed Numbers: " + string.Join(", ", processedNumbers));
}

我们阅读这段代码，发现在这个方法包含了多个职责，比如处理输入、计算总和和平均值、生成输出。这么多职责都写在了一个方法里，想要弄清这个方法功能就稍显困难（方法中的行数/职责越多，就越难弄清该方法的功能 ）。

使用提取方法这个解决方案可以轻松的处理前面所说的问题，我们一起来看一下更新后的代码：

csharp 复制代码

public void ProcessData(List<int> numbers)
{
    if (!ValidateInput(numbers)) return;

    var processedData = ProcessNumbers(numbers);
    DisplayResults(processedData);
}

private bool ValidateInput(List<int> numbers)
{
    if (numbers == null || !numbers.Any())
    {
        Console.WriteLine("No data to process.");
        return false;
    }
    return true;
}

private (int Sum, double Average, List<int> ProcessedNumbers) ProcessNumbers(List<int> numbers)
{
    int sum = 0;
    int count = 0;
    List<int> processedNumbers = new List<int>();

    foreach (var number in numbers)
    {
        if (number > 0)
        {
            sum += number;
            processedNumbers.Add(number * 2);
            count++;
        }
    }

    double average = count > 0 ? (double)sum / count : 0;
    return (sum, average, processedNumbers);
}

private void DisplayResults((int Sum, double Average, List<int> ProcessedNumbers) data)
{
    Console.WriteLine($"Processed {data.ProcessedNumbers.Count} positive numbers.");
    Console.WriteLine($"Sum: {data.Sum}, Average: {data.Average}");
    Console.WriteLine("Processed Numbers: " + string.Join(", ", data.ProcessedNumbers));
}

通过提取方法对不同的职责进行封装，我们看到代码既清晰又容易理解，而且更加易维护了。
3. 提取方法的步骤

首先，分析出长方法中所包含的职责，然后根据这些职责创建多个新方法，接着将每种职责的代码复制到对应的新方法中，紧接着从长方法中删除这些代码，并替换为对新方法的调用，最后查找每种职责代码中使用的变量，如果这些变量是在职责代码片段中声明的并且没有在片段外使用，那么只需将它们将做为新方法的局部变量即可。如果变量是在多种职责代码都在用的，则需要将这些变量作为传递给新方法的参数，以便使用其中之前。

4. 提取方法的优点

首先使代码更易读，这里要注意的是提取的方法的名称一定要是对方法体内代码职责的喵叔。其次减少代码重复，方法中的代码可以在程序的其他地方重复使用。然后每个方法中的代码是独立的，这就表示出错的可能性较低，即使出错了排查和修改也简单。