跳到主要内容

C# 重构技术

重构是软件开发中的一个重要过程，它指的是在不改变代码外部行为的前提下，改进代码的内部结构。通过重构，我们可以使代码更易于理解、维护和扩展。本文将介绍 C# 中常用的重构技术，并通过示例帮助你理解如何在实际项目中应用这些技术。

什么是重构？​

重构是一种系统化的方法，用于改进现有代码的设计。它通常涉及以下步骤：

  1. 识别问题：发现代码中的坏味道（如重复代码、过长的方法等）。
  2. 应用重构技术：使用特定的重构技术来改进代码。
  3. 验证行为：确保重构后的代码功能与之前一致。

重构的目标是使代码更简洁、更易于理解，同时保持其功能不变。

常见的重构技术​

1. 提取方法（Extract Method）​

当你发现一个方法过长或包含重复代码时，可以将其中一部分逻辑提取到一个新的方法中。这有助于提高代码的可读性和复用性。

示例​

重构前：

csharp
public void PrintOrderDetails(Order order)
{
    Console.WriteLine("Order ID: " + order.Id);
    Console.WriteLine("Customer: " + order.CustomerName);
    Console.WriteLine("Total Amount: " + order.TotalAmount);
    Console.WriteLine("Order Date: " + order.OrderDate);
}

重构后：

csharp
public void PrintOrderDetails(Order order)
{
    PrintOrderHeader(order);
    PrintOrderSummary(order);
}

private void PrintOrderHeader(Order order)
{
    Console.WriteLine("Order ID: " + order.Id);
    Console.WriteLine("Customer: " + order.CustomerName);
}

private void PrintOrderSummary(Order order)
{
    Console.WriteLine("Total Amount: " + order.TotalAmount);
    Console.WriteLine("Order Date: " + order.OrderDate);
}
提示

提取方法不仅使代码更易读，还提高了代码的复用性。如果你需要在其他地方打印订单头信息，可以直接调用 PrintOrderHeader 方法。

2. 重命名（Rename）​

变量、方法或类的命名应清晰表达其用途。如果名称不够明确，可以通过重命名来改善代码的可读性。

示例​

重构前：

csharp
public void Calc(int a, int b)
{
    int c = a + b;
    Console.WriteLine(c);
}

重构后：

csharp
public void CalculateSum(int firstNumber, int secondNumber)
{
    int sum = firstNumber + secondNumber;
    Console.WriteLine(sum);
}
备注

清晰的命名可以减少代码的歧义，使其他开发者更容易理解代码的意图。

3. 消除重复代码（Remove Duplication）​

重复代码是代码坏味道之一，它增加了维护成本并可能导致不一致性。通过提取公共逻辑到方法或类中，可以消除重复代码。

示例​

重构前：

csharp
public void ProcessOrder(Order order)
{
    if (order.IsValid())
    {
        // 处理订单逻辑
    }
}

public void CancelOrder(Order order)
{
    if (order.IsValid())
    {
        // 取消订单逻辑
    }
}

重构后：

csharp
public void ProcessOrder(Order order)
{
    if (ValidateOrder(order))
    {
        // 处理订单逻辑
    }
}

public void CancelOrder(Order order)
{
    if (ValidateOrder(order))
    {
        // 取消订单逻辑
    }
}

private bool ValidateOrder(Order order)
{
    return order.IsValid();
}
警告

消除重复代码不仅可以减少代码量，还能降低出错的风险。如果验证逻辑需要修改，只需修改 ValidateOrder 方法即可。

4. 引入解释性变量（Introduce Explaining Variable）​

当表达式过于复杂时，可以通过引入解释性变量来分解逻辑，使代码更易读。

示例​

重构前：

csharp
public bool IsEligibleForDiscount(Order order)
{
    return order.TotalAmount > 100 && order.Customer.IsPremiumMember && order.OrderDate.Year == DateTime.Now.Year;
}

重构后：

csharp
public bool IsEligibleForDiscount(Order order)
{
    bool isHighValueOrder = order.TotalAmount > 100;
    bool isPremiumCustomer = order.Customer.IsPremiumMember;
    bool isCurrentYearOrder = order.OrderDate.Year == DateTime.Now.Year;

    return isHighValueOrder && isPremiumCustomer && isCurrentYearOrder;
}
提示

解释性变量可以帮助你更好地理解复杂的逻辑，尤其是在条件判断中。

实际案例​

假设你正在开发一个电商系统，其中有一个 OrderProcessor 类负责处理订单。以下是重构前后的对比：

重构前：

csharp
public class OrderProcessor
{
    public void Process(Order order)
    {
        if (order.IsValid())
        {
            if (order.TotalAmount > 100)
            {
                ApplyDiscount(order);
            }
            SaveOrder(order);
            SendConfirmationEmail(order);
        }
    }

    private void ApplyDiscount(Order order)
    {
        order.TotalAmount *= 0.9;
    }

    private void SaveOrder(Order order)
    {
        // 保存订单到数据库
    }

    private void SendConfirmationEmail(Order order)
    {
        // 发送确认邮件
    }
}

重构后：

csharp
public class OrderProcessor
{
    public void Process(Order order)
    {
        if (!order.IsValid()) return;

        ApplyDiscountIfApplicable(order);
        SaveOrder(order);
        SendConfirmationEmail(order);
    }

    private void ApplyDiscountIfApplicable(Order order)
    {
        if (order.TotalAmount > 100)
        {
            ApplyDiscount(order);
        }
    }

    private void ApplyDiscount(Order order)
    {
        order.TotalAmount *= 0.9;
    }

    private void SaveOrder(Order order)
    {
        // 保存订单到数据库
    }

    private void SendConfirmationEmail(Order order)
    {
        // 发送确认邮件
    }
}
注意

在实际项目中，重构应逐步进行，并确保每次重构后都运行测试以验证代码的正确性。

总结​

重构是提高代码质量的重要手段。通过提取方法、重命名、消除重复代码和引入解释性变量等技术，你可以使代码更简洁、更易读、更易维护。重构不仅适用于大型项目，也适用于小型项目中的任何代码改进。

附加资源与练习​

  • 练习：尝试在你自己的项目中应用上述重构技术，观察代码的变化。
  • 推荐阅读：
    • 《重构：改善既有代码的设计》 by Martin Fowler
    • 《代码整洁之道》 by Robert C. Martin

通过不断实践和学习，你将能够更熟练地运用重构技术，编写出高质量的代码。