1. 程式人生 > 實用技巧 >例項告訴你如何把 if-else 重構成高質量程式碼!

例項告訴你如何把 if-else 重構成高質量程式碼!

  • 為什麼我們寫的程式碼都是 if-else?

  • 異常邏輯處理型重構方法例項一

  • 異常邏輯處理型重構方法例項二

  • 異常邏輯處理型重構方法例項三

  • 異常邏輯處理型重構方法例項四

  • 狀態處理型重構方法例項一

  • 狀態處理型重構方法例項二

  • 總結

為什麼我們寫的程式碼都是 if-else?

程式設計師想必都經歷過這樣的場景:剛開始自己寫的程式碼很簡潔,邏輯清晰,函式精簡,沒有一個 if-else,可隨著程式碼邏輯不斷完善和業務的瞬息萬變:比如需要對入參進行型別和值進行判斷;這裡要判斷下物件是否為 null;不同型別執行不同的流程。

落地到具體實現只能不停地加 if-else 來處理,漸漸地,程式碼變得越來越龐大,函式越來越長,檔案行數也迅速突破上千行,維護難度也越來越大,到後期基本達到一種難以維護的狀態。

雖然我們都很不情願寫出滿屏 if-else 的程式碼,可邏輯上就是需要特殊判斷,很絕望,可也沒辦法避免啊。

其實回頭看看自己的程式碼,寫 if-else 不外乎兩種場景:異常邏輯處理和不同狀態處理。

兩者最主要的區別是:異常邏輯處理說明只能一個分支是正常流程,而不同狀態處理都所有分支都是正常流程。搜尋程式設計師白楠楠公眾號,送你一份Java面試題寶典

怎麼理解?舉個例子:

 //舉例一:異常邏輯處理例子
 Object obj = getObj();
 if (obj != null) {
     //do something
 }else{
     //do something
 }
 
 //舉例二:狀態處理例子
Object obj = getObj();
if (obj.getType == 1) {
    //do something
}else if (obj.getType == 2) {
    //do something
}else{
   //do something
}

第一個例子 if (obj != null) 是異常處理,是程式碼健壯性判斷,只有 if 裡面才是正常的處理流程,else 分支是出錯處理流程;而第二個例子不管 type 等於 1,2 還是其他情況,都屬於業務的正常流程。對於這兩種情況重構的方法也不一樣。

程式碼 if-else 程式碼太多有什麼缺點?

缺點相當明顯了:最大的問題是程式碼邏輯複雜,維護性差,極容易引發 bug。如果使用 if-else,說明 if 分支和 else 分支的重視是同等的,但大多數情況並非如此,容易引起誤解和理解困難。

是否有好的方法優化?如何重構?

方法肯定是有的。重構 if-else 時,心中無時無刻把握一個原則:

儘可能地維持正常流程程式碼在最外層。

意思是說,可以寫 if-else 語句時一定要儘量保持主幹程式碼是正常流程,避免巢狀過深。

實現的手段有:減少巢狀、移除臨時變數、條件取反判斷、合併條件表示式等。

下面舉幾個例項來講解這些重構方法:

異常邏輯處理型重構方法例項一

重構前:

 double disablityAmount(){
     if(_seniority < 2)
         return 0;
 
     if(_monthsDisabled > 12)
         return 0;
 
     if(_isPartTime)
         return 0;

    //do somethig
}

重構後:

double disablityAmount(){
    if(_seniority < 2 || _monthsDisabled > 12 || _isPartTime)
        return 0;

    //do somethig
}

這裡的重構手法叫合併條件表示式:如果有一系列條件測試都得到相同結果,將這些結果測試合併為一個條件表示式。

這個重構手法簡單易懂,帶來的效果也非常明顯,能有效地較少if語句,減少程式碼量邏輯上也更加易懂。

異常邏輯處理型重構方法例項二

