重构(笔记)——第六章

重新组织函数

提取函数

提取函数是将一个过于复杂的函数分解成多个小函数,然后在调用其他小函数即可。

// 书中的示例

内联函数

简而言之就是将函数中的内容替换掉,直接使用其中的代码,而不使用中间函数。

// 书中的示例
int getRating() {
    return (moreThanFiveLateDeliveries()) ? 2 : 1;
}

boolean moreThanFiveLateDeliveries() {
    return _numberOfLateDeliveries > 5; // _numberOfLateDeliveries 是一个成员变量,这里仅仅示例
}

// 改写后
int getRating() {
    return (_numberOfLateDeliveries > 5) ? 2 : 1;
}

内联临时变量

与内联函数概念类似,只是这里处理的是临时变量。如果代码中出现一个临时变量,只被简单表达式赋值一次,而妨碍了其他重构手法的情况下,就可以去掉这个临时变量。

// 书中的示例
double basePrice = anOrder.basePrice();
return basePrice > 1000;

// 重构后
return anOrder.basePrice() > 1000;

以查询取代临时变量

代码中的临时变量替换成查询式从而更改为调用函数而不是判断临时变量,以达到去除临时变量的目的。作者在书中说:

临时变量的问题在于:它们是暂时的,而且只能在所属函数内使用。由于临时变量只在所属函数内可见,所以它们会驱使你写出更长的函数,因为只有这样你才能访问到需要的临时变量。如果把临时变量替换为一个查询,那么同一个类中的所有函数都可以获得这份信息。这将带给你极大帮助,使你能够为这个类编写更清晰的代码。

double basePrice = _quantity * _itemPrice;
if (basePrice > 1000) {
    return basePrice * 0.95;
} else {
    return basePrice * 0.98;
}

// 重构后
if (basePrice() > 1000) {
    return basePrice() * 0.95;
} else {
    return basePrice() * 0.98;
}

boule basePrice(){
    return _quantity * _itemPrice;
}

引入解释性变量

某个表达式很复杂的情况下,使用临时变量来接收表达式的值。看到这里就会很疑惑,前面一直在主张我们尽量消除掉临时性变量,这里却又要引进临时性变量,那岂不是与前面的原则相悖吗?

这时就要从重构的目的上去理解了,而不是单单的重构手法。重构的目的是为了让代码可读性更好,可重复使用率更高,当某个表达式更复杂的时候,我们引入临时变量其实是一种提高可读性的手段,这也是符合重构的原则。

// 书中示例
if ((platform.toUpperCase().indexOf("MAC") > -1) &&
   (browser.toUpperCase().indexOf("IE") > -1 &&
   wasInitialized() &&
   resize > 0))
{
    // do something...
}

// 重构后
final boolean isMacOS = platform.toUpperCase().indexOf("MAC") > -1;
final boolean isIEBrowser = browser.toUpperCase().indexOf("IE") > -1;
final boolean wasResized = resize > 0;

if (isMacOS && isIEBrowser && wasInitialized() && wasResized){
    // to something...
}

这里的重构手法就是将 3 个条件分别引入到 3 个对应的临时变量,不过也可以使用上面的重构手法 以查询取代临时变量 的手法来做。

// 我的重构,非书上示例,使用书上的代码
if (isMacOS() && isIEBrowser() && wasInitialized() && wasResized()){
    // to something...
}

boolean isMacOS() {
    return platform.toUpperCase().indexOf("MAC") > -1;
}

boolean isIEBrowser() {
    return browser.toUpperCase().indexOf("IE") > -1;
}

boolean wasResized() {
    return resize > 0;
}

分解临时变量

代码中有某个临时变量被赋值超过一次,它既不是循环变量,也不被用于收集计算结果。

针对每次赋值,创建一个独立、对应的临时变量。

// 书中的示例
double temp = 2 *(_height * _width);
System.out.println(temp);
temp = _height * _width;
System.out.println(temp);

