來源:codenong.com/cs106475567
爲什麼我們寫的代碼都是 if-else?
異常邏輯處理型重構方法實例一
異常邏輯處理型重構方法實例二
異常邏輯處理型重構方法實例三
異常邏輯處理型重構方法實例四
狀態處理型重構方法實例一
狀態處理型重構方法實例二
總結
爲什麼我們寫的代碼都是 if-else?
程序員想必都經歷過這樣的場景:剛開始自己寫的代碼很簡潔,邏輯清晰,函數精簡,沒有一個 if-else,可隨着代碼邏輯不斷完善和業務的瞬息萬變:比如需要對入參進行類型和值進行判斷;這裏要判斷下對象是否爲 null;不同類型執行不同的流程。
落地到具體實現只能不停地加 if-else 來處理,漸漸地,代碼變得越來越龐大,函數越來越長,文件行數也迅速突破上千行,維護難度也越來越大,到後期基本達到一種難以維護的狀態。
雖然我們都很不情願寫出滿屏 if-else 的代碼,可邏輯上就是需要特殊判斷,很絕望,可也沒辦法避免啊。
其實回頭看看自己的代碼,寫 if-else 不外乎兩種場景:異常邏輯處理和不同狀態處理。
兩者最主要的區別是:異常邏輯處理說明只能一個分支是正常流程,而不同狀態處理都所有分支都是正常流程。
怎麼理解?舉個例子:
1//舉例一:異常邏輯處理例子
2Object obj = getObj();
3if (obj != null) {
4 //do something
5}else{
6 //do something
7}
8
9//舉例二:狀態處理例子
10Object obj = getObj();
11if (obj.getType == 1) {
12 //do something
13}else if (obj.getType == 2) {
14 //do something
15}else{
16 //do something
17}
第一個例子 if (obj != null) 是異常處理,是代碼健壯性判斷,只有 if 裏面纔是正常的處理流程,else 分支是出錯處理流程;而第二個例子不管 type 等於 1,2 還是其他情況,都屬於業務的正常流程。對於這兩種情況重構的方法也不一樣。
代碼 if-else 代碼太多有什麼缺點?
缺點相當明顯了:最大的問題是代碼邏輯複雜,維護性差,極容易引發 bug。如果使用 if-else,說明 if 分支和 else 分支的重視是同等的,但大多數情況並非如此,容易引起誤解和理解困難。
是否有好的方法優化?如何重構?
方法肯定是有的。重構 if-else 時,心中無時無刻把握一個原則:
儘可能地維持正常流程代碼在最外層。
意思是說,可以寫 if-else 語句時一定要儘量保持主幹代碼是正常流程,避免嵌套過深。
實現的手段有:減少嵌套、移除臨時變量、條件取反判斷、合併條件表達式等。
下面舉幾個實例來講解這些重構方法:
異常邏輯處理型重構方法實例一
重構前:
1double disablityAmount(){
2 if(_seniority < 2)
3 return 0;
4
5 if(_monthsDisabled > 12)
6 return 0;
7
8 if(_isPartTime)
9 return 0;
10
11 //do somethig
12}
重構後:
1double disablityAmount(){
2 if(_seniority < 2 || _monthsDisabled > 12 || _isPartTime)
3 return 0;
4
5 //do somethig
6}
這裏的重構手法叫合併條件表達式:如果有一系列條件測試都得到相同結果,將這些結果測試合併爲一個條件表達式。
這個重構手法簡單易懂,帶來的效果也非常明顯,能有效地較少if語句,減少代碼量邏輯上也更加易懂。
異常邏輯處理型重構方法實例二
重構前:
1double getPayAmount(){
2 double result;
3 if(_isDead) {
4 result = deadAmount();
5 }else{
6 if(_isSeparated){
7 result = separatedAmount();
8 }
9 else{
10 if(_isRetired){
11 result = retiredAmount();
12 else{
13 result = normalPayAmount();
14 }
15 }
16 }
17 return result;
18}
重構後:
1double getPayAmount(){
2 if(_isDead)
3 return deadAmount();
4
5 if(_isSeparated)
6 return separatedAmount();
7
8 if(_isRetired)
9 return retiredAmount();
10
11 return normalPayAmount();
12}
怎麼樣?比對兩個版本,會發現重構後的版本邏輯清晰,簡潔易懂。
和重構前到底有什麼區別呢?
最大的區別是減少 if-else 嵌套。可以看到,最初的版本 if-else 最深的嵌套有三層,看上去邏輯分支非常多,進到裏面基本都要被繞暈。其實,仔細想想嵌套內的 if-else 和最外層並沒有關聯性的,完全可以提取最頂層。
改爲平行關係,而非包含關係,if-else 數量沒有變化,但是邏輯清晰明瞭,一目瞭然。
另一個重構點是廢除了 result 臨時變量,直接 return 返回。好處也顯而易見直接結束流程,縮短異常分支流程。原來的做法先賦值給 result 最後統一 return,那麼對於最後 return 的值到底是那個函數返回的結果不明確,增加了一層理解難度。
總結重構的要點:如果 if-else 嵌套沒有關聯性,直接提取到第一層,一定要避免邏輯嵌套太深。儘量減少臨時變量改用 return 直接返回。
異常邏輯處理型重構方法實例三
重構前:
1public double getAdjustedCapital(){
2 double result = 0.0;
3 if(_capital > 0.0 ){
4 if(_intRate > 0 && _duration >0){
5 resutl = (_income / _duration) *ADJ_FACTOR;
6 }
7 }
8 return result;
9}
第一步,運用第一招,減少嵌套和移除臨時變量:
1public double getAdjustedCapital(){
2 if(_capital <= 0.0 ){
3 return 0.0;
4 }
5 if(_intRate > 0 && _duration >0){
6 return (_income / _duration) *ADJ_FACTOR;
7 }
8 return 0.0;
9}
這樣重構後,還不夠,因爲主要的語句 (_income / _duration) *ADJ_FACTOR; 在 if 內部,並非在最外層,根據優化原則(儘可能地維持正常流程代碼在最外層),可以再繼續重構:
1public double getAdjustedCapital(){
2 if(_capital <= 0.0 ){
3 return 0.0;
4 }
5 if(_intRate <= 0 || _duration <= 0){
6 return 0.0;
7 }
8
9 return (_income / _duration) *ADJ_FACTOR;
10}
這纔是好的代碼風格,邏輯清晰,一目瞭然,沒有 if-else 嵌套難以理解的流程。
這裏用到的重構方法是:將條件反轉使異常情況先退出,讓正常流程維持在主幹流程。
異常邏輯處理型重構方法實例四
重構前:
1 /* 查找年齡大於18歲且爲男性的學生列表 */
2 public ArrayList<Student> getStudents(int uid){
3 ArrayList<Student> result = new ArrayList<Student>();
4 Student stu = getStudentByUid(uid);
5 if (stu != null) {
6 Teacher teacher = stu.getTeacher();
7 if(teacher != null){
8 ArrayList<Student> students = teacher.getStudents();
9 if(students != null){
10 for(Student student : students){
11 if(student.getAge() > = 18 && student.getGender() == MALE){
12 result.add(student);
13 }
14 }
15 }else {
16 logger.error("獲取學生列表失敗");
17 }
18 }else {
19 logger.error("獲取老師信息失敗");
20 }
21 } else {
22 logger.error("獲取學生信息失敗");
23 }
24 return result;
25 }
典型的"箭頭型"代碼,最大的問題是嵌套過深,解決方法是異常條件先退出,保持主幹流程是核心流程:
重構後:
1 /* 查找年齡大於18歲且爲男性的學生列表 */
2 public ArrayList<Student> getStudents(int uid){
3 ArrayList<Student> result = new ArrayList<Student>();
4 Student stu = getStudentByUid(uid);
5 if (stu == null) {
6 logger.error("獲取學生信息失敗");
7 return result;
8 }
9
10 Teacher teacher = stu.getTeacher();
11 if(teacher == null){
12 logger.error("獲取老師信息失敗");
13 return result;
14 }
15
16 ArrayList<Student> students = teacher.getStudents();
17 if(students == null){
18 logger.error("獲取學生列表失敗");
19 return result;
20 }
21
22 for(Student student : students){
23 if(student.getAge() > 18 && student.getGender() == MALE){
24 result.add(student);
25 }
26 }
27 return result;
28 }
狀態處理型重構方法實例一
重構前:
1double getPayAmount(){
2 Object obj = getObj();
3 double money = 0;
4 if (obj.getType == 1) {
5 ObjectA objA = obj.getObjectA();
6 money = objA.getMoney()*obj.getNormalMoneryA();
7 }
8 else if (obj.getType == 2) {
9 ObjectB objB = obj.getObjectB();
10 money = objB.getMoney()*obj.getNormalMoneryB()+1000;
11 }
12}
重構後:
1double getPayAmount(){
2 Object obj = getObj();
3 if (obj.getType == 1) {
4 return getType1Money(obj);
5 }
6 else if (obj.getType == 2) {
7 return getType2Money(obj);
8 }
9}
10
11double getType1Money(Object obj){
12 ObjectA objA = obj.getObjectA();
13 return objA.getMoney()*obj.getNormalMoneryA();
14}
15
16double getType2Money(Object obj){
17 ObjectB objB = obj.getObjectB();
18 return objB.getMoney()*obj.getNormalMoneryB()+1000;
19}
這裏使用的重構方法是:把 if-else 內的代碼都封裝成一個公共函數。函數的好處是屏蔽內部實現,縮短 if-else 分支的代碼。代碼結構和邏輯上清晰,能一下看出來每一個條件內做的功能。
狀態處理型重構方法實例二
針對狀態處理的代碼,一種優雅的做法是用多態取代條件表達式(《重構》推薦做法)。
你手上有個條件表達式,它根據對象類型的不同而選擇不同的行爲。將這個表達式的每個分支放進一個子類內的覆寫函數中,然後將原始函數聲明爲抽象函數。
重構前:
1double getSpeed(){
2 switch(_type){
3 case EUROPEAN:
4 return getBaseSpeed();
5 case AFRICAN:
6 return getBaseSpeed()-getLoadFactor()*_numberOfCoconuts;
7 case NORWEGIAN_BLUE:
8 return (_isNailed)?0:getBaseSpeed(_voltage);
9 }
10}
重構後:
1class Bird{
2 abstract double getSpeed();
3}
4
5class European extends Bird{
6 double getSpeed(){
7 return getBaseSpeed();
8 }
9}
10
11class African extends Bird{
12 double getSpeed(){
13 return getBaseSpeed()-getLoadFactor()*_numberOfCoconuts;
14 }
15}
16
17class NorwegianBlue extends Bird{
18 double getSpeed(){
19 return (_isNailed)?0:getBaseSpeed(_voltage);
20 }
21}
可以看到,使用多態後直接沒有了 if-else,但使用多態對原來代碼修改過大,需要一番功夫纔行。最好在設計之初就使用多態方式。
總結
if-else 代碼是每一個程序員最容易寫出的代碼,同時也是最容易被寫爛的代碼,稍不注意,就產生一堆難以維護和邏輯混亂的代碼。
針對條件型代碼重構把握一個原則:
儘可能地維持正常流程代碼在最外層,保持主幹流程是正常核心流程。
爲維持這個原則:合併條件表達式可以有效地減少if語句數目;減少嵌套能減少深層次邏輯;異常條件先退出自然而然主幹流程就是正常流程。
針對狀態處理型重構方法有兩種:一種是把不同狀態的操作封裝成函數,簡短 if-else 內代碼行數;另一種是利用面向對象多態特性直接幹掉了條件判斷。
現在回頭看看自己的代碼,犯了哪些典型錯誤,趕緊運用這些重構方法重構代碼吧!!
更多精彩推薦
☞ Google 鼓勵的 13 條代碼審查標準,建議收藏!
☞ 這些SQL錯誤用法,如果經常犯,說明你的水平還很low...☞ 爲啥不能用uuid做MySQL的主鍵?☞ 微信第 1 行代碼曝光!☞ 奇葩公司按代碼行數算工資,員工一個月提成2.6萬遭開除
最後,推薦給大家一個有趣有料的公衆號:寫代碼的渣渣鵬,回覆 面試 或 資源 送一你整套開發筆記