重構前:

 double getPayAmount(){
     double result;
     if(_isDead) {
         result = deadAmount();
     }else{
         if(_isSeparated){
             result = separatedAmount();
        }
         else{
            if(_isRetired){
                result = retiredAmount();
            else{
                result = normalPayAmount();
            }
        }
    }
    return result;
}

重構後:

 double getPayAmount(){
     if(_isDead)
         return deadAmount();
 
     if(_isSeparated)
        return separatedAmount();
 
     if(_isRetired)
         return retiredAmount();

    return normalPayAmount();
}

怎麼樣?比對兩個版本,會發現重構後的版本邏輯清晰,簡潔易懂。

和重構前到底有什麼區別呢?

最大的區別是減少 if-else 巢狀。可以看到,最初的版本 if-else 最深的巢狀有三層,看上去邏輯分支非常多,進到裡面基本都要被繞暈。其實,仔細想想巢狀內的 if-else 和最外層並沒有關聯性的,完全可以提取最頂層。

改為平行關係,而非包含關係,if-else 數量沒有變化,但是邏輯清晰明瞭,一目瞭然。

另一個重構點是廢除了 result 臨時變數,直接 return 返回。好處也顯而易見直接結束流程,縮短異常分支流程。原來的做法先賦值給 result 最後統一 return,那麼對於最後 return 的值到底是那個函式返回的結果不明確,增加了一層理解難度。

總結重構的要點:如果 if-else 巢狀沒有關聯性,直接提取到第一層,一定要避免邏輯巢狀太深。儘量減少臨時變數改用 return 直接返回。

異常邏輯處理型重構方法例項三

重構前:

public double getAdjustedCapital(){
    double result = 0.0;
    if(_capital > 0.0 ){
        if(_intRate > 0 && _duration >0){
            resutl = (_income / _duration) *ADJ_FACTOR;
        }
    }
    return result;
}

第一步,運用第一招,減少巢狀和移除臨時變數:

public double getAdjustedCapital(){
    if(_capital <= 0.0 ){
        return 0.0;
    }
    if(_intRate > 0 && _duration >0){
        return (_income / _duration) *ADJ_FACTOR;
    }
    return 0.0;
}

這樣重構後,還不夠,因為主要的語句 (_income / _duration) *ADJ_FACTOR; 在 if 內部,並非在最外層,根據優化原則(儘可能地維持正常流程程式碼在最外層),可以再繼續重構:

 public double getAdjustedCapital(){
     if(_capital <= 0.0 ){
         return 0.0;
     }
     if(_intRate <= 0 || _duration <= 0){
         return 0.0;
     }
 
     return (_income / _duration) *ADJ_FACTOR;
}

這才是好的程式碼風格,邏輯清晰,一目瞭然,沒有 if-else 巢狀難以理解的流程。

這裡用到的重構方法是:將條件反轉使異常情況先退出,讓正常流程維持在主幹流程。

異常邏輯處理型重構方法例項四

重構前:

    /* 查詢年齡大於18歲且為男性的學生列表 */
     public ArrayList<Student> getStudents(int uid){
         ArrayList<Student> result = new ArrayList<Student>();
         Student stu = getStudentByUid(uid);
         if (stu != null) {
             Teacher teacher = stu.getTeacher();
             if(teacher != null){
                 ArrayList<Student> students = teacher.getStudents();
                 if(students != null){
                    for(Student student : students){
                        if(student.getAge() > = 18 && student.getGender() == MALE){
                            result.add(student);
                        }
                    }
                }else {
                    logger.error("獲取學生列表失敗");
                }
            }else {
                logger.error("獲取老師資訊失敗");
            }
        } else {
            logger.error("獲取學生資訊失敗");
        }
        return result;
    }

典型的"箭頭型"程式碼,最大的問題是巢狀過深,解決方法是異常條件先退出,保持主幹流程是核心流程:

重構後:

    /* 查詢年齡大於18歲且為男性的學生列表 */
     public ArrayList<Student> getStudents(int uid){
         ArrayList<Student> result = new ArrayList<Student>();
         Student stu = getStudentByUid(uid);
         if (stu == null) {
             logger.error("獲取學生資訊失敗");
             return result;
         }
 
        Teacher teacher = stu.getTeacher();
        if(teacher == null){
            logger.error("獲取老師資訊失敗");
            return result;
        }

        ArrayList<Student> students = teacher.getStudents();
        if(students == null){
            logger.error("獲取學生列表失敗");
            return result;
        }

        for(Student student : students){
            if(student.getAge() > 18 && student.getGender() == MALE){
                result.add(student);
            }
        }
        return result;
    }

狀態處理型重構方法例項一

重構前:

 double getPayAmount(){
     Object obj = getObj();
     double money = 0;
     if (obj.getType == 1) {
         ObjectA objA = obj.getObjectA();
         money = objA.getMoney()*obj.getNormalMoneryA();
    }
     else if (obj.getType == 2) {
         ObjectB objB = obj.getObjectB();
        money = objB.getMoney()*obj.getNormalMoneryB()+1000;
    }
}

重構後:

 double getPayAmount(){
     Object obj = getObj();
     if (obj.getType == 1) {
         return getType1Money(obj);
     }
     else if (obj.getType == 2) {
         return getType2Money(obj);
     }
 }

double getType1Money(Object obj){
    ObjectA objA = obj.getObjectA();
    return objA.getMoney()*obj.getNormalMoneryA();
}

double getType2Money(Object obj){
    ObjectB objB = obj.getObjectB();
    return objB.getMoney()*obj.getNormalMoneryB()+1000;
}

這裡使用的重構方法是:把 if-else 內的程式碼都封裝成一個公共函式。函式的好處是遮蔽內部實現,縮短 if-else 分支的程式碼。程式碼結構和邏輯上清晰,能一下看出來每一個條件內做的功能。

狀態處理型重構方法例項二

針對狀態處理的程式碼,一種優雅的做法是用多型取代條件表示式(《重構》推薦做法)。

你手上有個條件表示式,它根據物件型別的不同而選擇不同的行為。將這個表示式的每個分支放進一個子類內的覆寫函式中,然後將原始函式宣告為抽象函式。

重構前:

 double getSpeed(){
     switch(_type){
         case EUROPEAN:
            return getBaseSpeed();
         case AFRICAN:
             return getBaseSpeed()-getLoadFactor()*_numberOfCoconuts;
         case NORWEGIAN_BLUE:
             return (_isNailed)?0:getBaseSpeed(_voltage);
     }
}

重構後:

 class Bird{
     abstract double getSpeed();
 }
 
 class European extends Bird{
     double getSpeed(){
         return getBaseSpeed();
    }
 }

class African extends Bird{
    double getSpeed(){
        return getBaseSpeed()-getLoadFactor()*_numberOfCoconuts;
    }
}

class NorwegianBlue extends Bird{
   double getSpeed(){
        return (_isNailed)?0:getBaseSpeed(_voltage);
    }
}

可以看到,使用多型後直接沒有了 if-else,但使用多型對原來程式碼修改過大,需要一番功夫才行。最好在設計之初就使用多型方式。

總結

if-else 程式碼是每一個程式設計師最容易寫出的程式碼,同時也是最容易被寫爛的程式碼,稍不注意,就產生一堆難以維護和邏輯混亂的程式碼。

針對條件型程式碼重構把握一個原則:

儘可能地維持正常流程程式碼在最外層,保持主幹流程是正常核心流程。

為維持這個原則:合併條件表示式可以有效地減少if語句數目;減少巢狀能減少深層次邏輯;異常條件先退出自然而然主幹流程就是正常流程。

針對狀態處理型重構方法有兩種:一種是把不同狀態的操作封裝成函式,簡短 if-else 內程式碼行數;另一種是利用面向物件多型特性直接幹掉了條件判斷。

現在回頭看看自己的程式碼,犯了哪些典型錯誤,趕緊運用這些重構方法重構程式碼吧!!

歡迎關注公眾號:程式設計師白楠楠,領取一份300頁pdf文件的Java核心知識點總結!

這些資料的內容都是面試時面試官必問的知識點,篇章包括了很多知識點,其中包括了有基礎知識、Java集合、JVM、多執行緒併發、spring原理、微服務、Netty 與RPC 、Kafka、日記、設計模式、Java演算法、資料庫、Zookeeper、分散式快取、資料結構等等。

大家一起交流,喜歡文章記得關注我點個贊喲,感謝支援!