【重構學習】05 函數的重構

《重構》這本書的代碼都是java，我準備用C#來一遍。

而今天我的主要任務是寫一大段垃圾代碼出來，然後重構(僅限於函數的，不涉及到其它方面的重構)。

程式界面：

功能介紹：

俠客名字自己取，然後點擊按鈕隨機角色的屬性，

根骨，經脈，柔韌，悟性等四項屬性值都是隨機而來。

其他的都是由這四個屬性計算而來：

根骨：影響氣血，基礎外攻和基礎內攻

經脈：影響內力和基礎內攻

柔韌：影響身法和基礎閃避

按鈕功能的垃圾代碼如下：

/// <summary>
        /// 產生俠客
        /// </summary>
        private void btnCreateSwordsman_Click(object sender, EventArgs e)
        {
            var random = new Random();
            int boneValue, meridianValue, flexibilityValue, savvyValue;

            txtSurname.Text = "王";
            txtShortName.Text = "大牛";

            boneValue = random.Next(10);
            meridianValue = random.Next(10);
            flexibilityValue = random.Next(10);
            savvyValue = random.Next(10);

            txtBone.Text = boneValue.ToString();
            txtMeridian.Text = meridianValue.ToString();
            txtFlexibility.Text = flexibilityValue.ToString();
            txtSavvy.Text = savvyValue.ToString();

            txtHP.Text = (boneValue * 20 + 20).ToString();
            txtMP.Text = (meridianValue * 10).ToString();
            txtAGI.Text = (flexibilityValue * 5 + 10).ToString();

            txtExteriorAttack.Text = (boneValue * 2).ToString();
            txtInsideAttack.Text = (meridianValue * 3 + boneValue*2).ToString();
            txtDodge.Text = (flexibilityValue * 1.5/100).ToString("p");
        }

為了便於理解，所以代碼很少，但是足夠垃圾，讓我們通過下麵的學習一步步重構來吧！

　　基本上關於函數的重構都是因為函數過長而引起的，有的說50行，有的說30行，有的說一個屏幕，不管怎樣，別太長就好。而明顯我上面的函數看起來很短，實際上是因為我偷了懶，比如命名也有隨機的。（還有不要在意那些魔法數字和命名，寫了一半我覺得應該寫dota英雄屬性的隨機，我可以直接抄，因為取名真的好麻煩）

　　以下所有的這些重構的例子因為代碼本來就很簡單，所以可能看不出明顯的效果，有的時候也許讓你感到莫名其妙，但是你如果把它當做一個很大的系統里的一部分，再將裡面的邏輯複雜化，那麼這些重構就顯得很有必要了。

1、提煉函數：將函數里的一段代碼提煉出來，放到一個新的函數中，並讓函數名稱解釋該函數的用途

動機：如果每個函數的粒度很小，那麼函數被覆用的機會就更大，覆寫也更容易，更高層的函數讀起來就像註釋。

做法：創造一個新函數（以做什麼命名，而不是怎麼做），提煉代碼到新函數（註意臨時變數和參數）

無局部變數的提煉函數：

 /// <summary>
        /// 產生俠客
        /// </summary>
        private void btnCreateSwordsman_Click(object sender, EventArgs e)
        {
            RandomSwordsmanName();
            RandomSwordsmanAttribute();
        }
        /// <summary>
        ///  產生一個隨機的俠客名（你假裝是隨機好了）
        /// </summary>
        void RandomSwordsmanName() {
            txtSurname.Text = "王";
            txtShortName.Text = "大牛";
        }
        /// <summary>
        /// 隨機俠客的屬性(按照《重構》的做法，其實這裡可以不做註釋，因為這些函數名已經很清楚了，註釋反而是累贅)
        /// </summary>
        void RandomSwordsmanAttribute() {
            var random = new Random();
            int boneValue, meridianValue, flexibilityValue, savvyValue;

            boneValue = random.Next(10);
            meridianValue = random.Next(10);
            flexibilityValue = random.Next(10);
            savvyValue = random.Next(10);

            txtBone.Text = boneValue.ToString();
            txtMeridian.Text = meridianValue.ToString();
            txtFlexibility.Text = flexibilityValue.ToString();
            txtSavvy.Text = savvyValue.ToString();

            txtHP.Text = (boneValue * 20 + 20).ToString();
            txtMP.Text = (meridianValue * 10).ToString();
            txtAGI.Text = (flexibilityValue * 5 + 10).ToString();

            txtExteriorAttack.Text = (boneValue * 2).ToString();
            txtInsideAttack.Text = (meridianValue * 3 + boneValue * 2).ToString();
            txtDodge.Text = (flexibilityValue * 1.5 / 100).ToString("p");
        }

有局部變數的函數提取：

