代码重构技巧

原创 2016年07月20日 11:39:47

简介

重构是持续改进代码的基础。抵制重构将带来技术麻烦:忘记代码片段的功能、创建无法测试的代码等等。

而有了重构,使用单元测试、共享代码以及更可靠的无bug 的代码这些最佳实践就显得简单多了。

鉴于重构的重要性,我决定在整个8 月份每天介绍一个重构。在开始之前,请允许我事先声明,尽管我试着对每个重构进行额外的描述和讨论,但我并不是在声明它们的所有权。

我介绍的大多数重构都可以在Refactoring.com 中找到,有一些来自《代码大全(第2 版)》,剩下的则是我自己经常使用或从其他网站找到的。我觉得注明每个重构的出处并不是重要的,因为你可以在网上不同的帖子或文章中找到名称类似的重构。

本着这一精神,我将在明天发布第一篇帖子并开始长达31天的重构马拉松之旅。希望你们能够享受重构并从中获益。

 

代码重构第1天:封装集合

在某些场景中,向类的使用者隐藏类中的完整集合是一个很好的做法,比如对集合的add/remove操作中包含其他的相关逻辑时。因此,以可迭代但不直接在集合上进行操作的方式来暴露集合,是个不错的主意。我们来看代码:

  1. public class Order
  2. {
  3. private int _orderTotal;
  4. private List<OrderLine> _orderLines;
  5.  
  6. public IEnumerable<OrderLine> OrderLines
  7. {
  8. get { return _orderLines; }
  9. }
  10.  
  11. public void AddOrderLine(OrderLine orderLine)
  12. {
  13. _orderTotal += orderLine.Total;
  14. _orderLines.Add(orderLine);
  15. }
  16.  
  17. public void RemoveOrderLine(OrderLine orderLine)
  18. {
  19. orderLine = _orderLines.Find(o => o == orderLine);
  20. if (orderLine == null) return;
  21. _orderTotal -= orderLine.Total;
  22. _orderLines.Remove(orderLine);
  23. }
  24. }

如你所见,我们对集合进行了封装,没有将Add/Remove 方法暴露给类的使用者。在.NET Framework中,有些类如ReadOnlyCollection,会由于封装集合而产生不同的行为,但它们各自都有防止误解的说明。这是一个非常简单但却极具价值的重构,可以确保用户不会误用你暴露的集合,避免代码中的一些bug。

 

代码重构第2天:移动方法

今天的重构同样非常简单,以至于人们并不认为这是一个有价值的重构。迁移方法(Move Method),顾名思义就是将方法迁移到合适的位置。在开始重构前,我们先看看一下代码:

  1. public class BankAccount
  2. {
  3. public BankAccount(int accountAge, int creditScore, AccountInterest accountInterest)
  4. {
  5. AccountAge = accountAge;
  6. CreditScore = creditScore;
  7. AccountInterest = accountInterest;
  8. }
  9.  
  10. public int AccountAge { get; private set; }
  11. public int CreditScore { get; private set; }
  12. public AccountInterest AccountInterest { get; private set; }
  13.  
  14. public double CalculateInterestRate()
  15. {
  16. if (CreditScore > 800)
  17. return 0.02;
  18.  
  19. if (AccountAge > 10)
  20. return 0.03;
  21.  
  22. return 0.05;
  23. }
  24. }
  1. public class AccountInterest
  2. {
  3. public BankAccount Account { get; private set; }
  4.  
  5. public AccountInterest(BankAccount account)
  6. {
  7. Account = account;
  8. }
  9.  
  10. public double InterestRate
  11. {
  12. get { return Account.CalculateInterestRate(); }
  13. }
  14.  
  15. public bool IntroductoryRate
  16. {
  17. get { return Account.CalculateInterestRate() < 0.05; }
  18. }
  19. }

这里值得注意的是BankAccount.CalculateInterest 方法。当一个方法被其他类使用比在它所在类中的使用还要频繁时,我们就需要使用迁移方法重构了——将方法迁移到更频繁地使用它的类中。由于依赖关系,该重构并不能应用于所有实例,但人们还是经常低估它的价值。

最终的代码应该是这样的:

  1. public class BankAccount
  2. {
  3. public BankAccount(int accountAge, int creditScore, AccountInterest accountInterest)
  4. {
  5. AccountAge = accountAge;
  6. CreditScore = creditScore;
  7. AccountInterest = accountInterest;
  8. }
  9.  
  10. public int AccountAge { get; private set; }
  11. public int CreditScore { get; private set; }
  12. public AccountInterest AccountInterest { get; private set; }
  13. }
  1. public class AccountInterest
  2. {
  3. public BankAccount Account { get; private set; }
  4. public AccountInterest(BankAccount account)
  5. {
  6. Account = account;
  7. }
  8.  
  9. public double InterestRate
  10. {
  11. get { return CalculateInterestRate(); }
  12. }
  13.  
  14. public bool IntroductoryRate
  15. {
  16. get { return CalculateInterestRate() < 0.05; }
  17. }
  18.  
  19. public double CalculateInterestRate()
  20. {
  21. if (Account.CreditScore > 800)
  22. return 0.02;
  23.  
  24. if (Account.AccountAge > 10)
  25. return 0.03;
  26.  
  27. return 0.05;
  28. }
  29. }

够简单吧?

 

代码重构第3天:提升方法

提升方法(Pull Up Method)重构是将方法向继承链上层迁移的过程。用于一个方法被多个实现者使用时。

  1. public abstract class Vehicle
  2. {
  3. // other methods
  4. }
  5.  
  6. public class Car : Vehicle
  7. {
  8. public void Turn(Direction direction)
  9. {
  10. // code here
  11. }
  12. }
  13.  
  14. public class Motorcycle : Vehicle
  15. {
  16. }
  17.  
  18. public enum Direction
  19. {
  20. Left,
  21. Right
  22. }

如你所见,目前只有Car类中包含Turn方法,但我们也希望在Motorcycle 类中使用。因此,如果没有基类,我们就创建一个基类并将该方法“上移”到基类中,这样两个类就都可以使用Turn 方法了。这样做唯一的缺点是扩充了基类的接口、增加了其复杂性,因此需谨慎使用。只有当一个以上的子类需要使用该方法时才需要进行迁移。如果滥用继承,系统将会很快崩溃。这时你应该使用组合代替继承。重构之后的代码如下:

  1. public abstract class Vehicle
  2. {
  3. public void Turn(Direction direction)
  4. {
  5. // code here
  6. }
  7. }
  8.  
  9. public class Car : Vehicle
  10. {
  11. }
  12.  
  13. public class Motorcycle : Vehicle
  14. {
  15. }
  16.  
  17. public enum Direction
  18. {
  19. Left,
  20. Right
  21. }

 

代码重构第4天:降低方法

昨天我们介绍了将方法迁移到基类以供多个子类使用的上移方法重构,今天我们来看看相反的操作。重构前的代码如下:

  1. public abstract class Animal
  2. {
  3. public void Bark()
  4. {
  5. // code to bark
  6. }
  7. }
  8.  
  9. public class Dog : Animal
  10. {
  11. }
  12.  
  13. public class Cat : Animal
  14. {
  15. }

这里的基类有一个Bark方法。或许我们的猫咪们一时半会也没法学会汪汪叫(bark),因此Cat 类中不再需要这个功能了。尽管基类不需要这个方法,但在显式处理Dog 类时也许还需要,因此我们将Bark 方法“降低”到Dog 类中。这时,有必要评估Animal基类中是否还有其他行为。如果没有,则是一个将Animal抽象类转换成接口的好时机。因为契约中不需要任何代码,可以认为是一个标记接口。

  1. public abstract class Animal
  2. {
  3. }
  4.  
  5. public class Dog : Animal
  6. {
  7. public void Bark()
  8. {
  9. // code to bark
  10. }
  11. }
  12.  
  13. public class Cat : Animal
  14. {
  15. }

 

