上次有人來要求我寫一篇文章談?wù)勈裁创a才是好代碼，是誰我已經(jīng)忘記了，好像是AutoHotkey還是啥的專欄的作者。撇開那些奇怪的條款不談，靠譜的 代碼有一個(gè)共同的特點(diǎn)，就是DRY。DRY就是Don't Repeat Yourself，其實(shí)已經(jīng)被人談了好多年了，但是幾乎所有人都會(huì)忘記。

什么是DRY（Don't Repeat Yourself）

DRY 并不是指你不能復(fù)制代碼這么簡單的。不能repeat的其實(shí)是信息，不是代碼。要分析一段代碼里面的什么東西時(shí)信息，就跟給物理題做受力分析一樣，想每次 都做對(duì)其實(shí)不太容易。但是一份代碼總是要不斷的修補(bǔ)的，所以在這之前大家要先做好TDD，也就是Test Driven Development。這里我對(duì)自己的要求是覆蓋率要高達(dá)95%，不管用什么手段，總之95%的代碼的輸出都要受到檢驗(yàn)。當(dāng)有了足夠多的測試做后盾的時(shí) 候，不管你以后發(fā)生了什么，譬如說你發(fā)現(xiàn)你Repeat了什么東西要改，你才能放心大膽的去改。而且從長遠(yuǎn)的角度來看，做好TDD可以將開發(fā)出相同質(zhì)量的代碼的時(shí)間縮短到30%左右（這是我自己的經(jīng)驗(yàn)值） 。

什么是信息

信息這個(gè)詞不太好用語言下定義，不過我可以舉個(gè)例子。譬如說你要把一個(gè)配置文件里面的字符串按照分隔符分解成幾個(gè)字符串，你大概就會(huì)寫出這樣的代碼：

// name;parent;description
void ReadConfig(const wchar_t* config)
{
    auto p = wcschr(config, L';');                            // 1
    if(!p) throw ArgumentException(L"Illegal config string"); // 2
    DoName(wstring(config, p));                               // 3
    auto q = wcschr(p + 1, L';');                             // 4
    if(!q) throw ArgumentException(L"Illegal config string"); // 5
    DoParent(wstring(p + 1, q);                               // 6
    auto r = wcschr(q + 1, L';');                             // 7
    if(r) throw ArgumentException(L"Illegal config string");  // 8
    DoDescription(q + 1);                                     // 9
}

這段短短的代碼重復(fù)了多少信息？

• 分隔符用的是分號(hào)（1、4、7）
• 第二/三個(gè)片段的第一個(gè)字符位于第一/二個(gè)分號(hào)的后面（4、6、7、9）
• 格式檢查（2、5、8）
• 異常內(nèi)容（2、5、8）
  

除了DRY以外還有一個(gè)問題，就是處理description的方法跟name和parent不一樣，因?yàn)樗竺嬖僖矝]有分號(hào)了。

那這段代碼要怎么改呢？有些人可能會(huì)想到，那把重復(fù)的代碼抽取出一個(gè)函數(shù)就好了：

wstring Parse(const wchar_t& config, bool end)
{
    auto next = wcschr(config, L';');
    ArgumentException up(L"Illegal config string");
    if (next)
    {
        if (end) throw up;
        wstring result(config, next);
        config = next + 1;
        return result;
    }
    else
    {
        if (!end) throw up;
        wstring result(config);
        config += result.size();
        return result;
    }
}

// name;parent;description
void ReadConfig(const wchar_t* config)
{
    DoName(Parse(config, false));
    DoParent(Parse(config, false));
    DoDescription(Parse(config, true));
}

是不是看起來還很別扭，好像把代碼修改了之后只把事情搞得更亂了，而且就算config對(duì)了我們也會(huì)創(chuàng)建那個(gè)up變量，就僅僅是為了不 重復(fù)代碼。而且這份代碼還散發(fā)出了一些不好的味道，因?yàn)閷?duì)于Name、Parent和Description的處理方法還是不能統(tǒng)一，Parse里面針對(duì) end變量的處理看起來也是很重復(fù)，但實(shí)際上這是無法在這樣設(shè)計(jì)的前提下消除的。所以這個(gè)代碼也是不好的，充其量只是比第一份代碼強(qiáng)一點(diǎn)點(diǎn)。

