生因重構(gòu)代碼引熱議：到底什么才算真正的代碼重構(gòu)？)
最近技術(shù)圈里有個(gè)話(huà)題挺有意思一個(gè)12歲的小學(xué)生給一段代碼做了“重構(gòu)”還把前后對(duì)比曬了出來(lái)。很多人看完第一反應(yīng)是——“這也叫重構(gòu)不就是改了個(gè)變量名加了點(diǎn)注釋嗎”另一撥人卻覺(jué)得一個(gè)剛開(kāi)始學(xué)編程的孩子能主動(dòng)去美化代碼、拆分邏輯這個(gè)意識(shí)本身就比技巧更值得鼓勵(lì)。老實(shí)說(shuō)事情的關(guān)鍵不在于小學(xué)生寫(xiě)了什么高級(jí)代碼而在于“重構(gòu)”這個(gè)詞被反復(fù)提起之后很多人對(duì)它的理解其實(shí)還很模糊。有人把重構(gòu)等同于格式化有人把重構(gòu)等同于重寫(xiě)還有人覺(jué)得代碼能運(yùn)行就行折騰結(jié)構(gòu)純屬多余。本文不打算去評(píng)價(jià)那個(gè)小學(xué)生寫(xiě)得怎么樣而是借這個(gè)話(huà)題把“代碼重構(gòu)”拆開(kāi)講清楚它到底是什么、常見(jiàn)手法有哪些、一次像樣的重構(gòu)應(yīng)該怎么做以及新手在重構(gòu)時(shí)最容易踩哪些坑。1. 12歲小學(xué)生“重構(gòu)代碼”為什么能引起討論1.1 兩派觀(guān)點(diǎn)是無(wú)用功還是好習(xí)慣這個(gè)話(huà)題能火本質(zhì)上是“業(yè)余認(rèn)知”和“工程認(rèn)知”的碰撞。第一派人的視角很直接如果我看到一段代碼只是變量名從c改成chinese_score或者把一段循環(huán)單獨(dú)提出來(lái)包成一個(gè)函數(shù)我不會(huì)覺(jué)得這是一次重構(gòu)。因?yàn)樵诔墒斓墓こ虉F(tuán)隊(duì)里這些屬于最基本的代碼衛(wèi)生習(xí)慣是寫(xiě)代碼時(shí)順手就該做掉的事不值得拿出來(lái)稱(chēng)贊。另一派人的視角更寬容對(duì)小學(xué)階段的孩子來(lái)說(shuō)信息課作業(yè)通常停留在“結(jié)果正確”層面老師判分也不會(huì)關(guān)心你變量名叫什么。這個(gè)時(shí)候孩子愿意回頭改代碼說(shuō)明他已經(jīng)開(kāi)始意識(shí)到代碼不僅僅是寫(xiě)給機(jī)器執(zhí)行的更是寫(xiě)給將來(lái)的人閱讀的。這種“代碼可讀性”意識(shí)的覺(jué)醒恰恰是很多科班學(xué)生到大三都不一定形成的。這兩種說(shuō)法都有道理。技術(shù)含量和成長(zhǎng)意義不是同一件事。與其爭(zhēng)“小學(xué)生到底算不算重構(gòu)”不如冷靜下來(lái)把“重構(gòu)”這個(gè)概念本身梳理一遍。1.2 重構(gòu)是有層次和粒度的如果把重構(gòu)看成一個(gè)從淺到深的光譜大致可以分成三個(gè)層次層次目標(biāo)常見(jiàn)操作第一層代碼整理讓眼前這段代碼更可讀重命名變量、提取函數(shù)、補(bǔ)充注釋、統(tǒng)一格式第二層結(jié)構(gòu)改進(jìn)讓模塊和類(lèi)邊界更合理拆分大類(lèi)、消除重復(fù)邏輯、優(yōu)化條件判斷第三層架構(gòu)演進(jìn)讓系統(tǒng)整體更易擴(kuò)展引入設(shè)計(jì)模式、模塊解耦、重構(gòu)數(shù)據(jù)存儲(chǔ)方式對(duì)一個(gè)初學(xué)編程的小學(xué)生來(lái)說(shuō)能做到第一層已經(jīng)很了不起。對(duì)工作三五年的工程師來(lái)說(shuō)如果只停留在第一層那確實(shí)會(huì)被團(tuán)隊(duì)質(zhì)疑“重構(gòu)深度不夠”。所以那篇帖子之所以引發(fā)爭(zhēng)議很大程度上是因?yàn)榇蠹覍?duì)“重構(gòu)”的預(yù)期標(biāo)準(zhǔn)完全不同。1.3 這件事真正值得關(guān)注的地方拋開(kāi)小學(xué)生本身不談“12歲小學(xué)生重構(gòu)代碼”能成為熱詞說(shuō)明大眾對(duì)編程教育的關(guān)注度在提高。與此同時(shí)這也反映出很多人對(duì)代碼質(zhì)量的忽視是普遍存在的。包括一些已經(jīng)工作幾年的開(kāi)發(fā)者拿到需求就開(kāi)寫(xiě)從來(lái)沒(méi)有回頭清理過(guò)自己代碼里的壞味道。之前有公司分享過(guò)“用AI在兩天內(nèi)重構(gòu)2萬(wàn)行Vue項(xiàng)目”的實(shí)踐當(dāng)時(shí)也引起過(guò)不少討論。這個(gè)案例說(shuō)明一個(gè)趨勢(shì)重構(gòu)不是可有可無(wú)的“潔癖行為”而是大型項(xiàng)目持續(xù)演進(jìn)過(guò)程中繞不開(kāi)的工程任務(wù)。代碼在業(yè)務(wù)迭代中會(huì)不斷增加功能如果每隔一段時(shí)間不進(jìn)行結(jié)構(gòu)性整理代碼復(fù)雜度會(huì)指數(shù)級(jí)上升直到下一個(gè)接手的人徹底崩潰。所以與其嘲諷小學(xué)生“重構(gòu)了個(gè)寂寞”不如把這次熱議當(dāng)成一次契機(jī)我們到底能不能清楚地講明白一次合格的重構(gòu)應(yīng)該包含哪些步驟2. 重構(gòu)的核心概念與判斷標(biāo)準(zhǔn)2.1 重構(gòu)到底怎么定義提到重構(gòu)繞不開(kāi) Martin Fowler 在《重構(gòu)改善既有代碼的設(shè)計(jì)》里給出的定義重構(gòu)是一種對(duì)軟件內(nèi)部結(jié)構(gòu)的調(diào)整目的是在不改變軟件可觀(guān)察行為的前提下提高代碼的可理解性降低修改成本。這句話(huà)里有幾個(gè)關(guān)鍵詞值得拆開(kāi)理解。第一個(gè)關(guān)鍵詞是“不改變可觀(guān)察行為”。意思是重構(gòu)前后用戶(hù)輸入同樣的數(shù)據(jù)程序輸出結(jié)果必須保持一致。不能用“順手優(yōu)化了一下功能”這種理由把行為變化混進(jìn)重構(gòu)里。否則一旦出現(xiàn)問(wèn)題你很難判斷是重構(gòu)改壞了還是新需求改壞了。第二個(gè)關(guān)鍵詞是“內(nèi)部結(jié)構(gòu)”。重構(gòu)不是調(diào)整界面布局不是改文字也不是換一套色值。它針對(duì)的是代碼組織方式變量怎么命名、函數(shù)怎么拆分、類(lèi)與類(lèi)之間怎么協(xié)作、數(shù)據(jù)怎么流轉(zhuǎn)。第三個(gè)關(guān)鍵詞是“可理解性”和“修改成本”。重構(gòu)不是為了給誰(shuí)表演而是為了降低未來(lái)改動(dòng)代碼時(shí)的認(rèn)知負(fù)擔(dān)。一段代碼如果連原作者三個(gè)月后都看不懂那它的維護(hù)成本就非常高重構(gòu)價(jià)值也最大。2.2 重構(gòu)與格式化、重寫(xiě)、性能優(yōu)化有什么不同這幾個(gè)概念經(jīng)常被混為一談實(shí)際差別很大。格式化只是調(diào)整空格、換行、縮進(jìn)讓排版符合規(guī)范。它不會(huì)改變代碼結(jié)構(gòu)也沒(méi)有重新組織邏輯。所以把“代碼不規(guī)范”直接說(shuō)成“需要重構(gòu)”并不準(zhǔn)確。重寫(xiě)的動(dòng)作通常比重構(gòu)大得多。重寫(xiě)意味著把舊代碼推到一邊用新方案重新實(shí)現(xiàn)一遍。重構(gòu)則是在現(xiàn)有代碼基礎(chǔ)上逐步調(diào)整每一步改動(dòng)范圍都盡量縮小。重寫(xiě)風(fēng)險(xiǎn)很高容易丟失舊系統(tǒng)里那些隱藏的業(yè)務(wù)規(guī)則重構(gòu)風(fēng)險(xiǎn)相對(duì)可控因?yàn)樗竺恳徊蕉疾荒芨淖兺獠啃袨?。性能?yōu)化是指為了提升運(yùn)行效率而調(diào)整算法或緩存策略。性能優(yōu)化很可能改變外部行為比如響應(yīng)時(shí)間、內(nèi)存占用、返回結(jié)果順序這些都可能發(fā)生變化。所以在很多開(kāi)發(fā)規(guī)范里性能優(yōu)化和重構(gòu)要分開(kāi)提交分別測(cè)試。舉個(gè)例子快速排序代碼里如果只是把變量i改成left把j改成right這是重構(gòu)的一部分但如果你把遞歸實(shí)現(xiàn)改成非遞歸實(shí)現(xiàn)并且換了分區(qū)策略那就不只是重構(gòu)還夾雜了性能優(yōu)化和算法替換需要按新功能對(duì)待。2.3 一次重構(gòu)是否成功的三個(gè)標(biāo)準(zhǔn)判斷重構(gòu)是否成功不需要看“改了多少行”而是看下面三個(gè)方面第一行為是否保持不變。最直接的辦法是跑一遍原有測(cè)試用例如果可以再做一次手工驗(yàn)證。行為變化越多重構(gòu)的把握就越低。第二結(jié)構(gòu)是否明顯改善。所謂改善可以從重復(fù)代碼是否減少、函數(shù)長(zhǎng)度是否更合理、依賴(lài)方向是否更清晰、命名是否更能表達(dá)意圖等角度判斷。如果你改完之后別人看代碼依然要猜來(lái)猜去那就說(shuō)明重構(gòu)沒(méi)有到位。第三后續(xù)維護(hù)成本是否下降。這一點(diǎn)需要時(shí)間驗(yàn)證。理想情況是重構(gòu)之后新功能加進(jìn)來(lái)時(shí)需要改動(dòng)的文件更少、改動(dòng)的位置更集中、測(cè)試補(bǔ)起來(lái)更容易。如果只是把代碼從 A 風(fēng)格改成 B 風(fēng)格而沒(méi)有降低未來(lái)的修改成本那這次重構(gòu)的意義就有限。3. 用一個(gè)小項(xiàng)目還原“重構(gòu)前”的代碼3.1 場(chǎng)景教學(xué)版學(xué)生成績(jī)管理系統(tǒng)為了更貼近“小學(xué)生、課堂代碼、重構(gòu)”這些關(guān)鍵詞這里用一個(gè)非常常見(jiàn)的教學(xué)項(xiàng)目舉例學(xué)生成績(jī)管理系統(tǒng)。功能很簡(jiǎn)單支持錄入學(xué)生姓名、語(yǔ)文/數(shù)學(xué)/英語(yǔ)三科成績(jī)?nèi)缓笥?jì)算總分、平均分和等級(jí)最后打印成績(jī)單。這種項(xiàng)目在少兒編程課程里很常見(jiàn)業(yè)務(wù)規(guī)則非常簡(jiǎn)單非常適合用來(lái)觀(guān)察代碼結(jié)構(gòu)問(wèn)題。下面先用一種“新手常見(jiàn)的寫(xiě)法”實(shí)現(xiàn)這個(gè)功能。代碼能跑但結(jié)構(gòu)上存在不少問(wèn)題。3.2 原始代碼全貌# score_v1.py students [] while True: print(1. 添加學(xué)生) print(2. 顯示成績(jī)) print(3. 退出) a input(請(qǐng)選擇) if a 1: name input(姓名) c float(input(語(yǔ)文)) m float(input(數(shù)學(xué))) e float(input(英語(yǔ))) zf c m e pj zf / 3 s [name, c, m, e, zf, pj] students.append(s) elif a 2: for x in students: pj x[5] if pj 90: lv A elif pj 80: lv B else: lv C print(x[0], x[4], pj, lv) elif a 3: break else: print(輸入錯(cuò)誤)如果你已經(jīng)寫(xiě)過(guò)幾年代碼看到這段代碼大概會(huì)有一種“馬上要大改”的沖動(dòng)。對(duì)初學(xué)者來(lái)說(shuō)它確實(shí)能用但問(wèn)題非常明顯。3.3 這段代碼的“壞味道”先看變量命名。a代表用戶(hù)選項(xiàng)c代表語(yǔ)文成績(jī)m代表數(shù)學(xué)成績(jī)e代表英語(yǔ)成績(jī)zf代表總分pj代表平均分lv代表等級(jí)。這些縮寫(xiě)對(duì)寫(xiě)代碼的人自己來(lái)說(shuō)當(dāng)然記得住但放到一個(gè)稍微大一點(diǎn)的項(xiàng)目里別人讀起來(lái)就非常痛苦。更重要的是三個(gè)月后你自己回來(lái)讀也要先花時(shí)間回憶這幾個(gè)字母分別代表什么。再看數(shù)據(jù)結(jié)構(gòu)。學(xué)生信息被存成了一個(gè)列表[name, c, m, e, zf, pj]。也就是說(shuō)訪(fǎng)問(wèn)姓名用的是x[0]訪(fǎng)問(wèn)總分用的是x[4]訪(fǎng)問(wèn)平均分用的是x[5]。這完全是“魔法下標(biāo)”只要中間插入一個(gè)新字段比如性別后面所有下標(biāo)都要跟著改。一旦漏改程序就會(huì)在運(yùn)行時(shí)暴露出各種奇怪問(wèn)題。再看邏輯邊界。等級(jí)判斷這段規(guī)則被直接寫(xiě)在了輸出分支里如果以后要新增一個(gè)錄入“優(yōu)、良、及格、不及格”的等級(jí)邏輯就需要復(fù)制一份判斷代碼。重復(fù)代碼一旦出現(xiàn)就會(huì)造成“改了這處忘了那處”的維護(hù)問(wèn)題。最后是健壯性。輸入語(yǔ)文成績(jī)時(shí)如果直接輸入一個(gè)abc程序會(huì)拋出ValueError并退出。對(duì)用戶(hù)而言這個(gè)體驗(yàn)是很糟糕的。4. 把這段代碼逐步重構(gòu)4.1 第一步讓命名能表達(dá)業(yè)務(wù)含義重構(gòu)不需要一上來(lái)就推翻重寫(xiě)。最安全的第一步是把那些含義不清的變量名改成“讀起來(lái)像人話(huà)”的名字。比如a改成choicec改成chinese_scorem改成math_scoree改成english_scorezf改成total_scorepj改成average_scorelv改成level。這一步只改變名字不改變?nèi)魏芜壿?。改完之后代碼會(huì)變長(zhǎng)一些但可讀性會(huì)明顯提高。更關(guān)鍵的是這種重命名操作在 IDE 里有專(zhuān)門(mén)的重構(gòu)功能可以直接批量替換不需要一個(gè)一個(gè)手動(dòng)改。這一步的意義在于讓代碼讀起來(lái)像一段自然語(yǔ)言。比如average_score total_score / 3比pj zf / 3清晰得多。4.2 第二步用數(shù)據(jù)結(jié)構(gòu)表達(dá)真實(shí)業(yè)務(wù)對(duì)象接著處理“魔法下標(biāo)”。學(xué)生信息本質(zhì)上是一個(gè)業(yè)務(wù)對(duì)象包含姓名和三科成績(jī)。與其塞在一個(gè) list 里靠下標(biāo)訪(fǎng)問(wèn)不如用一個(gè)數(shù)據(jù)類(lèi)來(lái)描述它。在 Python 中可以用dataclasses來(lái)定義from dataclasses import dataclass dataclass class Student: name: str chinese: float math: float english: float有了這個(gè)類(lèi)之后訪(fǎng)問(wèn)學(xué)生信息就不需要再去記憶“第4個(gè)位置是總分”。總分、平均分、等級(jí)這些派生數(shù)據(jù)可以直接定義成只讀屬性或者方法。這個(gè)步驟的重點(diǎn)是把現(xiàn)實(shí)世界里的對(duì)象映射成代碼里的結(jié)構(gòu)。它屬于“用數(shù)據(jù)結(jié)構(gòu)表達(dá)業(yè)務(wù)”的典型重構(gòu)手法。很多初學(xué)者覺(jué)得這多余但等到項(xiàng)目里出現(xiàn)幾十個(gè)字段時(shí)就會(huì)發(fā)現(xiàn)列表和字典的脆弱的版本管理方式完全不夠用。4.3 第三步拆分函數(shù)讓每個(gè)函數(shù)只做一件事接下來(lái)把整個(gè) while 循環(huán)里的邏輯拆成函數(shù)。一個(gè)常見(jiàn)的拆分思路是read_score讀取單科成績(jī)并校驗(yàn)add_student添加學(xué)生show_report打印成績(jī)單main控制菜單邏輯拆函數(shù)不是為了看上去更“規(guī)范”而是讓每一段邏輯可以被單獨(dú)測(cè)試、單獨(dú)修改。比如等級(jí)判斷可以抽成 Student 的方法def grade(self) - str: if self.average 90: return A if self.average 80: return B return C以后如果新增一個(gè)“平均分大于等于60為及格”的規(guī)則只需要改這個(gè)方法不影響到其他代碼。4.4 第四步補(bǔ)上輸入校驗(yàn)和異常處理這一部分雖然不是典型的重構(gòu)操作但在工程實(shí)踐中很重要。因?yàn)橹貥?gòu)要求“不改變外部行為”而原來(lái)的程序在輸入非法字符時(shí)會(huì)崩潰。如果直接把非法輸入判定的行為修好其實(shí)已經(jīng)算行為變化了。更合理的做法是先把原有行為用測(cè)試固定下來(lái)再在單獨(dú)提交中加入輸入校驗(yàn)。不過(guò)對(duì)于教學(xué)示例我們可以把健壯性作為重構(gòu)的一部分來(lái)演示只要在文章里說(shuō)明這和純粹的重構(gòu)不完全相同即可。加入校驗(yàn)之后程序不會(huì)再因?yàn)橐粋€(gè)非法輸入就退出def read_score(subject: str) - float: while True: try: value float(input(f請(qǐng)輸入{subject}成績(jī))) if not 0 value 100: print(成績(jī)應(yīng)在 0 到 100 之間請(qǐng)重新輸入。) continue return value except ValueError: print(輸入無(wú)效請(qǐng)輸入數(shù)字。)這個(gè)函數(shù)的邏輯是反復(fù)讀取直到拿到一個(gè)合法成績(jī)?yōu)橹埂Ｋ瑫r(shí)處理了“不是數(shù)字”和“成績(jī)超出范圍”兩種情況。4.5 重構(gòu)后的完整代碼下面給出完整的重構(gòu)版本。這個(gè)版本就是前面幾步的綜合結(jié)果# score_v2.py from dataclasses import dataclass dataclass class Student: name: str chinese: float math: float english: float property def total(self) - float: return self.chinese self.math self.english property def average(self) - float: return self.total / 3 def grade(self) - str: if self.average 90: return A if self.average 80: return B return C def read_score(subject: str) - float: while True: try: value float(input(f請(qǐng)輸入{subject}成績(jī))) if not 0 value 100: print(成績(jī)應(yīng)在 0 到 100 之間請(qǐng)重新輸入。) continue return value except ValueError: print(輸入無(wú)效請(qǐng)輸入數(shù)字。) def add_student(students: list) - None: name input(請(qǐng)輸入學(xué)生姓名).strip() if not name: print(姓名不能為空。) return students.append( Student( namename, chineseread_score(語(yǔ)文), mathread_score(數(shù)學(xué)), englishread_score(英語(yǔ)), ) ) print(f已添加學(xué)生{name}) def show_report(students: list) - None: if not students: print(當(dāng)前沒(méi)有學(xué)生數(shù)據(jù)。) return print(\n姓名\t總分\t平均分\t等級(jí)) for stu in students: print(f{stu.name}\t{stu.total:.1f}\t{stu.average:.1f}\t{stu.grade()}) def main() - None: students [] actions {1: add_student, 2: show_report} while True: print(\n學(xué)生成績(jī)管理系統(tǒng)) print(1. 添加學(xué)生) print(2. 顯示成績(jī)) print(3. 退出) choice input(請(qǐng)選擇操作).strip() if choice 3: break action actions.get(choice) if action: action(students) else: print(無(wú)效選擇請(qǐng)輸入 1、2 或 3。) if __name__ __main__: main()這個(gè)版本在功能上和原版本基本一致但結(jié)構(gòu)已經(jīng)完全不同學(xué)生信息由Student數(shù)據(jù)類(lèi)統(tǒng)一管理總分、平均分、等級(jí)邏輯內(nèi)聚在類(lèi)內(nèi)部每個(gè)函數(shù)職責(zé)單一輸入非法數(shù)據(jù)不會(huì)直接崩潰菜單邏輯和業(yè)務(wù)邏輯分離4.6 運(yùn)行與驗(yàn)證python score_v2.py運(yùn)行后可以簡(jiǎn)單驗(yàn)證一下學(xué)生成績(jī)管理系統(tǒng) 1. 添加學(xué)生 2. 顯示成績(jī) 3. 退出 請(qǐng)選擇操作1 請(qǐng)輸入學(xué)生姓名小明 請(qǐng)輸入語(yǔ)文成績(jī)88 請(qǐng)輸入數(shù)學(xué)成績(jī)95 請(qǐng)輸入英語(yǔ)成績(jī)90 已添加學(xué)生小明 學(xué)生成績(jī)管理系統(tǒng) 1. 添加學(xué)生 2. 顯示成績(jī) 3. 退出 請(qǐng)選擇操作2 姓名 總分 平均分 等級(jí) 小明 273.0 91.0 A如果此時(shí)輸入abc作為成績(jī)程序會(huì)提示“輸入無(wú)效請(qǐng)輸入數(shù)字”而不是拋出異常退出。這正是健壯性提升帶來(lái)的直觀(guān)效果。5. 哪些“重構(gòu)”其實(shí)不是真正的重構(gòu)5.1 只改變量名和加注釋前面提到過(guò)重命名是重構(gòu)的一部分但如果一次“重構(gòu)”只做了重命名和注釋沒(méi)有改善代碼結(jié)構(gòu)那它的價(jià)值確實(shí)有限。比如下面這種操作# 偽重構(gòu)只把變量名改了結(jié)構(gòu)沒(méi)有變 for item in students: avg item[5] level A if avg 90 else B print(item[0], item[4], avg, level)這段代碼看起來(lái)比原來(lái)清晰了一點(diǎn)但魔法下標(biāo)依然存在。如果后續(xù)在item中插入新字段這里依然會(huì)出錯(cuò)。判斷一次重構(gòu)是否有效要看“結(jié)構(gòu)風(fēng)險(xiǎn)”有沒(méi)有下降而不是看名字是否變長(zhǎng)。5.2 大范圍重寫(xiě)不是重構(gòu)有些開(kāi)發(fā)者會(huì)把“重構(gòu)”當(dāng)成“重寫(xiě)”的擋箭牌。他們把整個(gè)模塊推翻換了一套新框架或新數(shù)據(jù)結(jié)構(gòu)然后對(duì)外宣稱(chēng)“重構(gòu)了”。重構(gòu)的特點(diǎn)是小步快走每一步都盡量不改變行為。重寫(xiě)則是一次性替換風(fēng)險(xiǎn)更高。沒(méi)有一個(gè)合格的測(cè)試保護(hù)大范圍重寫(xiě)很容易把原本穩(wěn)定運(yùn)行的功能改壞并且很難定位問(wèn)題。如果確實(shí)需要重寫(xiě)建議明確寫(xiě)成“重寫(xiě)方案”而不是用“重構(gòu)”來(lái)模糊范圍。5.3 為了炫技而過(guò)度設(shè)計(jì)還有一種常見(jiàn)情況是代碼本來(lái)很簡(jiǎn)單為了體現(xiàn)“架構(gòu)能力”強(qiáng)行引入設(shè)計(jì)模式、抽象類(lèi)、工廠(chǎng)方法、依賴(lài)注入結(jié)果一個(gè) 50 行的腳本變成了 10 個(gè)類(lèi)。這種過(guò)度設(shè)計(jì)是可讀性的敵人。重構(gòu)的目的是讓修改更簡(jiǎn)單不是讓代碼看起來(lái)更復(fù)雜。比如一個(gè)只需要用列表存幾個(gè)學(xué)生的教學(xué)程序完全沒(méi)必要拆出AbstractStudentFactory。判斷標(biāo)準(zhǔn)很簡(jiǎn)單改一個(gè)需求時(shí)你愿意改幾處代碼如果反而比以前要改更多文件那這就不叫重構(gòu)叫過(guò)度工程。6. 重構(gòu)的工程實(shí)踐與工具建議6.1 在測(cè)試保護(hù)下小步重構(gòu)無(wú)論你重構(gòu)成熟度如何最重要的一條原則是先有測(cè)試再動(dòng)手。重構(gòu)要求不改變外部行為而唯一可靠驗(yàn)證“行為是否改變”的方式就是對(duì)比運(yùn)行結(jié)果。如果你在重構(gòu)前沒(méi)有任何測(cè)試重構(gòu)后程序突然報(bào)錯(cuò)你很難知道是自己哪一步改錯(cuò)了還是原來(lái)就存在隱患。對(duì) Python 項(xiàng)目來(lái)說(shuō)最簡(jiǎn)單的做法是編寫(xiě)幾個(gè)針對(duì)核心函數(shù)的單元測(cè)試。比如在上面的學(xué)生成績(jī)系統(tǒng)里可以針對(duì)average屬性和grade方法寫(xiě)測(cè)試。對(duì)小項(xiàng)目來(lái)說(shuō)哪怕沒(méi)有自動(dòng)化測(cè)試也應(yīng)該在重構(gòu)前手動(dòng)準(zhǔn)備多組輸入用例并把預(yù)期輸出記錄下來(lái)。重構(gòu)完再跑一遍確保結(jié)果完全一致。6.2 使用版本控制保存每個(gè)中間狀態(tài)重構(gòu)不是一次“大爆炸式”的修改。更推薦的方式是把重構(gòu)拆成多個(gè)小步驟每個(gè)步驟提交一次。比如先提交“重命名變量”再提交“引入 Student 數(shù)據(jù)類(lèi)”再提交“拆分函數(shù)”。在本地開(kāi)發(fā)時(shí)建議把倉(cāng)庫(kù)初始化好并定期推送到遠(yuǎn)程。Gitee、GitHub 這些平臺(tái)都適合保存提交點(diǎn)。這樣一旦某一步重構(gòu)出了問(wèn)題可以直接git revert回退到上一個(gè)安全狀態(tài)不需要撤銷(xiāo)整個(gè)項(xiàng)目。版本控制還有一個(gè)好處代碼評(píng)審的時(shí)候同事可以按提交記錄查看每次改動(dòng)的意圖而不是面對(duì)一個(gè) 1000 行的巨型 diff 無(wú)從下手。6.3 借助代碼診斷與靜態(tài)掃描工具有些壞味道靠肉眼不一定能發(fā)現(xiàn)尤其是重復(fù)代碼和復(fù)雜度過(guò)高的問(wèn)題。此時(shí)可以借助工具。IDE 自帶的代碼診斷插件比如 PyCharm 會(huì)直接提示“This inspection may highlight spelling errors in names”ESLint 會(huì)提示代碼中未使用的變量和復(fù)雜度過(guò)高的函數(shù)。SonarQube 可以?huà)呙璞镜卮a輸出代碼重復(fù)率、圈復(fù)雜度、注釋密度、潛在 bug 等指標(biāo)。Pylint、Flake8 這類(lèi) Python 工具也能快速定位命名不符合規(guī)范、函數(shù)太復(fù)雜、缺少模塊注釋等問(wèn)題。工具不能代替人的判斷但它們可以充當(dāng)“第一道防線(xiàn)”幫助你在重構(gòu)之前迅速鎖定問(wèn)題密集的區(qū)域。6.4 AI 輔助重構(gòu)正在成為新趨勢(shì)近年來(lái)大模型輔助重構(gòu)的案例越來(lái)越多。之前有人分享過(guò)“用 AI 在兩天內(nèi)重構(gòu) 2 萬(wàn)行 Vue 項(xiàng)目”的實(shí)踐具體做法是先給 AI 提供項(xiàng)目結(jié)構(gòu)和示例代碼再讓它對(duì)重復(fù)組件做抽象、對(duì)復(fù)雜邏輯做拆分最后由人工逐段驗(yàn)收。這表明 AI 在處理“機(jī)械性重構(gòu)”方面確實(shí)有潛力比如批量重命名、消除重復(fù)代碼、統(tǒng)一錯(cuò)誤處理等。但 AI 重構(gòu)仍然需要人工把關(guān)因?yàn)楣ぞ邿o(wú)法理解業(yè)務(wù)語(yǔ)義可能把一個(gè)看起來(lái)“重復(fù)”但語(yǔ)義不同的代碼錯(cuò)誤合并。對(duì)小學(xué)生的編程學(xué)習(xí)來(lái)說(shuō)AI 更像一個(gè)輔助工具。更重要的是思考“為什么這樣改”而不是讓 AI 一次性把代碼改好然后復(fù)制粘貼交作業(yè)。6.5 多讀優(yōu)秀代碼和經(jīng)典實(shí)現(xiàn)提升重構(gòu)能力最快的方法之一是閱讀優(yōu)秀代碼。比如同樣是排序有人能用幾行簡(jiǎn)潔代碼實(shí)現(xiàn)快速排序但可讀性很差也有人用兩個(gè)職責(zé)清晰的函數(shù)寫(xiě)好分區(qū)和遞歸雖然長(zhǎng)一點(diǎn)但“人還能看懂”。學(xué)習(xí) JavaScript 防抖和節(jié)流時(shí)也是同理。市面上有各種版本有的用大量閉包技巧壓縮在一行有的則把timer的維護(hù)拆解成清晰的狀態(tài)管理。初學(xué)者很容易被“一行代碼實(shí)現(xiàn)”吸引但真正到團(tuán)隊(duì)協(xié)作時(shí)可讀性往往比短更重要。讀代碼時(shí)可以問(wèn)自己一個(gè)問(wèn)題如果讓我在三個(gè)月后維護(hù)這段代碼我需要花多長(zhǎng)時(shí)間理解它愿意為這個(gè)目標(biāo)去修改結(jié)構(gòu)就是踏上了正確的重構(gòu)之路。7. 寫(xiě)在最后回到“12歲小學(xué)生重構(gòu)代碼究竟寫(xiě)了啥”這個(gè)題目。最值得關(guān)注的不是那個(gè)孩子具體寫(xiě)了哪幾行而是我們能不能通過(guò)這個(gè)熱鬧的話(huà)題把“重構(gòu)”這顆種子種進(jìn)更多人的意識(shí)里。如果你也想實(shí)際體驗(yàn)一下重構(gòu)最簡(jiǎn)單的方式是找一個(gè)你自己寫(xiě)過(guò)的最早的“能跑但很亂”的小程序按本文第 4 節(jié)的順序改一遍。先改命名再封裝數(shù)據(jù)再拆分函數(shù)最后補(bǔ)異常處理。改完之后找一個(gè)沒(méi)看過(guò)原代碼的同學(xué)來(lái)讀看他能不能很快說(shuō)出每個(gè)函數(shù)在做什么。等你跑通這個(gè)流程后還可以繼續(xù)挑戰(zhàn)把學(xué)生名單保存到文件里下次啟動(dòng)程序時(shí)自動(dòng)加載增加一個(gè)“按總分排序”的功能甚至把命令行菜單改成簡(jiǎn)單的 Web 頁(yè)面。每一次新功能加入都是檢驗(yàn)上一次重構(gòu)是否到位的機(jī)會(huì)。重構(gòu)不是一個(gè)一次性的動(dòng)作而是一種寫(xiě)代碼時(shí)持續(xù)存在的判斷力。真正的收益不在重構(gòu)發(fā)生的那一刻而在下一次需求變動(dòng)時(shí)你發(fā)現(xiàn)自己只需要改一處而不是滿(mǎn)文件找線(xiàn)索。 12歲小學(xué)生因重構(gòu)代碼引熱議：到底什么才算真正的代碼重構(gòu)？
最近技術(shù)圈里有個(gè)話(huà)題挺有意思一個(gè)12歲的小學(xué)生給一段代碼做了“重構(gòu)”還把前后對(duì)比曬了出來(lái)。很多人看完第一反應(yīng)是——“這也叫重構(gòu)不就是改了個(gè)變量名加了點(diǎn)注釋嗎”另一撥人卻覺(jué)得一個(gè)剛開(kāi)始學(xué)編程的孩子能主動(dòng)去美化代碼、拆分邏輯這個(gè)意識(shí)本身就比技巧更值得鼓勵(lì)。老實(shí)說(shuō)事情的關(guān)鍵不在于小學(xué)生寫(xiě)了什么高級(jí)代碼而在于“重構(gòu)”這個(gè)詞被反復(fù)提起之后很多人對(duì)它的理解其實(shí)還很模糊。有人把重構(gòu)等同于格式化有人把重構(gòu)等同于重寫(xiě)還有人覺(jué)得代碼能運(yùn)行就行折騰結(jié)構(gòu)純屬多余。本文不打算去評(píng)價(jià)那個(gè)小學(xué)生寫(xiě)得怎么樣而是借這個(gè)話(huà)題把“代碼重構(gòu)”拆開(kāi)講清楚它到底是什么、常見(jiàn)手法有哪些、一次像樣的重構(gòu)應(yīng)該怎么做以及新手在重構(gòu)時(shí)最容易踩哪些坑。1. 12歲小學(xué)生“重構(gòu)代碼”為什么能引起討論1.1 兩派觀(guān)點(diǎn)是無(wú)用功還是好習(xí)慣這個(gè)話(huà)題能火本質(zhì)上是“業(yè)余認(rèn)知”和“工程認(rèn)知”的碰撞。第一派人的視角很直接如果我看到一段代碼只是變量名從c改成chinese_score或者把一段循環(huán)單獨(dú)提出來(lái)包成一個(gè)函數(shù)我不會(huì)覺(jué)得這是一次重構(gòu)。因?yàn)樵诔墒斓墓こ虉F(tuán)隊(duì)里這些屬于最基本的代碼衛(wèi)生習(xí)慣是寫(xiě)代碼時(shí)順手就該做掉的事不值得拿出來(lái)稱(chēng)贊。另一派人的視角更寬容對(duì)小學(xué)階段的孩子來(lái)說(shuō)信息課作業(yè)通常停留在“結(jié)果正確”層面老師判分也不會(huì)關(guān)心你變量名叫什么。這個(gè)時(shí)候孩子愿意回頭改代碼說(shuō)明他已經(jīng)開(kāi)始意識(shí)到代碼不僅僅是寫(xiě)給機(jī)器執(zhí)行的更是寫(xiě)給將來(lái)的人閱讀的。這種“代碼可讀性”意識(shí)的覺(jué)醒恰恰是很多科班學(xué)生到大三都不一定形成的。這兩種說(shuō)法都有道理。技術(shù)含量和成長(zhǎng)意義不是同一件事。與其爭(zhēng)“小學(xué)生到底算不算重構(gòu)”不如冷靜下來(lái)把“重構(gòu)”這個(gè)概念本身梳理一遍。1.2 重構(gòu)是有層次和粒度的如果把重構(gòu)看成一個(gè)從淺到深的光譜大致可以分成三個(gè)層次層次目標(biāo)常見(jiàn)操作第一層代碼整理讓眼前這段代碼更可讀重命名變量、提取函數(shù)、補(bǔ)充注釋、統(tǒng)一格式第二層結(jié)構(gòu)改進(jìn)讓模塊和類(lèi)邊界更合理拆分大類(lèi)、消除重復(fù)邏輯、優(yōu)化條件判斷第三層架構(gòu)演進(jìn)讓系統(tǒng)整體更易擴(kuò)展引入設(shè)計(jì)模式、模塊解耦、重構(gòu)數(shù)據(jù)存儲(chǔ)方式對(duì)一個(gè)初學(xué)編程的小學(xué)生來(lái)說(shuō)能做到第一層已經(jīng)很了不起。對(duì)工作三五年的工程師來(lái)說(shuō)如果只停留在第一層那確實(shí)會(huì)被團(tuán)隊(duì)質(zhì)疑“重構(gòu)深度不夠”。所以那篇帖子之所以引發(fā)爭(zhēng)議很大程度上是因?yàn)榇蠹覍?duì)“重構(gòu)”的預(yù)期標(biāo)準(zhǔn)完全不同。1.3 這件事真正值得關(guān)注的地方拋開(kāi)小學(xué)生本身不談“12歲小學(xué)生重構(gòu)代碼”能成為熱詞說(shuō)明大眾對(duì)編程教育的關(guān)注度在提高。與此同時(shí)這也反映出很多人對(duì)代碼質(zhì)量的忽視是普遍存在的。包括一些已經(jīng)工作幾年的開(kāi)發(fā)者拿到需求就開(kāi)寫(xiě)從來(lái)沒(méi)有回頭清理過(guò)自己代碼里的壞味道。之前有公司分享過(guò)“用AI在兩天內(nèi)重構(gòu)2萬(wàn)行Vue項(xiàng)目”的實(shí)踐當(dāng)時(shí)也引起過(guò)不少討論。這個(gè)案例說(shuō)明一個(gè)趨勢(shì)重構(gòu)不是可有可無(wú)的“潔癖行為”而是大型項(xiàng)目持續(xù)演進(jìn)過(guò)程中繞不開(kāi)的工程任務(wù)。代碼在業(yè)務(wù)迭代中會(huì)不斷增加功能如果每隔一段時(shí)間不進(jìn)行結(jié)構(gòu)性整理代碼復(fù)雜度會(huì)指數(shù)級(jí)上升直到下一個(gè)接手的人徹底崩潰。所以與其嘲諷小學(xué)生“重構(gòu)了個(gè)寂寞”不如把這次熱議當(dāng)成一次契機(jī)我們到底能不能清楚地講明白一次合格的重構(gòu)應(yīng)該包含哪些步驟2. 重構(gòu)的核心概念與判斷標(biāo)準(zhǔn)2.1 重構(gòu)到底怎么定義提到重構(gòu)繞不開(kāi) Martin Fowler 在《重構(gòu)改善既有代碼的設(shè)計(jì)》里給出的定義重構(gòu)是一種對(duì)軟件內(nèi)部結(jié)構(gòu)的調(diào)整目的是在不改變軟件可觀(guān)察行為的前提下提高代碼的可理解性降低修改成本。這句話(huà)里有幾個(gè)關(guān)鍵詞值得拆開(kāi)理解。第一個(gè)關(guān)鍵詞是“不改變可觀(guān)察行為”。意思是重構(gòu)前后用戶(hù)輸入同樣的數(shù)據(jù)程序輸出結(jié)果必須保持一致。不能用“順手優(yōu)化了一下功能”這種理由把行為變化混進(jìn)重構(gòu)里。否則一旦出現(xiàn)問(wèn)題你很難判斷是重構(gòu)改壞了還是新需求改壞了。第二個(gè)關(guān)鍵詞是“內(nèi)部結(jié)構(gòu)”。重構(gòu)不是調(diào)整界面布局不是改文字也不是換一套色值。它針對(duì)的是代碼組織方式變量怎么命名、函數(shù)怎么拆分、類(lèi)與類(lèi)之間怎么協(xié)作、數(shù)據(jù)怎么流轉(zhuǎn)。第三個(gè)關(guān)鍵詞是“可理解性”和“修改成本”。重構(gòu)不是為了給誰(shuí)表演而是為了降低未來(lái)改動(dòng)代碼時(shí)的認(rèn)知負(fù)擔(dān)。一段代碼如果連原作者三個(gè)月后都看不懂那它的維護(hù)成本就非常高重構(gòu)價(jià)值也最大。2.2 重構(gòu)與格式化、重寫(xiě)、性能優(yōu)化有什么不同這幾個(gè)概念經(jīng)常被混為一談實(shí)際差別很大。格式化只是調(diào)整空格、換行、縮進(jìn)讓排版符合規(guī)范。它不會(huì)改變代碼結(jié)構(gòu)也沒(méi)有重新組織邏輯。所以把“代碼不規(guī)范”直接說(shuō)成“需要重構(gòu)”并不準(zhǔn)確。重寫(xiě)的動(dòng)作通常比重構(gòu)大得多。重寫(xiě)意味著把舊代碼推到一邊用新方案重新實(shí)現(xiàn)一遍。重構(gòu)則是在現(xiàn)有代碼基礎(chǔ)上逐步調(diào)整每一步改動(dòng)范圍都盡量縮小。重寫(xiě)風(fēng)險(xiǎn)很高容易丟失舊系統(tǒng)里那些隱藏的業(yè)務(wù)規(guī)則重構(gòu)風(fēng)險(xiǎn)相對(duì)可控因?yàn)樗竺恳徊蕉疾荒芨淖兺獠啃袨?。性能?yōu)化是指為了提升運(yùn)行效率而調(diào)整算法或緩存策略。性能優(yōu)化很可能改變外部行為比如響應(yīng)時(shí)間、內(nèi)存占用、返回結(jié)果順序這些都可能發(fā)生變化。所以在很多開(kāi)發(fā)規(guī)范里性能優(yōu)化和重構(gòu)要分開(kāi)提交分別測(cè)試。舉個(gè)例子快速排序代碼里如果只是把變量i改成left把j改成right這是重構(gòu)的一部分但如果你把遞歸實(shí)現(xiàn)改成非遞歸實(shí)現(xiàn)并且換了分區(qū)策略那就不只是重構(gòu)還夾雜了性能優(yōu)化和算法替換需要按新功能對(duì)待。2.3 一次重構(gòu)是否成功的三個(gè)標(biāo)準(zhǔn)判斷重構(gòu)是否成功不需要看“改了多少行”而是看下面三個(gè)方面第一行為是否保持不變。最直接的辦法是跑一遍原有測(cè)試用例如果可以再做一次手工驗(yàn)證。行為變化越多重構(gòu)的把握就越低。第二結(jié)構(gòu)是否明顯改善。所謂改善可以從重復(fù)代碼是否減少、函數(shù)長(zhǎng)度是否更合理、依賴(lài)方向是否更清晰、命名是否更能表達(dá)意圖等角度判斷。如果你改完之后別人看代碼依然要猜來(lái)猜去那就說(shuō)明重構(gòu)沒(méi)有到位。第三后續(xù)維護(hù)成本是否下降。這一點(diǎn)需要時(shí)間驗(yàn)證。理想情況是重構(gòu)之后新功能加進(jìn)來(lái)時(shí)需要改動(dòng)的文件更少、改動(dòng)的位置更集中、測(cè)試補(bǔ)起來(lái)更容易。如果只是把代碼從 A 風(fēng)格改成 B 風(fēng)格而沒(méi)有降低未來(lái)的修改成本那這次重構(gòu)的意義就有限。3. 用一個(gè)小項(xiàng)目還原“重構(gòu)前”的代碼3.1 場(chǎng)景教學(xué)版學(xué)生成績(jī)管理系統(tǒng)為了更貼近“小學(xué)生、課堂代碼、重構(gòu)”這些關(guān)鍵詞這里用一個(gè)非常常見(jiàn)的教學(xué)項(xiàng)目舉例學(xué)生成績(jī)管理系統(tǒng)。功能很簡(jiǎn)單支持錄入學(xué)生姓名、語(yǔ)文/數(shù)學(xué)/英語(yǔ)三科成績(jī)?nèi)缓笥?jì)算總分、平均分和等級(jí)最后打印成績(jī)單。這種項(xiàng)目在少兒編程課程里很常見(jiàn)業(yè)務(wù)規(guī)則非常簡(jiǎn)單非常適合用來(lái)觀(guān)察代碼結(jié)構(gòu)問(wèn)題。下面先用一種“新手常見(jiàn)的寫(xiě)法”實(shí)現(xiàn)這個(gè)功能。代碼能跑但結(jié)構(gòu)上存在不少問(wèn)題。3.2 原始代碼全貌# score_v1.py students [] while True: print(1. 添加學(xué)生) print(2. 顯示成績(jī)) print(3. 退出) a input(請(qǐng)選擇) if a 1: name input(姓名) c float(input(語(yǔ)文)) m float(input(數(shù)學(xué))) e float(input(英語(yǔ))) zf c m e pj zf / 3 s [name, c, m, e, zf, pj] students.append(s) elif a 2: for x in students: pj x[5] if pj 90: lv A elif pj 80: lv B else: lv C print(x[0], x[4], pj, lv) elif a 3: break else: print(輸入錯(cuò)誤)如果你已經(jīng)寫(xiě)過(guò)幾年代碼看到這段代碼大概會(huì)有一種“馬上要大改”的沖動(dòng)。對(duì)初學(xué)者來(lái)說(shuō)它確實(shí)能用但問(wèn)題非常明顯。3.3 這段代碼的“壞味道”先看變量命名。a代表用戶(hù)選項(xiàng)c代表語(yǔ)文成績(jī)m代表數(shù)學(xué)成績(jī)e代表英語(yǔ)成績(jī)zf代表總分pj代表平均分lv代表等級(jí)。這些縮寫(xiě)對(duì)寫(xiě)代碼的人自己來(lái)說(shuō)當(dāng)然記得住但放到一個(gè)稍微大一點(diǎn)的項(xiàng)目里別人讀起來(lái)就非常痛苦。更重要的是三個(gè)月后你自己回來(lái)讀也要先花時(shí)間回憶這幾個(gè)字母分別代表什么。再看數(shù)據(jù)結(jié)構(gòu)。學(xué)生信息被存成了一個(gè)列表[name, c, m, e, zf, pj]。也就是說(shuō)訪(fǎng)問(wèn)姓名用的是x[0]訪(fǎng)問(wèn)總分用的是x[4]訪(fǎng)問(wèn)平均分用的是x[5]。這完全是“魔法下標(biāo)”只要中間插入一個(gè)新字段比如性別后面所有下標(biāo)都要跟著改。一旦漏改程序就會(huì)在運(yùn)行時(shí)暴露出各種奇怪問(wèn)題。再看邏輯邊界。等級(jí)判斷這段規(guī)則被直接寫(xiě)在了輸出分支里如果以后要新增一個(gè)錄入“優(yōu)、良、及格、不及格”的等級(jí)邏輯就需要復(fù)制一份判斷代碼。重復(fù)代碼一旦出現(xiàn)就會(huì)造成“改了這處忘了那處”的維護(hù)問(wèn)題。最后是健壯性。輸入語(yǔ)文成績(jī)時(shí)如果直接輸入一個(gè)abc程序會(huì)拋出ValueError并退出。對(duì)用戶(hù)而言這個(gè)體驗(yàn)是很糟糕的。4. 把這段代碼逐步重構(gòu)4.1 第一步讓命名能表達(dá)業(yè)務(wù)含義重構(gòu)不需要一上來(lái)就推翻重寫(xiě)。最安全的第一步是把那些含義不清的變量名改成“讀起來(lái)像人話(huà)”的名字。比如a改成choicec改成chinese_scorem改成math_scoree改成english_scorezf改成total_scorepj改成average_scorelv改成level。這一步只改變名字不改變?nèi)魏芜壿?。改完之后代碼會(huì)變長(zhǎng)一些但可讀性會(huì)明顯提高。更關(guān)鍵的是這種重命名操作在 IDE 里有專(zhuān)門(mén)的重構(gòu)功能可以直接批量替換不需要一個(gè)一個(gè)手動(dòng)改。這一步的意義在于讓代碼讀起來(lái)像一段自然語(yǔ)言。比如average_score total_score / 3比pj zf / 3清晰得多。4.2 第二步用數(shù)據(jù)結(jié)構(gòu)表達(dá)真實(shí)業(yè)務(wù)對(duì)象接著處理“魔法下標(biāo)”。學(xué)生信息本質(zhì)上是一個(gè)業(yè)務(wù)對(duì)象包含姓名和三科成績(jī)。與其塞在一個(gè) list 里靠下標(biāo)訪(fǎng)問(wèn)不如用一個(gè)數(shù)據(jù)類(lèi)來(lái)描述它。在 Python 中可以用dataclasses來(lái)定義from dataclasses import dataclass dataclass class Student: name: str chinese: float math: float english: float有了這個(gè)類(lèi)之后訪(fǎng)問(wèn)學(xué)生信息就不需要再去記憶“第4個(gè)位置是總分”。總分、平均分、等級(jí)這些派生數(shù)據(jù)可以直接定義成只讀屬性或者方法。這個(gè)步驟的重點(diǎn)是把現(xiàn)實(shí)世界里的對(duì)象映射成代碼里的結(jié)構(gòu)。它屬于“用數(shù)據(jù)結(jié)構(gòu)表達(dá)業(yè)務(wù)”的典型重構(gòu)手法。很多初學(xué)者覺(jué)得這多余但等到項(xiàng)目里出現(xiàn)幾十個(gè)字段時(shí)就會(huì)發(fā)現(xiàn)列表和字典的脆弱的版本管理方式完全不夠用。4.3 第三步拆分函數(shù)讓每個(gè)函數(shù)只做一件事接下來(lái)把整個(gè) while 循環(huán)里的邏輯拆成函數(shù)。一個(gè)常見(jiàn)的拆分思路是read_score讀取單科成績(jī)并校驗(yàn)add_student添加學(xué)生show_report打印成績(jī)單main控制菜單邏輯拆函數(shù)不是為了看上去更“規(guī)范”而是讓每一段邏輯可以被單獨(dú)測(cè)試、單獨(dú)修改。比如等級(jí)判斷可以抽成 Student 的方法def grade(self) - str: if self.average 90: return A if self.average 80: return B return C以后如果新增一個(gè)“平均分大于等于60為及格”的規(guī)則只需要改這個(gè)方法不影響到其他代碼。4.4 第四步補(bǔ)上輸入校驗(yàn)和異常處理這一部分雖然不是典型的重構(gòu)操作但在工程實(shí)踐中很重要。因?yàn)橹貥?gòu)要求“不改變外部行為”而原來(lái)的程序在輸入非法字符時(shí)會(huì)崩潰。如果直接把非法輸入判定的行為修好其實(shí)已經(jīng)算行為變化了。更合理的做法是先把原有行為用測(cè)試固定下來(lái)再在單獨(dú)提交中加入輸入校驗(yàn)。不過(guò)對(duì)于教學(xué)示例我們可以把健壯性作為重構(gòu)的一部分來(lái)演示只要在文章里說(shuō)明這和純粹的重構(gòu)不完全相同即可。加入校驗(yàn)之后程序不會(huì)再因?yàn)橐粋€(gè)非法輸入就退出def read_score(subject: str) - float: while True: try: value float(input(f請(qǐng)輸入{subject}成績(jī))) if not 0 value 100: print(成績(jī)應(yīng)在 0 到 100 之間請(qǐng)重新輸入。) continue return value except ValueError: print(輸入無(wú)效請(qǐng)輸入數(shù)字。)這個(gè)函數(shù)的邏輯是反復(fù)讀取直到拿到一個(gè)合法成績(jī)?yōu)橹埂Ｋ瑫r(shí)處理了“不是數(shù)字”和“成績(jī)超出范圍”兩種情況。4.5 重構(gòu)后的完整代碼下面給出完整的重構(gòu)版本。這個(gè)版本就是前面幾步的綜合結(jié)果# score_v2.py from dataclasses import dataclass dataclass class Student: name: str chinese: float math: float english: float property def total(self) - float: return self.chinese self.math self.english property def average(self) - float: return self.total / 3 def grade(self) - str: if self.average 90: return A if self.average 80: return B return C def read_score(subject: str) - float: while True: try: value float(input(f請(qǐng)輸入{subject}成績(jī))) if not 0 value 100: print(成績(jī)應(yīng)在 0 到 100 之間請(qǐng)重新輸入。) continue return value except ValueError: print(輸入無(wú)效請(qǐng)輸入數(shù)字。) def add_student(students: list) - None: name input(請(qǐng)輸入學(xué)生姓名).strip() if not name: print(姓名不能為空。) return students.append( Student( namename, chineseread_score(語(yǔ)文), mathread_score(數(shù)學(xué)), englishread_score(英語(yǔ)), ) ) print(f已添加學(xué)生{name}) def show_report(students: list) - None: if not students: print(當(dāng)前沒(méi)有學(xué)生數(shù)據(jù)。) return print(\n姓名\t總分\t平均分\t等級(jí)) for stu in students: print(f{stu.name}\t{stu.total:.1f}\t{stu.average:.1f}\t{stu.grade()}) def main() - None: students [] actions {1: add_student, 2: show_report} while True: print(\n學(xué)生成績(jī)管理系統(tǒng)) print(1. 添加學(xué)生) print(2. 顯示成績(jī)) print(3. 退出) choice input(請(qǐng)選擇操作).strip() if choice 3: break action actions.get(choice) if action: action(students) else: print(無(wú)效選擇請(qǐng)輸入 1、2 或 3。) if __name__ __main__: main()這個(gè)版本在功能上和原版本基本一致但結(jié)構(gòu)已經(jīng)完全不同學(xué)生信息由Student數(shù)據(jù)類(lèi)統(tǒng)一管理總分、平均分、等級(jí)邏輯內(nèi)聚在類(lèi)內(nèi)部每個(gè)函數(shù)職責(zé)單一輸入非法數(shù)據(jù)不會(huì)直接崩潰菜單邏輯和業(yè)務(wù)邏輯分離4.6 運(yùn)行與驗(yàn)證python score_v2.py運(yùn)行后可以簡(jiǎn)單驗(yàn)證一下學(xué)生成績(jī)管理系統(tǒng) 1. 添加學(xué)生 2. 顯示成績(jī) 3. 退出 請(qǐng)選擇操作1 請(qǐng)輸入學(xué)生姓名小明 請(qǐng)輸入語(yǔ)文成績(jī)88 請(qǐng)輸入數(shù)學(xué)成績(jī)95 請(qǐng)輸入英語(yǔ)成績(jī)90 已添加學(xué)生小明 學(xué)生成績(jī)管理系統(tǒng) 1. 添加學(xué)生 2. 顯示成績(jī) 3. 退出 請(qǐng)選擇操作2 姓名 總分 平均分 等級(jí) 小明 273.0 91.0 A如果此時(shí)輸入abc作為成績(jī)程序會(huì)提示“輸入無(wú)效請(qǐng)輸入數(shù)字”而不是拋出異常退出。這正是健壯性提升帶來(lái)的直觀(guān)效果。5. 哪些“重構(gòu)”其實(shí)不是真正的重構(gòu)5.1 只改變量名和加注釋前面提到過(guò)重命名是重構(gòu)的一部分但如果一次“重構(gòu)”只做了重命名和注釋沒(méi)有改善代碼結(jié)構(gòu)那它的價(jià)值確實(shí)有限。比如下面這種操作# 偽重構(gòu)只把變量名改了結(jié)構(gòu)沒(méi)有變 for item in students: avg item[5] level A if avg 90 else B print(item[0], item[4], avg, level)這段代碼看起來(lái)比原來(lái)清晰了一點(diǎn)但魔法下標(biāo)依然存在。如果后續(xù)在item中插入新字段這里依然會(huì)出錯(cuò)。判斷一次重構(gòu)是否有效要看“結(jié)構(gòu)風(fēng)險(xiǎn)”有沒(méi)有下降而不是看名字是否變長(zhǎng)。5.2 大范圍重寫(xiě)不是重構(gòu)有些開(kāi)發(fā)者會(huì)把“重構(gòu)”當(dāng)成“重寫(xiě)”的擋箭牌。他們把整個(gè)模塊推翻換了一套新框架或新數(shù)據(jù)結(jié)構(gòu)然后對(duì)外宣稱(chēng)“重構(gòu)了”。重構(gòu)的特點(diǎn)是小步快走每一步都盡量不改變行為。重寫(xiě)則是一次性替換風(fēng)險(xiǎn)更高。沒(méi)有一個(gè)合格的測(cè)試保護(hù)大范圍重寫(xiě)很容易把原本穩(wěn)定運(yùn)行的功能改壞并且很難定位問(wèn)題。如果確實(shí)需要重寫(xiě)建議明確寫(xiě)成“重寫(xiě)方案”而不是用“重構(gòu)”來(lái)模糊范圍。5.3 為了炫技而過(guò)度設(shè)計(jì)還有一種常見(jiàn)情況是代碼本來(lái)很簡(jiǎn)單為了體現(xiàn)“架構(gòu)能力”強(qiáng)行引入設(shè)計(jì)模式、抽象類(lèi)、工廠(chǎng)方法、依賴(lài)注入結(jié)果一個(gè) 50 行的腳本變成了 10 個(gè)類(lèi)。這種過(guò)度設(shè)計(jì)是可讀性的敵人。重構(gòu)的目的是讓修改更簡(jiǎn)單不是讓代碼看起來(lái)更復(fù)雜。比如一個(gè)只需要用列表存幾個(gè)學(xué)生的教學(xué)程序完全沒(méi)必要拆出AbstractStudentFactory。判斷標(biāo)準(zhǔn)很簡(jiǎn)單改一個(gè)需求時(shí)你愿意改幾處代碼如果反而比以前要改更多文件那這就不叫重構(gòu)叫過(guò)度工程。6. 重構(gòu)的工程實(shí)踐與工具建議6.1 在測(cè)試保護(hù)下小步重構(gòu)無(wú)論你重構(gòu)成熟度如何最重要的一條原則是先有測(cè)試再動(dòng)手。重構(gòu)要求不改變外部行為而唯一可靠驗(yàn)證“行為是否改變”的方式就是對(duì)比運(yùn)行結(jié)果。如果你在重構(gòu)前沒(méi)有任何測(cè)試重構(gòu)后程序突然報(bào)錯(cuò)你很難知道是自己哪一步改錯(cuò)了還是原來(lái)就存在隱患。對(duì) Python 項(xiàng)目來(lái)說(shuō)最簡(jiǎn)單的做法是編寫(xiě)幾個(gè)針對(duì)核心函數(shù)的單元測(cè)試。比如在上面的學(xué)生成績(jī)系統(tǒng)里可以針對(duì)average屬性和grade方法寫(xiě)測(cè)試。對(duì)小項(xiàng)目來(lái)說(shuō)哪怕沒(méi)有自動(dòng)化測(cè)試也應(yīng)該在重構(gòu)前手動(dòng)準(zhǔn)備多組輸入用例并把預(yù)期輸出記錄下來(lái)。重構(gòu)完再跑一遍確保結(jié)果完全一致。6.2 使用版本控制保存每個(gè)中間狀態(tài)重構(gòu)不是一次“大爆炸式”的修改。更推薦的方式是把重構(gòu)拆成多個(gè)小步驟每個(gè)步驟提交一次。比如先提交“重命名變量”再提交“引入 Student 數(shù)據(jù)類(lèi)”再提交“拆分函數(shù)”。在本地開(kāi)發(fā)時(shí)建議把倉(cāng)庫(kù)初始化好并定期推送到遠(yuǎn)程。Gitee、GitHub 這些平臺(tái)都適合保存提交點(diǎn)。這樣一旦某一步重構(gòu)出了問(wèn)題可以直接git revert回退到上一個(gè)安全狀態(tài)不需要撤銷(xiāo)整個(gè)項(xiàng)目。版本控制還有一個(gè)好處代碼評(píng)審的時(shí)候同事可以按提交記錄查看每次改動(dòng)的意圖而不是面對(duì)一個(gè) 1000 行的巨型 diff 無(wú)從下手。6.3 借助代碼診斷與靜態(tài)掃描工具有些壞味道靠肉眼不一定能發(fā)現(xiàn)尤其是重復(fù)代碼和復(fù)雜度過(guò)高的問(wèn)題。此時(shí)可以借助工具。IDE 自帶的代碼診斷插件比如 PyCharm 會(huì)直接提示“This inspection may highlight spelling errors in names”ESLint 會(huì)提示代碼中未使用的變量和復(fù)雜度過(guò)高的函數(shù)。SonarQube 可以?huà)呙璞镜卮a輸出代碼重復(fù)率、圈復(fù)雜度、注釋密度、潛在 bug 等指標(biāo)。Pylint、Flake8 這類(lèi) Python 工具也能快速定位命名不符合規(guī)范、函數(shù)太復(fù)雜、缺少模塊注釋等問(wèn)題。工具不能代替人的判斷但它們可以充當(dāng)“第一道防線(xiàn)”幫助你在重構(gòu)之前迅速鎖定問(wèn)題密集的區(qū)域。6.4 AI 輔助重構(gòu)正在成為新趨勢(shì)近年來(lái)大模型輔助重構(gòu)的案例越來(lái)越多。之前有人分享過(guò)“用 AI 在兩天內(nèi)重構(gòu) 2 萬(wàn)行 Vue 項(xiàng)目”的實(shí)踐具體做法是先給 AI 提供項(xiàng)目結(jié)構(gòu)和示例代碼再讓它對(duì)重復(fù)組件做抽象、對(duì)復(fù)雜邏輯做拆分最后由人工逐段驗(yàn)收。這表明 AI 在處理“機(jī)械性重構(gòu)”方面確實(shí)有潛力比如批量重命名、消除重復(fù)代碼、統(tǒng)一錯(cuò)誤處理等。但 AI 重構(gòu)仍然需要人工把關(guān)因?yàn)楣ぞ邿o(wú)法理解業(yè)務(wù)語(yǔ)義可能把一個(gè)看起來(lái)“重復(fù)”但語(yǔ)義不同的代碼錯(cuò)誤合并。對(duì)小學(xué)生的編程學(xué)習(xí)來(lái)說(shuō)AI 更像一個(gè)輔助工具。更重要的是思考“為什么這樣改”而不是讓 AI 一次性把代碼改好然后復(fù)制粘貼交作業(yè)。6.5 多讀優(yōu)秀代碼和經(jīng)典實(shí)現(xiàn)提升重構(gòu)能力最快的方法之一是閱讀優(yōu)秀代碼。比如同樣是排序有人能用幾行簡(jiǎn)潔代碼實(shí)現(xiàn)快速排序但可讀性很差也有人用兩個(gè)職責(zé)清晰的函數(shù)寫(xiě)好分區(qū)和遞歸雖然長(zhǎng)一點(diǎn)但“人還能看懂”。學(xué)習(xí) JavaScript 防抖和節(jié)流時(shí)也是同理。市面上有各種版本有的用大量閉包技巧壓縮在一行有的則把timer的維護(hù)拆解成清晰的狀態(tài)管理。初學(xué)者很容易被“一行代碼實(shí)現(xiàn)”吸引但真正到團(tuán)隊(duì)協(xié)作時(shí)可讀性往往比短更重要。讀代碼時(shí)可以問(wèn)自己一個(gè)問(wèn)題如果讓我在三個(gè)月后維護(hù)這段代碼我需要花多長(zhǎng)時(shí)間理解它愿意為這個(gè)目標(biāo)去修改結(jié)構(gòu)就是踏上了正確的重構(gòu)之路。7. 寫(xiě)在最后回到“12歲小學(xué)生重構(gòu)代碼究竟寫(xiě)了啥”這個(gè)題目。最值得關(guān)注的不是那個(gè)孩子具體寫(xiě)了哪幾行而是我們能不能通過(guò)這個(gè)熱鬧的話(huà)題把“重構(gòu)”這顆種子種進(jìn)更多人的意識(shí)里。如果你也想實(shí)際體驗(yàn)一下重構(gòu)最簡(jiǎn)單的方式是找一個(gè)你自己寫(xiě)過(guò)的最早的“能跑但很亂”的小程序按本文第 4 節(jié)的順序改一遍。先改命名再封裝數(shù)據(jù)再拆分函數(shù)最后補(bǔ)異常處理。改完之后找一個(gè)沒(méi)看過(guò)原代碼的同學(xué)來(lái)讀看他能不能很快說(shuō)出每個(gè)函數(shù)在做什么。等你跑通這個(gè)流程后還可以繼續(xù)挑戰(zhàn)把學(xué)生名單保存到文件里下次啟動(dòng)程序時(shí)自動(dòng)加載增加一個(gè)“按總分排序”的功能甚至把命令行菜單改成簡(jiǎn)單的 Web 頁(yè)面。每一次新功能加入都是檢驗(yàn)上一次重構(gòu)是否到位的機(jī)會(huì)。重構(gòu)不是一個(gè)一次性的動(dòng)作而是一種寫(xiě)代碼時(shí)持續(xù)存在的判斷力。真正的收益不在重構(gòu)發(fā)生的那一刻而在下一次需求變動(dòng)時(shí)你發(fā)現(xiàn)自己只需要改一處而不是滿(mǎn)文件找線(xiàn)索。