代码重构第5天:提升字段

今天我们来看看一个和提升方法十分类似的重构。不过今天我们处理的不是方法,而是字段。

  1. public abstract class Account
  2. {
  3. }
  4.  
  5. public class CheckingAccount : Account
  6. {
  7. private decimal _minimumCheckingBalance = 5m;
  8. }
  9.  
  10. public class SavingsAccount : Account
  11. {
  12. private decimal _minimumSavingsBalance = 5m;
  13. }

在这个例子中,两个子类中包含重复的常量。为了提高复用性我们将字段上移到基类中,并简化其名称。

  1. public abstract class Account
  2. {
  3. protected decimal _minimumBalance = 5m;
  4. }
  5.  
  6. public class CheckingAccount : Account
  7. {
  8. }
  9.  
  10. public class SavingsAccount : Account
  11. {
  12. }

 

重构代码第6天:降低字段

与提升字段相反的重构是降低字段。同样,这也是一个无需多言的简单重构。

  1. public abstract class Task
  2. {
  3. protected string _resolution;
  4. }
  5.  
  6. public class BugTask : Task
  7. {
  8. }
  9.  
  10. public class FeatureTask : Task
  11. {
  12. }

在这个例子中,基类中的一个字符串字段只被一个子类使用,因此可以进行下移。只要没有其他子类使用基类的字段时,就应该立即执行该重构。保留的时间越长,就越有可能不去重构而保持原样。

  1. public abstract class Task
  2. {
  3. }
  4.  
  5. public class BugTask : Task
  6. {
  7. private string _resolution;
  8. }
  9.  
  10. public class FeatureTask : Task
  11. {
  12. }

 

重构代码第7天:重命名(方法,类,参数)

这是我最常用也是最有用的重构之一。我们对方法/类/参数的命名往往不那么合适,以至于误导阅读者对于方法/类/参数功能的理解。这会造成阅读者的主观臆断,甚至引入bug。这个重构看起来简单,但却十分重要。

  1. public class Person
  2. {
  3. public string FN { get; set; }
  4. public decimal ClcHrlyPR()
  5. {
  6. // code to calculate hourly payrate
  7. return 0m;
  8. }
  9. }

如你所见,我们的类/方法/参数的名称十分晦涩难懂,可以理解为不同的含义。应用这个重构你只需随手将
名称修改得更具描述性、更容易传达其含义即可。简单吧。

  1. // Changed the class name to Employee
  2. public class Employee
  3. {
  4. public string FirstName { get; set; }
  5.  
  6. public decimal CalculateHourlyPay()
  7. {
  8. // code to calculate hourly payrate
  9. return 0m;
  10. }
  11. }

 

重构代码第8天:使用委派代替继承

继承的误用十分普遍。它只能用于逻辑环境,但却经常用于简化,这导致复杂的没有意义的继承层次。看下面的代码:

  1. public class Sanitation
  2. {
  3. public string WashHands()
  4. {
  5. return "Cleaned!";
  6. }
  7. }
  8.  
  9. public class Child : Sanitation
  10. {
  11. }

在该例中,Child 并不是Sanitation,因此这样的继承层次是毫无意义的。我们可以这样重构:在Child 的构造函数里实现一个Sanitation实例,并将方法的调用委托给这个实例。如果你使用依赖注入,可以通过构造函数传递Sanitation实例,尽管在我看来还要向IoC容器注册模型是一种坏味道,但领会精神就可以了。继承只能用于严格的继承场景,并不是用来快速编写代码的工具。

  1. public class Sanitation
  2. {
  3. public string WashHands()
  4. {
  5. return "Cleaned!";
  6. }
  7. }
  8.  
  9. public class Child
  10. {
  11. private Sanitation Sanitation { get; set; }
  12.  
  13. public Child()
  14. {
  15. Sanitation = new Sanitation();
  16. }
  17.  
  18. public string WashHands()
  19. {
  20. return Sanitation.WashHands();
  21. }
  22. }

 

代码重构第9天:提取接口

今天我们来介绍一个常常被忽视的重构:提取接口。如果你发现多于一个类使用另外一个类的某些方法,引入接口解除这种依赖往往十分有用。该重构实现起来非常简单,并且能够享受到松耦合带来的好处。

  1. public class ClassRegistration
  2. {
  3. public void Create()
  4. {
  5. // create registration code
  6. }
  7.  
  8. public void Transfer()
  9. {
  10. // class transfer code
  11. }
  12.  
  13. public decimal Total { get; private set; }
  14. }
  15.  
  16. public class RegistrationProcessor
  17. {
  18. public decimal ProcessRegistration(ClassRegistration registration)
  19. {
  20. registration.Create();
  21. return registration.Total;
  22. }
  23. }

在下面的代码中,你可以看到我提取出了消费者所使用的两个方法,并将其置于一个接口中。现在消费者不必关心和了解实现了这些方法的类。我们解除了消费者与实际实现之间的耦合,使其只依赖于我们创建的契约。

  1. public interface IClassRegistration
  2. {
  3. void Create();
  4. decimal Total { get; }
  5. }
  6.  
  7. public class ClassRegistration : IClassRegistration
  8. {
  9. public void Create()
  10. {
  11. // create registration code
  12. }
  13.  
  14. public void Transfer()
  15. {
  16. // class transfer code
  17. }
  18.  
  19. public decimal Total { get; private set; }
  20. }
  21.  
  22. public class RegistrationProcessor
  23. {
  24. public decimal ProcessRegistration(IClassRegistration registration)
  25. {
  26. registration.Create();
  27. return registration.Total;
  28. }
  29. }

 

代码重构第10天:提取方法

今天我们要介绍的重构是提取方法。这个重构极其简单但却大有裨益。首先,将逻辑置于命名良好的方法内有助于提高代码的可读性。当方法的名称可以很好地描述这部分代码的功能时,可以有效地减少其他开发者的研究时间。假设越少,代码中的bug 也就越少。重构之前的代码如下:

  1. public class Receipt
  2. {
  3. private IList<decimal> Discounts { get; set; }
  4. private IList<decimal> ItemTotals { get; set; }
  5.  
  6. public decimal CalculateGrandTotal()
  7. {
  8. decimal subTotal = 0m;
  9. foreach (decimal itemTotal in ItemTotals)
  10. subTotal += itemTotal;
  11. if (Discounts.Count > 0)
  12. {
  13. foreach (decimal discount in Discounts)
  14. subTotal -= discount;
  15. }
  16.  
  17. decimal tax = subTotal * 0.065m;
  18. subTotal += tax;
  19. return subTotal;
  20. }
  21. }

你会发现CalculateGrandTotal方法一共做了3件不同的事情:计算总额、折扣和发票税额。开发者为了搞清楚每个功能如何处理而不得不将代码从头看到尾。相比于此,向下面的代码那样将每个任务分解成单独的方法则要节省更多时间,也更具可读性:

  1. public class Receipt
  2. {
  3. private IList<decimal> Discounts { get; set; }
  4. private IList<decimal> ItemTotals { get; set; }
  5. public decimal CalculateGrandTotal()
  6. {
  7. decimal subTotal = CalculateSubTotal();
  8. subTotal = CalculateDiscounts(subTotal);
  9. subTotal = CalculateTax(subTotal);
  10. return subTotal;
  11. }
  12.  
  13. private decimal CalculateTax(decimal subTotal)
  14. {
  15. decimal tax = subTotal * 0.065m;
  16. subTotal += tax;
  17. return subTotal;
  18. }
  19.  
  20. private decimal CalculateDiscounts(decimal subTotal)
  21. {
  22. if (Discounts.Count > 0)
  23. {
  24. foreach (decimal discount in Discounts)
  25. subTotal -= discount;
  26. }
  27. return subTotal;
  28. }
  29.  
  30. private decimal CalculateSubTotal()
  31. {
  32. decimal subTotal = 0m;
  33. foreach (decimal itemTotal in ItemTotals)
  34. subTotal += itemTotal;
  35. return subTotal;
  36. }
  37. }

 