實(shí) 際上，代碼之所以要寫的好，之所以不能repeat東西，是因?yàn)楫a(chǎn)品狗總是要改需求，不改代碼你就要死，改代碼你就要加班，所以為了減少修改代碼的痛苦， 我們不能repeat任何信息。舉個(gè)例子，有一天產(chǎn)品狗說，要把分隔符從分號(hào)改成空格！一下子就要改兩個(gè)地方了。description后面要加tag！ 這樣你處理description的方法又要改了因?yàn)樗且钥崭窠Y(jié)尾不是0結(jié)尾。

因此針對(duì)這個(gè)片段，我們需要把它改成這樣：

vector<wstring> SplitString(const wchar_t* config, wchar_t delimiter)
{
    vector<wstring> fragments;
    while(auto next = wcschr(config, delimiter))
    {
        fragments.push_back(wstring(config, next));
        config = next + 1;
    }
    fragments.push_back(wstring(config));
    return fragments; // C++11就是好！
}

void ReadConfig(const wchar_t* config)
{
    auto fragments = SplitString(config, L';');
    if(fragments.size() != 3)
    {
        throw ArgumentException(L"Illegal config string");
    }
    DoName(fragments[0]);
    DoParent(fragments[1]);
    DoDescription(fragments[2]);
}

我們可以發(fā)現(xiàn)，分號(hào)（L';'）在這里只出現(xiàn)了一次，異常內(nèi)容也只出現(xiàn)了一次，而且處理name、parent和 description的代碼也沒有什么區(qū)別了，檢查錯(cuò)誤也更簡單了。你在這里還給你的Library增加了一個(gè)SplitString函數(shù)，說不定在以 后什么地方就用上了，比Parse這種專門的函數(shù)要強(qiáng)很多倍。

大家可以發(fā)現(xiàn)，在這里重復(fù)的東西并不僅僅是復(fù)制了代碼，而是由于你把 同一個(gè)信息散播在了代碼的各個(gè)部分導(dǎo)致了有很多相近的代碼也散播在各個(gè)地方，而且還不是那么好通過抽成函數(shù)的方法來解決。因?yàn)樵谶@種情況下，就算你把重復(fù) 的代碼抽成了Parse函數(shù)，你把函數(shù)調(diào)用了幾次實(shí)際上也等于重復(fù)了信息。因此正確的方法就是把做事情的方法變一下，寫成SplitString。這個(gè) SplitString函數(shù)并不是通過把重復(fù)的代碼簡單的抽取成函數(shù)而做出來的。去掉重復(fù)的信息會(huì)讓你的代碼的結(jié)構(gòu)發(fā)生本質(zhì)的變化。

這個(gè)問題其實(shí)也有很多變體：

• 不能有Magic Number。L';'出現(xiàn)了很多遍，其實(shí)就是個(gè)Magic Number。所以我們要給他個(gè)名字，譬如說delimiter。
• 不要復(fù)制代碼。這個(gè)應(yīng)該不用我講了。
  
• 解耦要做成正交的。SplitString雖然不是直接沖著讀config來寫的，但是它反映了一個(gè)在其它地方也會(huì)遇到的常見的問題。如果用Parse的那個(gè)版本，顯然只是看起來解決了問題而已，并沒有給你帶來任何額外的效益。

信息一旦被你repeat了，你的代碼就會(huì)不同程度的出現(xiàn)各種腐爛或者破窗，上面那三條其實(shí)只是我能想到的比較常見的表現(xiàn)形式。這件事情也告訴我們，當(dāng)高手告訴你什么什么不能做的時(shí)候，得想一想背后的原因，不然跟封建迷信有什么區(qū)別。