重构代码之取消临时字段

在代码重构中，临时字段是一种常见的反模式。临时字段指的是一个类的字段在部分方法中会被赋值或使用，但在其他很多方法中却未被使用，导致代码的维护性和可读性变差。这种设计往往表明字段的存在是偶然的或局部的，而非类的真正属性。因此，通过消除临时字段，我们可以提升代码的结构性和可读性。

一、为什么临时字段是一个反模式？

临时字段的主要问题在于它增加了类的复杂性，让代码阅读者误以为字段是这个类的核心属性，而实际上它可能只在特定情况下才有用。例如，临时字段通常在只有少数方法中赋值，在其他情况下可能保持 null 或无意义的默认值，这使代码变得难以理解，调试和维护变得复杂。

二、识别临时字段的信号

临时字段的特征通常包括：

字段只在部分方法中被使用，而在其他方法中无意义。
字段在类的大部分时间中为空或无效值。
字段的使用存在多个条件分支，用于检查其是否有效。

三、解决方案

有几种方式可以消除临时字段：

将字段移入方法
如果字段只在某个方法或一组方法中使用，那么可以将该字段改为局部变量，限定在方法的作用域内。
使用辅助类或数据容器
如果临时字段是多个方法共享的数据，可以将这些字段提取到一个单独的辅助类中，用该类管理它们的状态。这样不仅提升了代码的模块化，还降低了原始类的复杂度。
引入专用的值对象
如果临时字段用于特定的计算或数据传输，可以引入一个值对象专门承担这个作用。这样可以确保类的状态更加简洁，且符合单一职责原则。

四、示例

下面是一个 C# 的代码示例，展示了如何识别和重构临时字段。

4.1 重构前的代码

csharp 复制代码

public class OrderProcessor
{
    private Customer _customer;  // 临时字段
    private decimal _discount;   // 临时字段，仅在部分方法中使用

    public void SetCustomer(Customer customer)
    {
        _customer = customer;
    }

    public decimal CalculateDiscount()
    {
        if (_customer == null) return 0;

        _discount = _customer.IsPremium ? 0.1m : 0.05m;
        return _discount;
    }

    public void ProcessOrder(Order order)
    {
        if (_customer == null) throw new InvalidOperationException("Customer not set");
        // 处理订单逻辑
    }
}

在上面的例子中，_customer 和 _discount 字段只是为了完成 CalculateDiscount 方法而存在的，其他方法中则不需要它们。这使得 OrderProcessor 类复杂化，并且 _discount 在其他情况下可能无效。

4.2 重构后的代码

csharp 复制代码

public class OrderProcessor
{
    public decimal CalculateDiscount(Customer customer)
    {
        if (customer == null) return 0;

        return customer.IsPremium ? 0.1m : 0.05m;
    }

    public void ProcessOrder(Order order, Customer customer)
    {
        if (customer == null) throw new InvalidOperationException("Customer not set");
        // 处理订单逻辑
    }
}

在重构后，我们移除了临时字段 _customer 和 _discount，并将 Customer 参数直接传递给 CalculateDiscount 和 ProcessOrder 方法。这样 OrderProcessor 不再依赖于临时状态，类变得更简洁，代码的意图更加明确。

4.3使用 Null Object 模式（进阶用法）

在某些场景中，如果临时字段的空值被频繁检查，Null Object 模式也是一种有效的替代方案。例如，在上述代码中，如果 _customer 的空值情况较多且影响其他代码，可引入 Null Object 替代空值。

五、总结

取消临时字段的重构目的是为了让类的状态更明确，方法的职责更清晰。通过将临时字段转化为局部变量、辅助类或值对象，我们可以增强代码的清晰度，使其更易于维护和扩展。