代码重构第11天:使用策略类

今天的重构没有固定的形式,多年来我使用过不同的版本,并且我敢打赌不同的人也会有不同的版本。该重构适用于这样的场景:switch 语句块很大,并且会随时引入新的判断条件。这时,最好使用策略模式将每个条件封装到单独的类中。实现策略模式的方式是很多的。我在这里介绍的策略重构使用的是字典策略,这么做的好处是调用者不必修改原来的代码。

  1. namespace LosTechies.DaysOfRefactoring.SwitchToStrategy.Before
  2. {
  3. public class ClientCode
  4. {
  5. public decimal CalculateShipping()
  6. {
  7. ShippingInfo shippingInfo = new ShippingInfo();
  8. return shippingInfo.CalculateShippingAmount(State.Alaska);
  9. }
  10. }
  11.  
  12. public enum State
  13. {
  14. Alaska,
  15. NewYork,
  16. Florida
  17. }
  18.  
  19. public class ShippingInfo
  20. {
  21. public decimal CalculateShippingAmount(State shipToState)
  22. {
  23. switch (shipToState)
  24. {
  25. case State.Alaska:
  26. return GetAlaskaShippingAmount();
  27. case State.NewYork:
  28. return GetNewYorkShippingAmount();
  29. case State.Florida:
  30. return GetFloridaShippingAmount();
  31. default:
  32. return 0m;
  33. }
  34. }
  35.  
  36. private decimal GetAlaskaShippingAmount()
  37. {
  38. return 15m;
  39. }
  40.  
  41. private decimal GetNewYorkShippingAmount()
  42. {
  43. return 10m;
  44. }
  45.  
  46. private decimal GetFloridaShippingAmount()
  47. {
  48. return 3m;
  49. }
  50. }
  51. }

要应用该重构,需将每个测试条件至于单独的类中,这些类实现了一个共同的接口。然后将枚举作为字典的键,这样就可以获取正确的实现,并执行其代码了。以后如果希望添加新的条件,只需添加新的实现类,并将其添加至ShippingCalculations 字典中。正如前面说过的,这不是实现策略模式的唯一方式。我在这里将字体加粗显示,是因为肯定会有人在评论里指出这点:)用你觉得好用的方法。我用这种方式实现重构的好处是,不用修改客户端代码。所有的修改都在ShippingInfo 类内部。
Jayme Davis指出这种重构由于仍然需要在构造函数中进行绑定,所以只不过是增加了一些类而已,但如果绑定IShippingCalculation的策略可以置于IoC中,带来的好处还是很多的,它可以使你更灵活地捆绑策略。

  1. namespace LosTechies.DaysOfRefactoring.SwitchToStrategy.After
  2. {
  3. public class ClientCode
  4. {
  5. public decimal CalculateShipping()
  6. {
  7. ShippingInfo shippingInfo = new ShippingInfo();
  8. return shippingInfo.CalculateShippingAmount(State.Alaska);
  9. }
  10. }
  11.  
  12. public enum State
  13. {
  14. Alaska,
  15. NewYork,
  16. Florida
  17. }
  18.  
  19. public class ShippingInfo
  20. {
  21. private IDictionary<State, IShippingCalculation> ShippingCalculations
  22. { get; set; }
  23.  
  24. public ShippingInfo()
  25. {
  26. ShippingCalculations = new Dictionary<State, IShippingCalculation>
  27. {
  28. { State.Alaska, new AlaskShippingCalculation() },
  29. { State.NewYork, new NewYorkShippingCalculation() },
  30. { State.Florida, new FloridaShippingCalculation() }
  31. };
  32. }
  33.  
  34. public decimal CalculateShippingAmount(State shipToState)
  35. {
  36. return ShippingCalculations[shipToState].Calculate();
  37. }
  38. }
  39.  
  40. public interface IShippingCalculation
  41. {
  42. decimal Calculate();
  43. }
  44.  
  45. public class AlaskShippingCalculation : IShippingCalculation
  46. {
  47. public decimal Calculate()
  48. {
  49. return 15m;
  50. }
  51. }
  52.  
  53. public class NewYorkShippingCalculation : IShippingCalculation
  54. {
  55. public decimal Calculate()
  56. {
  57. return 10m;
  58. }
  59. }
  60.  
  61. public class FloridaShippingCalculation : IShippingCalculation
  62. {
  63. public decimal Calculate()
  64. {
  65. return 3m;
  66. }
  67. }
  68. }

为了使这个示例圆满,我们来看看在ShippingInfo 构造函数中使用Ninject 为IoC容器时如何进行绑定。需要更改的地方很多,主要是将state 的枚举放在策略内部,以及Ninject 向构造函数传递一个IShippingInfo 的IEnumerable泛型。接下来我们使用策略类中的state属性创建字典,其余部分保持不变。(感谢Nate Kohari和Jayme Davis)

  1. public interface IShippingInfo
  2. {
  3. decimal CalculateShippingAmount(State state);
  4. }
  5.  
  6. public class ClientCode
  7. {
  8. [Inject]
  9. public IShippingInfo ShippingInfo { get; set; }
  10.  
  11. public decimal CalculateShipping()
  12. {
  13. return ShippingInfo.CalculateShippingAmount(State.Alaska);
  14. }
  15. }
  16.  
  17. public enum State
  18. {
  19. Alaska,
  20. NewYork,
  21. Florida
  22. }
  23.  
  24. public class ShippingInfo : IShippingInfo
  25. {
  26. private IDictionary<State, IShippingCalculation> ShippingCalculations
  27. { get; set; }
  28. public ShippingInfo(IEnumerable<IShippingCalculation> shippingCalculations)
  29. {
  30. ShippingCalculations = shippingCalculations.ToDictionary(
  31. calc => calc.State);
  32. }
  33.  
  34. public decimal CalculateShippingAmount(State shipToState)
  35. {
  36. return ShippingCalculations[shipToState].Calculate();
  37. }
  38. }
  39.  
  40. public interface IShippingCalculation
  41. {
  42. State State { get; }
  43. decimal Calculate();
  44. }
  45.  
  46. public class AlaskShippingCalculation : IShippingCalculation
  47. {
  48. public State State { get { return State.Alaska; } }
  49. public decimal Calculate()
  50. {
  51. return 15m;
  52. }
  53. }
  54.  
  55. public class NewYorkShippingCalculation : IShippingCalculation
  56. {
  57. public State State { get { return State.NewYork; } }
  58. public decimal Calculate()
  59. {
  60. return 10m;
  61. }
  62. }
  63.  
  64. public class FloridaShippingCalculation : IShippingCalculation
  65. {
  66. public State State { get { return State.Florida; } }
  67. public decimal Calculate()
  68. {
  69. return 3m;
  70. }
  71. }

 

代码重构第12天:分解依赖

有些单元测试需要恰当的测试“缝隙”(test seam)来模拟/隔离一些不想被测试的部分。如果你正想在代码中引入这种单元测试,那么今天介绍的重构就十分有用。在这个例子中,我们的客户端代码使用一个静态类来实现功能。但当需要单元测试时,问题就来了。我们无法在单元测试中模拟静态类。解决的方法是使用一个接口将静态类包装起来,形成一个缝隙来切断与静态类之间的依赖。

  1. public class AnimalFeedingService
  2. {
  3. private bool FoodBowlEmpty { get; set; }
  4. public void Feed()
  5. {
  6. if (FoodBowlEmpty)
  7. Feeder.ReplenishFood();
  8. // more code to feed the animal
  9. }
  10. }
  11.  
  12. public static class Feeder
  13. {
  14. public static void ReplenishFood()
  15. {
  16. // fill up bowl
  17. }
  18. }

