重构代码之参数化方法

在代码重构中，参数化方法 通过将方法内部的硬编码值替换为参数，使方法的适用性更广。这不仅可以减少重复代码，还能提高代码的灵活性和可维护性。让我们来深入探讨这种技术的应用场景、步骤以及一些例子。

一、适用场景

参数化方法通常适用于以下场景：

硬编码的值需要更改：方法内部使用了固定的值，如果将这些值外部化并传入作为参数，方法可以在不同场景中复用。
逻辑的重复：多个方法中存在相似的代码逻辑，但只有少量变量不同。这时可以通过参数化的方法减少代码重复。
提高扩展性：让方法更加通用，可以在未来的需求变动时灵活适应。

二、重构步骤

标识硬编码的值

首先，找出方法中哪些固定值是可变的或可能会在不同情境下变化的。这些值可以是数值、字符串、对象，甚至是方法调用。
添加参数

将这些硬编码的值替换为参数，并在方法签名中添加对应的参数。
更新调用方

由于方法签名的更改，所有调用该方法的代码都需要传入新的参数。这一步可能需要在多个调用方中更新值，但通常这是值得的，因为这样可以简化代码逻辑和维护成本。
测试重构后的代码

在重构完成后，确保重构后的代码功能和逻辑仍然与原先一致。单元测试是确保重构成功的一个有效手段。

三、实例演示

示例 1：将硬编码的折扣率替换为参数

假设有一个计算商品折扣的 CalculateDiscount 方法，最初方法中的折扣率是硬编码的。
重构前：

csharp 复制代码

public decimal CalculateDiscount(decimal price)
{
    decimal discountRate = 0.10m; // 10% discount
    return price * discountRate;
}

重构后：

csharp 复制代码

public decimal CalculateDiscount(decimal price, decimal discountRate)
{
    return price * discountRate;
}

调用时可以传入不同的折扣率，使该方法更加通用：

csharp 复制代码

var discountA = CalculateDiscount(100m, 0.10m); // 10% discount
var discountB = CalculateDiscount(100m, 0.20m); // 20% discount

示例 2：将硬编码的日志级别参数化

假设一个 LogMessage 方法，最初是写死日志级别为 Info。
重构前：

csharp 复制代码

public void LogMessage(string message)
{
    Console.WriteLine($"[Info] {message}");
}

重构后：

csharp 复制代码

public void LogMessage(string message, string logLevel)
{
    Console.WriteLine($"[{logLevel}] {message}");
}

调用方可以指定不同的日志级别：

csharp 复制代码

LogMessage("System started", "Info");
LogMessage("Unexpected error occurred", "Error");
LogMessage("User logged out", "Debug");

示例 3：添加额外的运算参数

假设我们有一个求矩形面积的方法 CalculateArea，最初只支持长方形的计算。
重构前：

csharp 复制代码

public double CalculateArea(double length, double width)
{
    return length * width;
}

重构后：

通过引入一个 shape 参数，我们可以灵活地支持不同的形状：

csharp 复制代码

public double CalculateArea(double length, double width, string shape = "rectangle")
{
    if (shape == "rectangle")
    {
        return length * width;
    }
    else if (shape == "triangle")
    {
        return (length * width) / 2;
    }
    else
    {
        throw new ArgumentException("Unsupported shape");
    }
}

这样方法调用方可以通过传入参数来控制要计算的图形类型：

csharp 复制代码

var rectangleArea = CalculateArea(10, 5);                // 默认长方形
var triangleArea = CalculateArea(10, 5, "triangle");    // 三角形

四、参数化方法的优点

减少重复代码：将类似逻辑抽取为参数化方法，可以避免代码重复，提高代码质量。
增加灵活性：方法的调用方可以根据具体需求传入不同的参数，从而灵活应对各种情况。
提升可维护性：当参数变化时，可以集中在方法内调整，而不是在每个调用处修改硬编码的值。

五、注意事项

参数过多的问题：过多的参数会导致代码难以理解和维护。因此，合理控制参数的数量。如果参数太多，可以考虑使用参数对象或分解方法。
方法的职责单一性：参数化方法可以增强方法的通用性，但仍需确保方法的职责单一，不要将过多的逻辑混合在一个方法中。
保持方法的清晰性：避免让参数变得过于复杂，比如避免传入不同的数据类型让方法执行不同的操作。

参数化方法是一种有效的重构技术，适用于去除硬编码、提升方法通用性的场景。通过这项技术，代码的灵活性、可读性和可维护性都能得到显著提升。然而在使用时，也需保持代码的简洁性，避免过度参数化。