要將隨機產生四個屬性和其它屬性的計算提取函數會涉及到臨時變數的問題，一般是傳參，參數很多就傳對象

        /// <summary>
        /// 隨機俠客的屬性
        /// </summary>
        void RandomSwordsmanAttribute() {
            var basicInfo = RandomSwordsmanBasicAttribute();
            GetOtherInfoByBasicInfo(basicInfo);    
        }
        /// <summary>
        /// 隨機俠客的基礎屬性
        /// </summary>
        /// <returns></returns>
        SwordsmanBasicInfo RandomSwordsmanBasicAttribute() {
            var basicInfo = new SwordsmanBasicInfo();
            var random = new Random();

            basicInfo.Bone = random.Next(10);
            basicInfo.Meridian = random.Next(10);
            basicInfo.Flexibility = random.Next(10);
            basicInfo.Savvy = random.Next(10);
            return basicInfo; 
        }
        /// <summary>
        /// 通過俠客基礎屬性得到其它屬性，並展示出來
        /// </summary>
        /// <param name="basicInfo"></param>
        void GetOtherInfoByBasicInfo(SwordsmanBasicInfo basicInfo)
        {
            txtBone.Text = basicInfo.Bone.ToString();
            txtMeridian.Text = basicInfo.Meridian.ToString();
            txtFlexibility.Text = basicInfo.Flexibility.ToString();
            txtSavvy.Text = basicInfo.Savvy.ToString();

            txtHP.Text = (basicInfo.Bone * 20 + 20).ToString();
            txtMP.Text = (basicInfo.Meridian * 10).ToString();
            txtAGI.Text = (basicInfo.Flexibility * 5 + 10).ToString();

            txtExteriorAttack.Text = (basicInfo.Bone * 2).ToString();
            txtInsideAttack.Text = (basicInfo.Meridian * 3 + basicInfo.Bone * 2).ToString();
            txtDodge.Text = (basicInfo.Flexibility * 1.5 / 100).ToString("p");
        }
        /// <summary>
        /// 俠客基礎屬性
        /// </summary>
        public class SwordsmanBasicInfo
        {
            /// <summary>
            /// 根骨
            /// </summary>
            public int Bone { get; set; }
            /// <summary>
            /// 經脈
            /// </summary>
            public int Meridian { get; set; }
            /// <summary>
            /// 柔韌
            /// </summary>
            public int Flexibility { get; set; }
            /// <summary>
            /// 悟性
            /// </summary>
            public int Savvy { get; set; }
        }    

然而這還不夠，用函數取代一些的表達式：

　　　　　/// <summary>
        /// 通過俠客基礎屬性得到其它屬性，並展示出來
        /// </summary>
        /// <param name="basicInfo"></param>
        void GetOtherInfoByBasicInfo(SwordsmanBasicInfo basicInfo)
        {
            txtBone.Text = basicInfo.Bone.ToString();
            txtMeridian.Text = basicInfo.Meridian.ToString();
            txtFlexibility.Text = basicInfo.Flexibility.ToString();
            txtSavvy.Text = basicInfo.Savvy.ToString();

            txtHP.Text = GetHP(basicInfo.Bone).ToString();
            txtMP.Text = GetMP(basicInfo.Meridian).ToString();
            txtAGI.Text = GetAGI(basicInfo.Flexibility).ToString();

            txtExteriorAttack.Text = GetExteriorAttack(basicInfo.Bone).ToString();
            txtInsideAttack.Text = GetInsideAttack(basicInfo.Meridian ,basicInfo.Bone).ToString();
            txtDodge.Text = GetDodge(basicInfo.Flexibility).ToString("p");
        }
        int GetHP(int bone) {
            return bone * 20 + 20;
        }
        int GetMP(int meridian)
        {
            return meridian * 10;
        }
        int GetAGI(int flexibility)
        {
            return flexibility * 5 + 10;
        }
        int GetExteriorAttack(int bone)
        {
            return bone * 2;
        }
        int GetInsideAttack(int bone, int meridian)
        {
            return meridian * 3 + bone * 2;
        }
        float GetDodge(int flexibility)
        {
            return flexibility * 1.5f / 100;
        }

.NET還有更好玩的dynamic玩法：

　　　　　/// <summary>
        /// 通過俠客基礎屬性得到其它屬性，並展示出來
        /// </summary>
        /// <param name="basicInfo"></param>
        void GetOtherInfoByBasicInfo(SwordsmanBasicInfo basicInfo)
        {
            SetTextBoxValue(txtBone,basicInfo.Bone);
            SetTextBoxValue(txtMeridian, basicInfo.Meridian);
            SetTextBoxValue(txtFlexibility, basicInfo.Flexibility);
            SetTextBoxValue(txtSavvy, basicInfo.Savvy);

            SetTextBoxValue(txtHP, GetHP(basicInfo.Bone));
            SetTextBoxValue(txtMP, GetMP(basicInfo.Meridian));
            SetTextBoxValue(txtAGI, GetAGI(basicInfo.Flexibility));

            SetTextBoxValue(txtExteriorAttack, GetExteriorAttack(basicInfo.Bone));
            SetTextBoxValue(txtInsideAttack, GetInsideAttack(basicInfo.Meridian, basicInfo.Bone));

            SetTextBoxPercentValue(txtDodge, GetDodge(basicInfo.Flexibility));
        }
        void SetTextBoxValue(TextBox textBox, dynamic num)
        {
            textBox.Text = num.ToString();
        }
        void SetTextBoxPercentValue(TextBox textBox, dynamic percent)
        {
            textBox.Text = percent.ToString("p");
        }