重构时我们所要做的就是引入一个接口和简单调用上面那个静态类的类。因此行为还是一样的,只是调用的方式产生了变化。这是一个不错的重构起始点,也是向代码添加单元测试的简单方式。

  1. public class AnimalFeedingService
  2. {
  3. public IFeederService FeederService { get; set; }
  4.  
  5. public AnimalFeedingService(IFeederService feederService)
  6. {
  7. FeederService = feederService;
  8. }
  9.  
  10. private bool FoodBowlEmpty { get; set; }
  11.  
  12. public void Feed()
  13. {
  14. if (FoodBowlEmpty)
  15. FeederService.ReplenishFood();
  16. // more code to feed the animal
  17. }
  18. }
  19.  
  20. public interface IFeederService
  21. {
  22. void ReplenishFood();
  23. }
  24.  
  25. public class FeederService : IFeederService
  26. {
  27. public void ReplenishFood()
  28. {
  29. Feeder.ReplenishFood();
  30. }
  31. }
  32.  
  33. public static class Feeder
  34. {
  35. public static void ReplenishFood()
  36. {
  37. // fill up bowl
  38. }
  39. }

现在,我们可以在单元测试中将模拟的IFeederService 传入AnimalFeedingService 构造函数。测试成功后,我们可以将静态方法中的代码移植到FeederService 类中,并删除静态类。

 

代码重构第13天:提取方法对象

今天的重构来自于Martin Fowler的重构目录。在我看来,这是一个比较罕见的重构,但有时却终能派上用场。当你尝试进行提取方法的重构时,需要引入大量的方法。在一个方法中使用众多的本地变量有时会使代码变得丑陋。因此最好使用提取方法对象这个重构,将执行任务的逻辑分开。

  1. public class OrderLineItem
  2. {
  3. public decimal Price { get; private set; }
  4. }
  5.  
  6. public class Order
  7. {
  8. private IList<OrderLineItem> OrderLineItems { get; set; }
  9. private IList<decimal> Discounts { get; set; }
  10. private decimal Tax { get; set; }
  11.  
  12. public decimal Calculate()
  13. {
  14. decimal subTotal = 0m;
  15.  
  16. // Total up line items
  17. foreach (OrderLineItem lineItem in OrderLineItems)
  18. {
  19. subTotal += lineItem.Price;
  20. }
  21.  
  22. // Subtract Discounts
  23. foreach (decimal discount in Discounts)
  24. subTotal -= discount;
  25.  
  26. // Calculate Tax
  27. decimal tax = subTotal * Tax;
  28.  
  29. // Calculate GrandTotal
  30. decimal grandTotal = subTotal + tax;
  31. return grandTotal;
  32. }
  33. }

我们通过构造函数,将返回计算结果的类的引用传递给包含多个计算方法的新建对象,或者向方法对象的构造函数中单独传递各个参数。如下面的代码:

  1. public class OrderLineItem
  2. {
  3. public decimal Price { get; private set; }
  4. }
  5.  
  6. public class Order
  7. {
  8. public IEnumerable<OrderLineItem> OrderLineItems { get; private set; }
  9. public IEnumerable<decimal> Discounts { get; private set; }
  10. public decimal Tax { get; private set; }
  11.  
  12. public decimal Calculate()
  13. {
  14. return new OrderCalculator(this).Calculate();
  15. }
  16. }
  17.  
  18. public class OrderCalculator
  19. {
  20. private decimal SubTotal { get; set; }
  21. private IEnumerable<OrderLineItem> OrderLineItems { get; set; }
  22. private IEnumerable<decimal> Discounts { get; set; }
  23. private decimal Tax { get; set; }
  24.  
  25. public OrderCalculator(Order order)
  26. {
  27. OrderLineItems = order.OrderLineItems;
  28. Discounts = order.Discounts;
  29. Tax = order.Tax;
  30. }
  31.  
  32. public decimal Calculate()
  33. {
  34. CalculateSubTotal();
  35. SubtractDiscounts();
  36. CalculateTax();
  37. return SubTotal;
  38. }
  39.  
  40. private void CalculateSubTotal()
  41. {
  42. // Total up line items
  43. foreach (OrderLineItem lineItem in OrderLineItems)
  44. SubTotal += lineItem.Price;
  45. }
  46.  
  47. private void SubtractDiscounts()
  48. {
  49. // Subtract Discounts
  50. foreach (decimal discount in Discounts)
  51. SubTotal -= discount;
  52. }
  53.  
  54. private void CalculateTax()
  55. {
  56. // Calculate Tax
  57. SubTotal += SubTotal * Tax;
  58. }
  59. }

 

代码重构第14天:分离职责

把一个类的多个职责进行拆分,这贯彻了SOLID 中的单一职责原则(SRP)。尽管对于如何划分“职责”经常存在争论,但应用这项重构还是十分简单的。我这里并不会回答划分职责的问题,只是演示一个结构清晰的示例,将类划分为多个负责具体职责的类。

  1. public class Video
  2. {
  3. public void PayFee(decimal fee)
  4. {
  5. }
  6.  
  7. public void RentVideo(Video video, Customer customer)
  8. {
  9. customer.Videos.Add(video);
  10. }
  11.  
  12. public decimal CalculateBalance(Customer customer)
  13. {
  14. return customer.LateFees.Sum();
  15. }
  16. }
  17.  
  18. public class Customer
  19. {
  20. public IList<decimal> LateFees { get; set; }
  21. public IList<Video> Videos { get; set; }
  22. }

如你所见,Video类包含两个职责,一个负责处理录像租赁,另一个负责管理管理用户的租赁总数。要分离职责,我们可以将用户的逻辑转移到用户类中。

  1. public class Video
  2. {
  3. public void RentVideo(Video video, Customer customer)
  4. {
  5. customer.Videos.Add(video);
  6. }
  7. }
  8.  
  9. public class Customer
  10. {
  11. public IList<decimal> LateFees { get; set; }
  12. public IList<Video> Videos { get; set; }
  13.  
  14. public void PayFee(decimal fee)
  15. {
  16. }
  17.  
  18. public decimal CalculateBalance(Customer customer)
  19. {
  20. return customer.LateFees.Sum();
  21. }
  22. }

 

代码重构第15天:移除重复内容

这大概是处理一个方法在多处使用时最常见的重构。如果不加以注意的话,你会慢慢地养成重复的习惯。开发者常常由于懒惰或者在想要尽快生成尽可能多的代码时,向代码中添加很多重复的内容。我想也没必要过多解释了吧,直接看代码把。

  1. public class MedicalRecord
  2. {
  3. public DateTime DateArchived { get; private set; }
  4. public bool Archived { get; private set; }
  5.  
  6. public void ArchiveRecord()
  7. {
  8. Archived = true;
  9. DateArchived = DateTime.Now;
  10. }
  11.  
  12. public void CloseRecord()
  13. {
  14. Archived = true;
  15. DateArchived = DateTime.Now;
  16. }
  17. }

我们用共享方法的方式来删除重复的代码。看!没有重复了吧?请务必在必要的时候执行这项重构。它能有效地减少bug,因为你不会将有bug的代码复制/粘贴到各个角落。

  1. public class MedicalRecord
  2. {
  3. public DateTime DateArchived { get; private set; }
  4. public bool Archived { get; private set; }
  5.  
  6. public void ArchiveRecord()
  7. {
  8. SwitchToArchived();
  9. }
  10.  
  11. public void CloseRecord()
  12. {
  13. SwitchToArchived();
  14. }
  15.  
  16. private void SwitchToArchived()
  17. {
  18. Archived = true;
  19. DateArchived = DateTime.Now;
  20. }
  21. }

 