// 重构后
double perimeter =  2 *(_height * _width);
System.out.println(perimeter);
double area = _height * _width;
System.out.println(area);

分解临时变量后,好处是显而易见的,上面的代码重构后就可以将 计算面积计算周长 的方法分开抽取成函数。

移除对参数的赋值

函数中的参数对应着传入的值,如果直接修改参数列表中某个参数的值,添加一个临时变量来接收对应参数列表的参数值,然后修改这个临时变量。目的:不修改参数列表中参数的值,如果需要修改,添加一个新的临时变量。

// 书中的示例
int discount(int inputVal, int quantity, int yearToDate){
    if (inputVal > 50) {
        inputVal -= 2;
    }
}

// 重构后
int discount(int inputVal, int quantity, int yearToDate){
    int result = inputVal;
    if (inputVal > 50) {
        result -= 2;
    }
}

知识点:

Java 中有按值传递和按引用传递两种类型,如果参数列表中的参数类型是对象类型,那么修改参数会影响到调用函数端的原先对象。

以函数对象取代函数

在一个大型函数中,对于其中的局部变量已经无法再使用抽取函数的手段了,此时可以尝试使用 以函数对象取代函数 重构模式。

将这个函数放进一个单独对象中,如此一来局部变量就成了对象内的字段。然后就可以在同一个对象中将这个大型函数分解为多个小型函数

// 书中的示例
class Account {
    int gamma(int inputVal, int quantity, int yearToDate){
        int importantValue1 = (inputVal * quantity) + delta();
        int importantValue2 = (inputVal * yearToDate) + 100;
        if ((yearToDate - importantValue1) > 100) {
            importantValue2 -= 20;
        }
        int importantValue3 = importantValue2 * 7;
        return importantValue3 -2 * importantValue1;
    }
}

// 重构后
class Account {
    int gamma(int inputVal, int quantity, int yearToDate){
        return new Gamma(this, inputVal, quantity, yearToDate).compute();
    }
}

class Gamma {
    private final Account account;
    private int inputVal;
    private int quantity;
    private int yearToDate;
    private int importantValue1;
    private int importantValue2;
    private int importantValue3;
    
    Gamma(Account account, int inputVal, int quantity, int yearToDate) {
        this.account = account;
        this.inputVal = inputVal;
        this.yearToDate = yearToDate;
    }
    
    int comput() {
        int importantValue1 = (inputVal * quantity) + delta();
        int importantValue2 = (inputVal * yearToDate) + 100;
        importantThing();
        int importantValue3 = importantValue2 * 7;
        return importantValue3 -2 * importantValue1;
    }
    
    void importantThing(){
        if ((yearToDate - importantValue1) > 100) {
            importantValue2 -= 20;
        }
    }
}

说明:

在平时编写代码的过程中, IDEA 有时候会提示出该种重构手段,这是我最讨厌的一种方式。因为,多增加了一个类,增加了一个类就意味着增加了复杂度。

替换算法

解决问题的方式有很多种,尽量使用其中最简单的那种方式来解决问题。

// 书中示例
String foundPerson(String[] people) {
    for (int i = 0; i < people.length; i++) {
        if (people[i].equals("Don")) {
            return "Don";
        }
        if (peopl[i].equals("John")) {
            return "John";
        }
        if (people[i].equals("Kent")) {
            return "Kent";
        }
    }
    return "";
}

// 重构后
String foundPerson(String[] people) {
    List<String> candidates= Arrays.asList("Don", "John", "Kent");
    for (int i = 0; i < people.length; i++) {
        if (candidates.contains(people[i])) {
            return people[i];
        }
    }
    return "";
}

思考:

尽量去寻找解决问题最简单的那种方式,越简单出错的可能性也就越低。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,636评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,890评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,680评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,766评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,665评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,045评论 1 276
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,515评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,182评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,334评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,274评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,319评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,002评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,599评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,675评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,917评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,309评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,885评论 2 341

推荐阅读更多精彩内容