當然這仍然不夠，

GetHP之類的函數可以放到SwordsmanBasicInfo類里，整個代碼在功能上實際上是分為計算和顯示兩個邏輯，有必要將計算屬性，和最後的顯示屬性提取成不同的函數放在類里

但是這裡只是單純為了舉幾個例子來說明函數的提取重構而已，所以也就沒必要繼續弄了，這段垃圾代碼就留到後面繼續重構吧。

2、去函數

動機：一個函數的本體與名稱同樣清晰了

做法：用函數本體去取代函數

例子就不舉了，太簡單，不過這種做法的意義通常不用於描述所說的那樣的動機，實際上是因為你將這些函數去掉，

說不定可以發現兩個這種函數去函數化後，說不定可以進行邏輯更清晰，意義更明確的函數提煉。

 3、去臨時變數

動機：有一個臨時變數，只被一個簡單表達式賦值了一次，而它妨礙了其他重構手法

做法：則將所有對該變數的引用動作，替換為對它賦值的那個表達式本身

對於一大段很艱澀的代碼，你可以把這個臨時變數加上const，以確定它確實只被賦值一次，當然實際上VS的CTRL+F已經很清晰了  

4、以函數取代臨時變數

這一步相當於去臨時變數的一個擴展，就是把臨時變數替換成一個簡單表達式後再用函數放起來。

（參考:在提取函數的代碼裡面GetHP那一系列函數就是，不過我寫的代碼只是反映了可讀性，

實際上如果這個函數是放在類裡面，那麼所有的函數就都可以訪問這個東西，而不是僅有臨時變數所在的那個函數，.NET的玩法你也可以考慮放在屬性裡面用get，set這種就酷多了）

在這裡你也許會認為無用，因為我用個臨時變數不是挺好的嗎，幹嘛不改為函數呢，但事實上我在提取函數的代碼里的那一部分重構確實代碼好看多了。

說到底我們的代碼不僅是要寫給機器看的，也是寫給人看的，你要考慮到終究會有一個同行來讀，為了大家下班快點，搭把手。

你也會提到這會不會有性能上的問題，因為一個表達式我給臨時變數只要計算一次，但是我用表達式可能就要計算N次。（記住這裡的表達式是簡單表達式）

說實話這個問題我也想到過，但是Martin大神解釋道：這通常不會影響到性能，因為大多也就幾次調用而已，

就像之前說的不要去揣測性能問題，到了性能優化階段再去考慮，如果那個時候真的有性能問題，一個良好的重構過得程式也許能讓你發現更好地優化方案，實在不行，你改成臨時變數也會很容易。

5、引入解釋性變數

動機：當你有一個複雜的表達式的時候，又是&&又是||的什麼判斷什麼的一大串的時候（我相信大家都遇到過），然後存在大量局部變數，用函數不好提取時

做法：那麼你可以去把這個複雜的表達式中的部分值放入一個臨時變數，然後用變數名稱來解釋表達式的用途

6、臨時變數分解

動機：某個臨時變數被賦值一次以上，它既不是迴圈變數，也不是用於收集計算結果（畢竟高級語言不是C，C的聲明要寫在開頭，我喜歡直接用一個臨時變數，但是高級語言可是可以到處聲明的）

做法：好吧，針對每個賦值，創造一個獨立、對應的臨時變數（就是單一職責，不僅僅是函數，一個變數的意義也要單一職責）

7、移除對參數的賦值

動機：代碼對一個參數賦值，降低了代碼的清晰度

做法：以一個臨時變數取代該參數的位置，當然引用參數不必遵循這一原則，就是那些引用類型的變數和ref這種，但是ref什麼的Martin不建議多用。（好吧，仁者見仁，智者見智，自己權衡吧）

實際上除此之外的寫法都會降低可讀性，不如新建個臨時變數去處理，這點可憐的性能就不需要考慮了吧，話說咱寫的不是C啊，可讀性和性能什麼的，具體情況具體分析，自己權衡吧。

8、以函數對象取代函數

好吧，你看到函數對象的時候可能覺得這個東西碉堡了，一個函數作為對象，是js嗎？

實際上並不是，Martin的函數對象是指一個有函數的對象（我這樣解釋是不是很清楚，然後一下從高大上變得很low？）

動機：為瞭解決大型函數的重構時，其中泛濫成災的局部變數的使用讓你無法用提取函數的情況

做法：將這個函數放進一個單獨對象裡面，如此一來局部變數就成了對象內的欄位。然後你可以在同一個對象中將這個大型函數分解成多個小型函數。

就是說你去新建一個類，然後把這個函數要重構的函數放進去，然後局部變數都轉為欄位。（好聰明的做法）

9、替換演算法

動機：你覺得你的哪段代碼寫的很爛

做法：那麼你就換一種更清晰的寫法寫出來

好吧，這個不存在什麼問題吧，我已經說的很清晰了，你所欠缺的只是壯士斷腕的勇氣，

當然首先你要記得提取函數哦，這樣你斷腕的時候不至於砍錯了地方。