代码重构第16天:封装条件

当代码中充斥着若干条件判断时,代码的真正意图会迷失于这些条件判断之中。这时我喜欢将条件判断提取到一个易于读取的属性或方法(如果有参数)中。重构之前的代码如下:

  1. public class RemoteControl
  2. {
  3. private string[] Functions { get; set; }
  4. private string Name { get; set; }
  5. private int CreatedYear { get; set; }
  6.  
  7. public string PerformCoolFunction(string buttonPressed)
  8. {
  9. // Determine if we are controlling some extra function
  10. // that requires special conditions
  11. if (Functions.Length > 1 && Name == "RCA" &&
  12. CreatedYear > DateTime.Now.Year - 2)
  13. return "doSomething";
  14. }
  15. }

重构之后,代码的可读性更强,意图更明显:

  1. public class RemoteControl
  2. {
  3. private string[] Functions { get; set; }
  4. private string Name { get; set; }
  5. private int CreatedYear { get; set; }
  6.  
  7. private bool HasExtraFunctions
  8. {
  9. get
  10. {
  11. return Functions.Length > 1 && Name == "RCA" &&
  12. CreatedYear > DateTime.Now.Year - 2;
  13. }
  14. }
  15.  
  16. public string PerformCoolFunction(string buttonPressed)
  17. {
  18. // Determine if we are controlling some extra function
  19. // that requires special conditions
  20. if (HasExtraFunctions)
  21. return "doSomething";
  22. }
  23. }

 

代码重构第17天:提取父类

今天的重构来自于Martin Fowler的重构目录,当一个类有很多方法希望将它们“提拔”到基类以供同层次的其他类使用时,会经常使用该重构。下面的类包含两个方法,我们希望提取这两个方法并允许其他类使用。

  1. public class Dog
  2. {
  3. public void EatFood()
  4. {
  5. // eat some food
  6. }
  7.  
  8. public void Groom()
  9. {
  10. // perform grooming
  11. }
  12. }

重构之后,我们仅仅将需要的方法转移到了一个新的基类中。这很类似“Pull Up”重构,只是在重构之前,并不存在基类。

  1. public class Animal
  2. {
  3. public void EatFood()
  4. {
  5. // eat some food
  6. }
  7.  
  8. public void Groom()
  9. {
  10. // perform grooming
  11. }
  12. }
  13.  
  14. public class Dog : Animal
  15. {
  16. }

 

代码重构第18天:使用条件判断代替异常

今天的重构没有什么出处,是我平时经常使用而总结出来的。欢迎您发表任何改进意见或建议。我相信一定还有其他比较好的重构可以解决类似的问题。

我曾无数次面对的一个代码坏味道就是,使用异常来控制程序流程。您可能会看到类似的代码:

  1. public class Microwave
  2. {
  3. private IMicrowaveMotor Motor { get; set; }
  4.  
  5. public bool Start(object food)
  6. {
  7. bool foodCooked = false;
  8. try
  9. {
  10. Motor.Cook(food);
  11. foodCooked = true;
  12. }
  13. catch (InUseException)
  14. {
  15. foodcooked = false;
  16. }
  17. return foodCooked;
  18. }
  19. }

异常应该仅仅完成自己的本职工作:处理异常行为。大多数情况你都可以将这些代码用恰当的条件判断替换,并进行恰当的处理。下面的代码可以称之为契约式设计,因为我们在执行具体工作之前明确了Motor类的状态,而不是通过异常来进行处理。

  1. public class Microwave
  2. {
  3. private IMicrowaveMotor Motor { get; set; }
  4. public bool Start(object food)
  5. {
  6. if (Motor.IsInUse)
  7. return false;
  8. Motor.Cook(food);
  9. return true;
  10. }
  11. }

 

代码重构第19天:提取工厂类

今天的重构是由GangOfFour首先提出的,网络上有很多关于该模式不同的用法。

在代码中,通常需要一些复杂的对象创建工作,以使这些对象达到一种可以使用的状态。通常情况下,这种创建不过是新建对象实例,并以我们需要的方式进行工作。但是,有时候这种创建对象的需求会极具增长,并且混淆了创建对象的原始代码。这时,工厂类就派上用场了。最复杂的工厂模式是使用抽象工厂创建对象族。而我们只是使用最基本的方式,用一个工厂类创建
一个特殊类的实例。来看下面的代码:

  1. public class PoliceCarController
  2. {
  3. public PoliceCar New(int mileage, bool serviceRequired)
  4. {
  5. PoliceCar policeCar = new PoliceCar();
  6. policeCar.ServiceRequired = serviceRequired;
  7. policeCar.Mileage = mileage;
  8. return policeCar;
  9. }
  10. }

如您所见,New方法负责创建PoliceCar并根据一些外部输入初始化PoliceCar的某些属性。对于简单的创建工作来说,这样做可以从容应对。但是久而久之,创建的工作量越来越大,并且被附加在controller 类上,但这并不是controller类的职责。这时,我们可以将创建代码提取到一个Factory类中去,由该类负责PoliceCar实例的创建。

  1. public interface IPoliceCarFactory
  2. {
  3. PoliceCar Create(int mileage, bool serviceRequired);
  4. }
  5.  
  6. public class PoliceCarFactory : IPoliceCarFactory
  7. {
  8. public PoliceCar Create(int mileage, bool serviceRequired)
  9. {
  10. PoliceCar policeCar = new PoliceCar();
  11. policeCar.ReadForService = serviceRequired;
  12. policeCar.Mileage = mileage;
  13. return policeCar;
  14. }
  15. }
  16.  
  17. public class PoliceCarController
  18. {
  19. public IPoliceCarFactory PoliceCarFactory { get; set; }
  20. public PoliceCarController(IPoliceCarFactory policeCarFactory)
  21. {
  22. PoliceCarFactory = policeCarFactory;
  23. }
  24.  
  25. public PoliceCar New(int mileage, bool serviceRequired)
  26. {
  27. return PoliceCarFactory.Create(mileage, serviceRequired);
  28. }
  29. }

由于将创建的逻辑转移到了工厂中,我们可以添加一个类来专门负责实例的创建,而不必担心在创建或复制代码的过程中有所遗漏。

 

代码重构第20天:提取子类

今天的重构来自于Martin Fowler的模式目录。你可以在他的目录中找到该重构。

当一个类中的某些方法并不是面向所有的类时,可以使用该重构将其迁移到子类中。我这里举的例子十分简单,它包含一个Registration类,该类处理与学生注册课程相关的所有信息。

  1. public class Registration
  2. {
  3. public NonRegistrationAction Action { get; set; }
  4. public decimal RegistrationTotal { get; set; }
  5. public string Notes { get; set; }
  6. public string Description { get; set; }
  7. public DateTime RegistrationDate { get; set; }
  8. }

当使用了该类之后,我们就会意识到问题所在——它应用于两个完全不同的场景。属性NonRegistrationAction和Notes 只有在处理与普通注册略有不同的NonRegistration 时才会使用。因此,我们可以提取一个子类,并将这两个属性转移到NonRegistration类中,这样才更合适。

  1. public class Registration
  2. {
  3. public decimal RegistrationTotal { get; set; }
  4. public string Description { get; set; }
  5. public DateTime RegistrationDate { get; set; }
  6. }
  7.  
  8. public class NonRegistration : Registration
  9. {
  10. public NonRegistrationAction Action { get; set; }
  11. public string Notes { get; set; }
  12. }

 

