class Customer {
  get plan() {return this._plan;}
  get discountRate() {return this._discountRate;}
 
 
  class Customer {
  get plan() {return this._plan;}
  get discountRate() {return this.plan.discountRate;}

动机

编程活动中你需要编写许多代码,为系统实现特定的行为,但往往数据结构才是一个健壮程序的根基。一个适应于问题域的良好数据结构,可以让行为代码变得简单明了,而一个糟糕的数据结构则将招致许多无用代码,这些代码更多是在差劲的数据结构中间纠缠不清,而非为系统实现有用的行为。代码凌乱,势必难以理解;不仅如此,坏的数据结构本身也会掩藏程序的真实意图。

因此,好的数据结构至关重要——不过这也与编程活动的许多方面一样,它们都很难一次做对。我通常都会做些预先的设计,设法得到最恰当的数据结构,此时如果你具备一些领域驱动设计(domain-driven design)方面的经验和知识,往往有助于你更好地设计数据结构。但即便经验再丰富,技能再熟练,我仍然发现我在进行初版设计时往往还是会犯错。在不断编程的过程中,我对问题域的理解会加深,对“什么是理想的数据结构”会有更多想法。这个星期看来合理而正确的设计决策,到了下个星期可能就不再正确了。

如果我发现数据结构已经不适应于需求,就应该马上修缮它。如果容许瑕疵存在并进一步累积,它们就会经常使我困惑,并且使代码愈来愈复杂。

我开始寻思搬移数据,可能是因为我发现每当调用某个函数时,除了传入一个记录参数,还总是需要同时传入另一条记录的某个字段一起作为参数。总是一同出现、一同作为函数参数传递的数据,最好是规整到同一条记录中,以体现它们之间的联系。修改的难度也是引起我注意的一个原因,如果修改一条记录时,总是需要同时改动另一条记录,那么说明很可能有字段放错了位置。此外,如果我更新一个字段时,需要同时在多个结构中做出修改,那也是一个征兆,表明该字段需要被搬移到一个集中的地点,这样每次只需修改一处地方。

搬移字段的操作通常是在其他更大的改动背景下发生的。实施字段搬移后,我可能会发现字段的诸多使用者应该通过目标对象来访问它,而不应该再通过源对象来访问。诸如此类的清理,我会在此后的重构中一并完成。同样,我也可能因为字段当前的一些用法而无法直接搬移它。我得先对其使用方式做一些重构,然后才能继续搬移工作。

到目前为止,我用以指称数据结构的术语都是“记录”(record),但以上论述对类和对象同样适用。类只是一种多了实例函数的记录,它与其他任何数据结构一样,都需要保持健康。不过类的实例函数确实简化了搬移数据的操作,因为它已经将数据的存取封装到访问函数中。当我搬移数据时,只需要相应修改访问函数的引用,该字段的所有客户端依然可以正常工作。因此,如果你的数据已经用类进行了封装,那么这个重构手法会更容易进行,我下面的展开也做了“通过类封装的数据更容易搬移”这个假设。如果你要搬移的数据是裸记录,没有任何封装,虽然类似的搬移仍然能够进行,但情况就会复杂一些。

做法

确保源字段已经得到了良好封装。

测试。

在目标对象上创建一个字段(及对应的访问函数)。

执行静态检查。

确保源对象里能够正常引用目标对象。

也许你已经有现成的字段或方法得到目标对象。如果没有,看看是否能简单地创建一个方法完成此事。如果还是不行,你可能就得在源对象里创建一个字段,用于存储目标对象了。这次修改可能留存很久,但你也可以只做临时修改,等到系统其他部分的重构完成就回来移除它。

调整源对象的访问函数,令其使用目标对象的字段。

如果源类的所有实例对象都共享对目标对象的访问权,那么可以考虑先更新源类的设值函数,让它修改源字段时,对目标对象上的字段做同样的修改。然后,再通过引入断言(302),当检测到源字段与目标字段不一致时抛出错误。一旦你确定改动没有引入任何可观察的行为变化,就可以放心地让访问函数直接使用目标对象的字段了。

测试。

移除源对象上的字段。

测试。

范例

我将用下面这个例子来介绍这项手法,其中 Customer 类代表了一位“顾客”,CustomerContract 代表与顾客关联的一个“合同”。

class Customer…

  constructor(name, discountRate) {
 this._name = name;
 this._discountRate = discountRate;
 this._contract = new CustomerContract(dateToday());
}
get discountRate() {return this._discountRate;}
becomePreferred() {
 this._discountRate += 0.03;
 // other nice things
}
applyDiscount(amount) {
 return amount.subtract(amount.multiply(this._discountRate));
}

class CustomerContract…

  constructor(startDate) {
  this._startDate = startDate;
}

我想要将折扣率(discountRate)字段从 Customer 类中搬移到 CustomerContract 里中。

第一件事情是先用封装变量(132)将对_discountRate 字段的访问封装起来。

class Customer…

