Introduce Explaining Variable (引入解释性变量)

Summary：

将一个复杂表达式（或其中一部分）的结果放进一个临时变量，以此变量名称来解释表达式用途。

Motivation：

表达式有可能非常复杂而难以阅读。这种情况下，临时变量可以帮助你将表达式分解为比较容易的管理形式。

Mechanics：

1. 声明一个final临时变量，将待分解之复杂表达式中的一部分动作的运算结果赋值给它。

2.将表达式中的“运算结果”这一部分，替换为上述临时变量。

•     如果被替换的这一部分在代码中重复出现，可以每次一个，逐一替换

3.编译，测试。

4.重复上述过程，处理表达式的其他部分。

范例：

从一个简单的计算开始：

double price()
    {
        //price is base price - quantity discount + shipping
        return _quantity * _itemPrice - 
               Math.max( 0, _quantity - 500 ) * _itemPrice * 0.05 +
               Math.min( _quantity * _itemPrice * 0.1, 100.0 );
    }

  这段代码不算复杂，不过我们可以让它变得更容易理解。首先，底价（basePrice）等于数量（quantity）乘以单价（itemPrice）。我们把这一部分的结果放进一个临时变量中：

double price1(){
      //price is base price - quantity discount + shipping
        final double basePrice = _quantity * _itemPrice;
        return basePrice - 
               Math.max( 0, _quantity - 500 ) * _itemPrice * 0.05 +
               Math.min( _quantity * _itemPrice * 0.1, 100.0 );
    }

后面也用到了“数量乘以单价” 运算结果，所以我们同样将它替换为basePrice:

double price(){
      //price is base price - quantity discount + shipping
        final double basePrice = _quantity * _itemPrice;
        return basePrice - 
               Math.max( 0, _quantity - 500 ) * _itemPrice * 0.05 +
               Math.min(basePrice * 0.1, 100.0 );
    }

然后，将批发折扣（quantityDiscount）的计算提炼出来，将结果赋予临时变量

double price()
    {
        //price is base price - quantity discount + shipping
        final double basePrice = _quantity * _itemPrice;
        final double quantityDiscount = 
                        Math.max( 0, _quantity - 500 ) * _itemPrice * 0.05;
        return basePrice - quantityDiscount + 
               Math.min( _quantity * _itemPrice * 0.1, 100.0 );
    }

最后，再把运费（shipping）计算出来，将运算结果赋予临时变量shipping。同时还是可以删掉代码中的注释，因为现在代码已经可以完美表达自己的意义了：

double price()
    {
        final double basePrice = _quantity * _itemPrice;
        final double quantityDiscount = 
                        Math.max( 0, _quantity - 500 ) * _itemPrice * 0.05;
        final double shipping = Math.min( basePrice * 0.1, 100.0 );
        return basePrice - quantityDiscount + shipping;
    }

Introduce Explaining Variable 是一个常见的重构手法，但是Extract Method 也可以用来解释一段代码的意义，毕竟临时变量只在它所处的那个函数中才有意义，局限性较大，函数则可以在对象的整个生命中都有用，并且可以被其他对象使用。那么应该在什么时候使用Introduce Explaining Variable呢？答案是：在Extract Method 需要花费更大的工作量时。如果要要处理的是一个拥有大量局部变量的算法，那么使用Extract Method绝非易事。这种情况下就会使用Introduce Explaining Variable 来清理代码，然后再考虑下一步该怎么办。搞清楚代码逻辑之后，总是可以运用Replace Temp with Query 把中间引入的那些解释性临时变量去掉。况且，如果最终使用Replace Method with Method Object，那么中间引入的那些解释性变量也有其价值。

转载于:https://my.oschina.net/u/134516/blog/125303