代码重构第21天:合并继承

今天的重构来自于Martin Fowler的模式目录。你可以在他的目录中找到该重构。昨天,我们通过提取子类来下放职责。而今天,当我们意识到不再需要某个子类时,可以使用Collapse Hierarchy 重构。如果某个子类的属性(以及其他成员)可以被合并到基类中,这时再保留这个子类已经没有任何意义了。

  1. public class Website
  2. {
  3. public string Title { get; set; }
  4. public string Description { get; set; }
  5. public IEnumerable<Webpage> Pages { get; set; }
  6. }
  7.  
  8. public class StudentWebsite : Website
  9. {
  10. public bool IsActive { get; set; }
  11. }

这里的子类并没有过多的功能,只是表示站点是否激活。这时我们会意识到判断站点是否激活的功能应该是通用的。因此可以将子类的功能放回到Website 中,并删除StudentWebsite 类型。

  1. public class Website
  2. {
  3. public string Title { get; set; }
  4. public string Description { get; set; }
  5. public IEnumerable<Webpage> Pages { get; set; }
  6. public bool IsActive { get; set; }
  7. }

 

代码重构第22天:分解方法

今天的重构没有任何出处。可能已经有其他人使用了相同的重构,只是名称不同罢了。如果你知道谁的名字比Break Method更好,请转告我。

这个重构是一种元重构(meta-refactoring),它只是不停地使用提取方法重构,直到将一个大的方法分解成若干个小的方法。下面的例子有点做作,AcceptPayment 方法没有丰富的功能。因此为了使其更接近真实场景,我们只能假设该方法中包含了其他大量的辅助代码。

下面的AcceptPayment 方法可以被划分为多个单独的方法。

  1. public class CashRegister
  2. {
  3. public CashRegister()
  4. {
  5. Tax = 0.06m;
  6. }
  7.  
  8. private decimal Tax { get; set; }
  9. public void AcceptPayment(Customer customer, IEnumerable<Product> products, decimal payment)
  10. {
  11. decimal subTotal = 0m;
  12.  
  13. foreach (Product product in products)
  14. {
  15. subTotal += product.Price;
  16. }
  17.  
  18. foreach (Product product in products)
  19. {
  20. subTotal -= product.AvailableDiscounts;
  21. }
  22.  
  23. decimal grandTotal = subTotal * Tax;
  24. customer.DeductFromAccountBalance(grandTotal);
  25. }
  26. }
  27.  
  28. public class Customer
  29. {
  30. public void DeductFromAccountBalance(decimal amount)
  31. {
  32. // deduct from balance
  33. }
  34. }
  35.  
  36. public class Product
  37. {
  38. public decimal Price { get; set; }
  39. public decimal AvailableDiscounts { get; set; }
  40. }

如您所见,AcceptPayment方法包含多个功能,可以被分解为多个子方法。因此我们多次使用提取方法重构,结果如下:

  1. public class CashRegister
  2. {
  3. public CashRegister()
  4. {
  5. Tax = 0.06m;
  6. }
  7.  
  8. private decimal Tax { get; set; }
  9. private IEnumerable<Product> Products { get; set; }
  10.  
  11. public void AcceptPayment(Customer customer, IEnumerable<Product> products, decimal payment)
  12. {
  13. decimal subTotal = CalculateSubtotal();
  14. subTotal = SubtractDiscounts(subTotal);
  15. decimal grandTotal = AddTax(subTotal);
  16. SubtractFromCustomerBalance(customer, grandTotal);
  17. }
  18.  
  19. private void SubtractFromCustomerBalance(Customer customer, decimal grandTotal)
  20. {
  21. customer.DeductFromAccountBalance(grandTotal);
  22. }
  23.  
  24. private decimal AddTax(decimal subTotal)
  25. {
  26. return subTotal * Tax;
  27. }
  28.  
  29. private decimal SubtractDiscounts(decimal subTotal)
  30. {
  31. foreach (Product product in Products)
  32. {
  33. subTotal -= product.AvailableDiscounts;
  34. }
  35. return subTotal;
  36. }
  37.  
  38. private decimal CalculateSubtotal()
  39. {
  40. decimal subTotal = 0m;
  41. foreach (Product product in Products)
  42. {
  43. subTotal += product.Price;
  44. }
  45. return subTotal;
  46. }
  47. }
  48.  
  49. public class Customer
  50. {
  51. public void DeductFromAccountBalance(decimal amount)
  52. {
  53. // deduct from balance
  54. }
  55. }
  56.  
  57. public class Product
  58. {
  59. public decimal Price { get; set; }
  60. public decimal AvailableDiscounts { get; set; }
  61. }

 

代码重构第23天:引入参数对象

该重构来自于Fowler的重构目录。有时当使用一个包含多个参数的方法时,由于参数过多会导致可读性严重下降,如:

  1. public void Create(decimal amount, Student student, IEnumerable<Course> courses, decimal credits)
  2. {
  3. // do work
  4. }

这时有必要新建一个类,负责携带方法的参数。如果要增加更多的参数,只需为对参数对象增加其他的字段就可以了,代码显得更加灵活。要注意,仅仅在方法的参数确实过多时才使用该重构,否则会使类的数量暴增,而这本应该越少越好。

  1. public class RegistrationContext
  2. {
  3. public decimal Amount { get; set; }
  4. public Student Student { get; set; }
  5. public IEnumerable<Course> Courses { get; set; }
  6. public decimal Credits { get; set; }
  7. }
  8.  
  9. public class Registration
  10. {
  11. public void Create(RegistrationContext registrationContext)
  12. {
  13. // do work
  14. }
  15. }

 

代码重构第24天:分解复杂判断

今天的重构基于c2的wiki条目。Los Techies的Chris Missal同样也些了一篇关于反模式的post。简单地说,当你使用大量的嵌套条件判断时,形成了箭头型的代码,这就是箭头反模式(arrowhead
antipattern)。我经常在不同的代码库中看到这种现象,这提高了代码的圈复杂度(cyclomatic complexity)。下面的例子演示了箭头反模式:

  1. public class Security
  2. {
  3. public ISecurityChecker SecurityChecker { get; set; }
  4. public Security(ISecurityChecker securityChecker)
  5. {
  6. SecurityChecker = securityChecker;
  7. }
  8.  
  9. public bool HasAccess(User user, Permission permission, IEnumerable<Permission> exemptions)
  10. {
  11. bool hasPermission = false;
  12. if (user != null)
  13. {
  14. if (permission != null)
  15. {
  16. if (exemptions.Count() == 0)
  17. {
  18. if (SecurityChecker.CheckPermission(user, permission) || exemptions.Contains(permission))
  19. {
  20. hasPermission = true;
  21. }
  22. }
  23. }
  24. }
  25. return hasPermission;
  26. }
  27. }

移除箭头反模式的重构和封装条件判断一样简单。这种方式的重构在方法执行之前往往会评估各个条件,这有点类似于契约式设计验证。下面是重构之后的代码:

  1. public class Security
  2. {
  3. public ISecurityChecker SecurityChecker { get; set; }
  4.  
  5. public Security(ISecurityChecker securityChecker)
  6. {
  7. SecurityChecker = securityChecker;
  8. }
  9.  
  10. public bool HasAccess(User user, Permission permission, IEnumerable<Permission> exemptions)
  11. {
  12. if (user == null || permission == null)
  13. return false;
  14.  
  15. if (exemptions.Contains(permission))
  16. return true;
  17. return SecurityChecker.CheckPermission(user, permission);
  18. }
  19. }

如你所见,该方法大大整价了可读性和以后的可维护性。不难看出,该方法的所有可能的路径都会经过验证。

 