  constructor(name, discountRate) {
 this._name = name;
 this._setDiscountRate(discountRate);
 this._contract = new CustomerContract(dateToday());
}
get discountRate() {return this._discountRate;}
_setDiscountRate(aNumber) {this._discountRate = aNumber;}
becomePreferred() {
 this._setDiscountRate(this.discountRate + 0.03);
 // other nice things
}
applyDiscount(amount)  {
 return amount.subtract(amount.multiply(this.discountRate));
}

我通过定制的 applyDiscount 方法来更新字段,而不是使用通常的设值函数,这是因为我不想为字段暴露一个 public 的设值函数。

接着我在 CustomerContract 中添加一个对应的字段和访问函数。

class CustomerContract…

  constructor(startDate, discountRate) {
 this._startDate = startDate;
 this._discountRate = discountRate;
}
get discountRate()  {return this._discountRate;}
set discountRate(arg) {this._discountRate = arg;}

接下来,我可以修改 customer 对象的访问函数,让它引用 CustomerContract 这个新添的字段。不过当我这么干时,我收到了一个错误:“Cannot set property ‘discountRate’ of undefined”。这是因为我们先调用了 _setDiscountRate 函数,而此时 CustomerContract 对象尚未创建出来。为了修复这个错误,我得先撤销刚刚的代码,回到上一个可工作的状态,然后再应用移动语句(223)手法,将_setDiscountRate 函数调用语句挪动到创建对象的语句之后。

class Customer…

  constructor(name, discountRate) {
  this._name = name;
  this._setDiscountRate(discountRate);
  this._contract = new CustomerContract(dateToday());
}

搬移完语句后运行一下测试。测试通过后,再次修改 Customer 的访问函数,让它使用_contract 对象上的 discountRate 字段。

class Customer…

  get discountRate() {return this._contract.discountRate;}
_setDiscountRate(aNumber) {this._contract.discountRate = aNumber;}

在 JavaScript 中,使用类的字段无须事先声明,因此替换完访问函数,实际上已经没有其他字段再需要我删除。

搬移裸记录

搬移字段这项重构手法对于类的实例对象通常较易进行,因为将数据访问包装到方法中,是类所天然支持的一种封装手段。如果我要搬移的字段是裸记录,并且被许多函数直接访问,那么这项重构仍然很有意义,只不过情况会复杂不少。

我可以先为记录创建相应的访问函数,并修改所有读取和更新记录的地方,使它们引用新创建的访问函数。如果待搬移的字段是不可变(immutable)的,那么我可以在设值函数中同时更新源字段和目标字段,然后再逐步迁移读取记录的调用点。不过,我依然会尽可能先用封装记录(162)手法将记录封装成类,如此一来后续修改会更加简单。

范例:搬移字段到共享对象

现在,让我们看另外一个场景。还是那个代表“账户”的 Account 类,类上有一个代表“利率”的字段_interestRate。

class Account…

constructor(number, type, interestRate) {
 this._number = number;
 this._type = type;
 this._interestRate = interestRate;
}
get interestRate() {return this._interestRate;}

class AccountType…

constructor(nameString) {
  this._name = nameString;
}

我不希望让每个账户自己维护一个利率字段,利率应该取决于账户本身的类型,因此我想将它搬移到 AccountType 中去。

利率字段已经通过访问函数得到了良好的封装,因此我只需要在 AccountType 上创建对应的字段及访问函数即可。

class AccountType…

constructor(nameString, interestRate) {
  this._name = nameString;
  this._interestRate = interestRate;
}
get interestRate() {return this._interestRate;}

接着我应该着手替换 Account 类的访问函数,但我发现直接替换可能有个潜藏的问题。在重构之前,每个账户都自己维护一份利率数据,而现在我要让所有相同类型的账户共享同一个利率值。如果当前类型相同的账户确实拥有相同的利率,那么这次重构就能成立,因为这不会引起可观测的行为变化。但只要存在一个特例,即同一类型的账户可能有不同的利率值,那么这样的修改就不叫重构了,因为它会改变系统的可观测行为。倘若账户的数据保存在数据库中,那我就应该检查一下数据库,确保同一类型的账户都拥有与其账户类型匹配的利率值。同时,我还可以在 Account 类引入断言(302),确保出现异常的利率数据时能够及时发现。

class Account…

constructor(number, type, interestRate) {
  this._number = number;
  this._type = type;
  assert(interestRate === this._type.interestRate);
  this._interestRate = interestRate;
}
get interestRate() {return this._interestRate;}

我会保留这条断言,让系统先运行一段时间,看看是否会在这捕获到错误。或者,除了添加断言,我还可以将错误记录到日志里。一段时间后,一旦我对代码变得更加自信,确定它确实没有引起行为变化后,我就可以让 Account 直接访问 AccountType 上的 interestRate 字段,并将原来的字段完全删除了。

class Account…

constructor(number, type) {
  this._number = number;
  this._type = type;
}
get interestRate() {return this._type.interestRate;}