代码重构第25天:引入契约式设计

契约式设计(DBC,Design By Contract)定义了方法应该包含输入和输出验证。因此,可以确保所有的工作都是基于可用的数据,并且所有的行为都是可预料的。否则,将返回异常或错误并在方法中进行处理。要了解更多关于DBC的内容,可以访问wikipedia。

在我们的示例中,输入参数很可能为null。由于没有进行验证,该方法最终会抛出NullReferenceException。在方法最后,我们也并不确定是否为用户返回了一个有效的decimal,这可能导致在别的地方引入其他方法。

  1. public class CashRegister
  2. {
  3. public decimal TotalOrder(IEnumerable<Product> products, Customer customer)
  4. {
  5. decimal orderTotal = products.Sum(product => product.Price);
  6. customer.Balance += orderTotal;
  7. return orderTotal;
  8. }
  9. }

在此处引入DBC 验证是十分简单的。首先,我们要声明customer 不能为null,并且在计算总值时至少要有一个product。在返回订单总值时,我们要确定其值是否有效。如果此例中任何一个验证失败,我们将以友好的方式抛出相应的异常来描述具体信息,而不是抛出一个晦涩的NullReferenceException。

在.NET Framework 3.5的Microsoft.Contracts命名空间中包含一些DBC框架和异常。我个人还没有使用,但它们还是值得一看的。关于该命名空间只有在MSDN上能找到点资料。

  1. public class CashRegister
  2. {
  3. public decimal TotalOrder(IEnumerable<Product> products, Customer customer)
  4. {
  5. if (customer == null)
  6. throw new ArgumentNullException("customer", "Customer cannot be null");
  7. if (products.Count() == 0)
  8. throw new ArgumentException("Must have at least one product to total", "products");
  9.  
  10. decimal orderTotal = products.Sum(product => product.Price);
  11. customer.Balance += orderTotal;
  12.  
  13. if (orderTotal == 0)
  14. throw new ArgumentOutOfRangeException("orderTotal", "Order Total should not be zero");
  15.  
  16. return orderTotal;
  17. }
  18. }

在验证过程中确实增加了不少代码,你也许会认为过度使用了DBC。但我认为在大多数情况下,处理这些棘手的问题所做的努力都是值得的。追踪无详细内容的NullReferenceException的确不是什么美差。

 

代码重构第26天:避免双重否定

今天的重构来自于Fowler的重构目录。
尽管我在很多代码中发现了这种严重降低可读性并往往传达错误意图的坏味道,但这种重构本身还是很容易实现的。这种毁灭性的代码所基于的假设导致了错误的代码编写习惯,并最终导致bug。如下例所示:

  1. public class Order
  2. {
  3. public void Checkout(IEnumerable<Product> products, Customer customer)
  4. {
  5. if (!customer.IsNotFlagged)
  6. {
  7. // the customer account is flagged
  8. // log some errors and return
  9. return;
  10. }
  11.  
  12. // normal order processing
  13. }
  14. }
  15.  
  16. public class Customer
  17. {
  18. public decimal Balance { get; private set; }
  19.  
  20. public bool IsNotFlagged
  21. {
  22. get { return Balance < 30m; }
  23. }
  24. }

如你所见,这里的双重否定十分难以理解,我们不得不找出什么才是双重否定所要表达的肯定状态。修改代码是很容易的。如果我们找不到肯定的判断,可以添加一个处理双重否定的假设,而不要在得到结果之后再去验证。

  1. public class Order
  2. {
  3. public void Checkout(IEnumerable<Product> products, Customer customer)
  4. {
  5. if (customer.IsFlagged)
  6. {
  7. // the customer account is flagged
  8. // log some errors and return
  9. return;
  10. }
  11.  
  12. // normal order processing
  13. }
  14. }
  15.  
  16. public class Customer
  17. {
  18. public decimal Balance { get; private set; }
  19.  
  20. public bool IsFlagged
  21. {
  22. get { return Balance >= 30m; }
  23. }
  24. }

 

代码重构第27天:去除上帝类

在传统的代码库中,我们常常会看到一些违反了SRP原则的类。这些类通常以Utils或Manager结尾,有时也没有这么明显的特征而仅仅是普通的包含多个功能的类。这种God 类还有一个特征,使用语句或注释将代码分隔为多个不同角色的分组,而这些角色正是这一个类所扮演的。

久而久之,这些类成为了那些没有时间放置到恰当类中的方法的垃圾桶。这时的重构需要将方法分解成多个负责单一职责的类。

  1. public class CustomerService
  2. {
  3. public decimal CalculateOrderDiscount(IEnumerable<Product> products, Customer customer)
  4. {
  5. // do work
  6. }
  7.  
  8. public bool CustomerIsValid(Customer customer, Order order)
  9. {
  10. // do work
  11. }
  12.  
  13. public IEnumerable<string> GatherOrderErrors(IEnumerable<Product> products, Customer customer)
  14. {
  15. // do work
  16. }
  17.  
  18. public void Register(Customer customer)
  19. {
  20. // do work
  21. }
  22.  
  23. public void ForgotPassword(Customer customer)
  24. {
  25. // do work
  26. }
  27. }

使用该重构是非常简单明了的,只需把相关方法提取出来并放置到负责相应职责的类中即可。这使得类的粒度更细、职责更分明、日后的维护更方便。上例的代码最终被分解为两个类:

  1. public class CustomerOrderService
  2. {
  3. public decimal CalculateOrderDiscount(IEnumerable<Product> products, Customer customer)
  4. {
  5. // do work
  6. }
  7.  
  8. public bool CustomerIsValid(Customer customer, Order order)
  9. {
  10. // do work
  11. }
  12.  
  13. public IEnumerable<string> GatherOrderErrors(IEnumerable<Product> products, Customer customer)
  14. {
  15. // do work
  16. }
  17. }
  18.  
  19. public class CustomerRegistrationService
  20. {
  21. public void Register(Customer customer)
  22. {
  23. // do work
  24. }
  25.  
  26. public void ForgotPassword(Customer customer)
  27. {
  28. // do work
  29. }
  30. }

 

代码重构第28天:为布尔方法命名

今天的重构不是来自于Fowler的重构目录。如果谁知道这项“重构”的确切出处,请告诉我。

当然,你也可以说这并不是一个真正的重构,因为方法实际上改变了,但这是一个灰色地带,可以开放讨论。一个拥有大量布尔类型参数的方法将很快变得无法控制,产生难以预期的行为。参数的数量将决定分解的方法的数量。来看看该重构是如何开始的:

  1. public class BankAccount
  2. {
  3. public void CreateAccount(Customer customer, bool withChecking, bool withSavings, bool withStocks)
  4. {
  5. // do work
  6. }
  7. }

要想使这样的代码运行得更好,我们可以通过命名良好的方法暴露布尔参数,并将原始方法更改为private以阻止外部调用。显然,你可能需要进行大量的代码转移,也许重构为一个Parameter Object 会更有意义。

  1. public class BankAccount
  2. {
  3. public void CreateAccountWithChecking(Customer customer)
  4. {
  5. CreateAccount(customer, true, false);
  6. }
  7.  
  8. public void CreateAccountWithCheckingAndSavings(Customer customer)
  9. {
  10. CreateAccount(customer, true, true);
  11. }
  12.  
  13. private void CreateAccount(Customer customer, bool withChecking, bool withSavings)
  14. {
  15. // do work
  16. }
  17. }

 

代码重构第29天:去除中间人对象

今天的重构来自于Fowler的重构目录。

有时你的代码里可能会存在一些“Phantom”或“Ghost”类,Fowler 称之为“中间人(Middle Man)”。这些中间人类仅仅简单地将调用委托给其他组件,除此之外没有任何功能。这一层是完全没有必要的,我们可以不费吹灰之力将其完全移除。

  1. public class Consumer
  2. {
  3. public AccountManager AccountManager { get; set; }
  4.  
  5. public Consumer(AccountManager accountManager)
  6. {
  7. AccountManager = accountManager;
  8. }
  9.  
  10. public void Get(int id)
  11. {
  12. Account account = AccountManager.GetAccount(id);
  13. }
  14. }
  15.  
  16. public class AccountManager
  17. {
  18. public AccountDataProvider DataProvider { get; set; }
  19.  
  20. public AccountManager(AccountDataProvider dataProvider)
  21. {
  22. DataProvider = dataProvider;
  23. }
  24.  
  25. public Account GetAccount(int id)
  26. {
  27. return DataProvider.GetAccount(id);
  28. }
  29. }
  30.  
  31. public class AccountDataProvider
  32. {
  33. public Account GetAccount(int id)
  34. {
  35. // get account
  36. }
  37. }

最终结果已经足够简单了。我们只需要移除中间人对象,将原始调用指向实际的接收者。

  1. public class Consumer
  2. {
  3. public AccountDataProvider AccountDataProvider { get; set; }
  4.  
  5. public Consumer(AccountDataProvider dataProvider)
  6. {
  7. AccountDataProvider = dataProvider;
  8. }
  9.  
  10. public void Get(int id)
  11. {
  12. Account account = AccountDataProvider.GetAccount(id);
  13. }
  14. }
  15.  
  16. public class AccountDataProvider
  17. {
  18. public Account GetAccount(int id)
  19. {
  20. // get account
  21. }
  22. }

 

代码重构第30天:尽快返回

该话题实际上是诞生于移除箭头反模式重构之中。在移除箭头时,它被认为是重构产生的副作用。为了消除箭头,你需要尽快地return。

  1. public class Order
  2. {
  3. public Customer Customer { get; private set; }
  4. public decimal CalculateOrder(Customer customer, IEnumerable<Product> products, decimal discounts)
  5. {
  6. Customer = customer;
  7. decimal orderTotal = 0m;
  8.  
  9. if (products.Count() > 0)
  10. {
  11. orderTotal = products.Sum(p => p.Price);
  12. if (discounts > 0)
  13. {
  14. orderTotal -= discounts;
  15. }
  16. }
  17. return orderTotal;
  18. }
  19. }

该重构的理念就是,当你知道应该处理什么并且拥有全部需要的信息之后,立即退出所在方法,不再继续执行。

  1. public class Order
  2. {
  3. public Customer Customer { get; private set; }
  4.  
  5. public decimal CalculateOrder(Customer customer, IEnumerable<Product> products, decimal discounts)
  6. {
  7. if (products.Count() == 0)
  8. return 0;
  9.  
  10. Customer = customer;
  11. decimal orderTotal = products.Sum(p => p.Price);
  12. if (discounts == 0)
  13. return orderTotal;
  14. orderTotal -= discounts;
  15. return orderTotal;
  16. }
  17. }

 

代码重构第31天:使用多态代替条件判断

最后一天的重构来自于Fowler的重构目录。

多态(Polymorphism)是面向对象编程的基本概念之一。在这里,是指在进行类型检查和执行某些类型操作时,最好将算法封装在类中,并且使用多态来对代码中的调用进行抽象。

  1. public abstract class Customer
  2. {
  3. }
  4.  
  5. public class Employee : Customer
  6. {
  7. }
  8.  
  9. public class NonEmployee : Customer
  10. {
  11. }
  12.  
  13. public class OrderProcessor
  14. {
  15. public decimal ProcessOrder(Customer customer, IEnumerable<Product> products)
  16. {
  17. // do some processing of order
  18. decimal orderTotal = products.Sum(p => p.Price);
  19. Type customerType = customer.GetType();
  20. if (customerType == typeof(Employee))
  21. {
  22. orderTotal -= orderTotal * 0.15m;
  23. }
  24. else if (customerType == typeof(NonEmployee))
  25. {
  26. orderTotal -= orderTotal * 0.05m;
  27. }
  28. return orderTotal;
  29. }
  30. }

如你所见,我们没有利用已有的继承层次进行计算,而是使用了违反SRP 原则的执行方式。要进行重构,我们只需将百分率的计算置于实际的customer类型之中。我知道这只是一项补救措施,但我还是会这么做,就像在代码中那样。

  1. public abstract class Customer
  2. {
  3. public abstract decimal DiscountPercentage { get; }
  4. }
  5.  
  6. public class Employee : Customer
  7. {
  8. public override decimal DiscountPercentage
  9. {
  10. get { return 0.15m; }
  11. }
  12. }
  13.  
  14. public class NonEmployee : Customer
  15. {
  16. public override decimal DiscountPercentage
  17. {
  18. get { return 0.05m; }
  19. }
  20. }
  21.  
  22. public class OrderProcessor
  23. {
  24. public decimal ProcessOrder(Customer customer, IEnumerable<Product> products)
  25. {
  26. // do some processing of order
  27. decimal orderTotal = products.Sum(p => p.Price);
  28. orderTotal -= orderTotal * customer.DiscountPercentage;
  29. return orderTotal;
  30. }
  31. }

至此,恭喜你,完成了31天的代码重构学习。

常用的代码重构方法

一.提取子函数 说白了就是一个大函数里,可以根据不同功能分成几个小函数,因为说不定,其他函数也可能会用到其中的函数 二.把大家都要用的方法放到父类中     所有对象都要执行同一个方法,那就把这个方法...

重构技巧

重构 重构指在不改变程序原有行为的基础上,对既有代码进行修改,以改进其内部结构。何时应该重构 添加功能时重构,修复bug时重构,代码评审时重构;何时不应重构 既有代码太过混乱或不能正常运作,项目...

重构的几点注意事项

最近又温习了一遍Martin Flower的经典名著《重构:改善既有代码的设计》,感触颇多,应该总结一下: 1. 重构是减缓代码腐化的有效武器 现在很少有软件完全是从0开始开发,也很少有软...

代码重构意义和方法

摘要:很多人认为重构浪费时间,影响项目进度,其实重构不仅可以让我们的代码更加强壮而且还可以加快我们的项目进度。就和我们盖一个高楼大厦一样,我们的架构和地基越好,我们的楼房会越坚固和牢靠。 一、什么是...

分布式架构之系统拆分

系统拆分是单体程序向分布式系统演变的关键一步,也是很重要的一步,拆分的好坏直接关系到未来系统的扩展性、可维护性和可伸缩性等,拆分工作不难理解,但是如何正确拆分、有什么样的方法和原则能帮助我们拆分得到一...
  • Zzz34k
  • Zzz34k
  • 2016年09月18日 18:26
  • 4589

重构的常用思路

本文是在学习中的总结,欢迎转载但请注明出处:http://blog.csdn.net/pistolove/article/details/42041757        在重构入...

怎样写出漂亮整洁的代码?聊聊clean code的编码、重构技巧

本文从clean code的几个大前提出发,提出了实践clean code的一些手段,重点放在促成clean code的一些常用编码和重构技巧。本文只代表笔者本人的一点点感悟。好的代码,最需要的,还是...

代码重构的技巧

代码重构的要点

最实用的代码重构小技巧排行榜TOP10

最实用的代码重构小技巧排行榜TOP10
  • xhmj12
  • xhmj12
  • 2016年04月26日 15:34
  • 2831

eclispe技巧全解(包括代码重构,调试,快捷方式)

1.更换当前的工作空间:File -> switch workspace -> other 然后选择你要使用的工作空间 2.启动时显示选择工作空间的提示: Window->Preferences->...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:代码重构技巧
举报原因:
原因补充:

(最多只允许输入30个字)