9條消除if……else的錦囊妙計,助你寫出更優雅的代碼

2021-01-08 Java技術架構

作者:蘇三說技術 連結:https://juejin.cn/post/6913877637802754061來源:掘金

前言

最近在做代碼重構,發現了很多代碼的爛味道。其他的不多說,今天主要說說那些又臭又長的if...else要如何重構。

在介紹更更優雅的編程之前,讓我們一起回顧一下,不好的if...else代碼

一、又臭又長的if...else

廢話不多說,先看看下面的代碼。

public interface IPay { void pay(); } @Servicepublic class AliaPay implements IPay { @Override public void pay() { System.out.println("===發起支付寶支付==="); } } @Servicepublic class WeixinPay implements IPay { @Override public void pay() { System.out.println("===發起微信支付==="); } } @Servicepublic class JingDongPay implements IPay { @Override public void pay() { System.out.println("===發起京東支付==="); } } @Servicepublic class PayService { @Autowired private AliaPay aliaPay; @Autowired private WeixinPay weixinPay; @Autowired private JingDongPay jingDongPay; public void toPay(String code) { if ("alia".equals(code)) { aliaPay.pay(); } elseif ("weixin".equals(code)) { weixinPay.pay(); } elseif ("jingdong".equals(code)) { jingDongPay.pay(); } else { System.out.println("找不到支付方式"); } } }PayService類的toPay方法主要是為了發起支付,根據不同的code,決定調用用不同的支付類(比如:aliaPay)的pay方法進行支付。

這段代碼有什麼問題呢?也許有些人就是這麼幹的。

試想一下,如果支付方式越來越多,比如:又加了百度支付、美團支付、銀聯支付等等,就需要改toPay方法的代碼,增加新的else...if判斷,判斷多了就會導致邏輯越來越多?

很明顯,這裡違法了設計模式六大原則的:開閉原則 和 單一職責原則。

開閉原則:對擴展開放,對修改關閉。就是說增加新功能要儘量少改動已有代碼。

單一職責原則:顧名思義,要求邏輯儘量單一,不要太複雜,便於復用。

那有什麼辦法可以解決這個問題呢?

二、消除if...else的錦囊妙計

1、使用註解

代碼中之所以要用code判斷使用哪個支付類,是因為code和支付類沒有一個綁定關係,如果綁定關係存在了,就可以不用判斷了。

我們先定義一個註解。

@Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) public @interface PayCode { String value(); String name(); }在所有的支付類上都加上該註解

@PayCode(value = "alia", name = "支付寶支付") @Servicepublic class AliaPay implements IPay { @Override public void pay() { System.out.println("===發起支付寶支付==="); } } @PayCode(value = "weixin", name = "微信支付") @Servicepublic class WeixinPay implements IPay { @Override public void pay() { System.out.println("===發起微信支付==="); } } @PayCode(value = "jingdong", name = "京東支付") @Servicepublic class JingDongPay implements IPay { @Override public void pay() { System.out.println("===發起京東支付==="); } }然後增加最關鍵的類:

@Servicepublic class PayService2 implements ApplicationListener<ContextRefreshedEvent> { private static Map<String, IPay> payMap = null; @Override public void onApplicationEvent(ContextRefreshedEvent contextRefreshedEvent) { ApplicationContext applicationContext = contextRefreshedEvent.getApplicationContext(); Map<String, Object> beansWithAnnotation = applicationContext.getBeansWithAnnotation(PayCode.class); if (beansWithAnnotation != null) { payMap = new HashMap<>(); beansWithAnnotation.forEach((key, value) ->{ String bizType = value.getClass().getAnnotation(PayCode.class).value(); payMap.put(bizType, (IPay) value); }); } } public void pay(String code) { payMap.get(code).pay(); } }PayService2類實現了ApplicationListener接口,這樣在onApplicationEvent方法中,就可以拿到ApplicationContext的實例。我們再獲取打了PayCode註解的類,放到一個map中,map中的key就是PayCode註解中定義的value,跟code參數一致,value是支付類的實例。

這樣,每次就可以每次直接通過code獲取支付類實例,而不用if...else判斷了。如果要加新的支付方法,只需在支付類上面打上PayCode註解定義一個新的code即可。

注意:這種方式的code可以沒有業務含義,可以是純數字,只有不重複就行。

2、動態拼接名稱

該方法主要針對code是有業務含義的場景。

@Servicepublic class PayService3 implements ApplicationContextAware { private ApplicationContext applicationContext; private static final String SUFFIX = "Pay"; @Override public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { this.applicationContext = applicationContext; } public void toPay(String payCode) { ((IPay) applicationContext.getBean(getBeanName(payCode))).pay(); } public String getBeanName(String payCode) { return payCode + SUFFIX; } }我們可以看到,支付類bean的名稱是由code和後綴拼接而成,比如:aliaPay、weixinPay和jingDongPay。這就要求支付類取名的時候要特別注意,前面的一段要和code保持一致。調用的支付類的實例是直接從ApplicationContext實例中獲取的,默認情況下bean是單例的,放在內存的一個map中,所以不會有性能問題。

特別說明一下,這種方法實現了ApplicationContextAware接口跟上面的ApplicationListener接口不一樣,是想告訴大家獲取ApplicationContext實例的方法不只一種。

3、模板方法判斷

當然除了上面介紹的兩種方法之外,spring的源碼實現中也告訴我們另外一種思路,解決if...else問題。

我們先一起看看spring AOP的部分源碼,看一下DefaultAdvisorAdapterRegistry的wrap方法

public Advisor wrap(Object adviceObject) throws UnknownAdviceTypeException { if (adviceObject instanceof Advisor) { return (Advisor) adviceObject; } if (!(adviceObject instanceof Advice)) { thrownew UnknownAdviceTypeException(adviceObject); } Advice advice = (Advice) adviceObject; if (advice instanceof MethodInterceptor) { returnnew DefaultPointcutAdvisor(advice); } for (AdvisorAdapter adapter : this.adapters) { if (adapter.supportsAdvice(advice)) { returnnew DefaultPointcutAdvisor(advice); } } thrownew UnknownAdviceTypeException(advice); }重點看看supportAdvice方法,有三個類實現了這個方法。我們隨便抽一個類看看

class AfterReturningAdviceAdapter implements AdvisorAdapter, Serializable { @Override public boolean supportsAdvice(Advice advice) { return (advice instanceof AfterReturningAdvice); } @Override public MethodInterceptor getInterceptor(Advisor advisor) { AfterReturningAdvice advice = (AfterReturningAdvice) advisor.getAdvice(); returnnew AfterReturningAdviceInterceptor(advice); } }該類的supportsAdvice方法非常簡單,只是判斷了一下advice的類型是不是AfterReturningAdvice。

我們看到這裡應該有所啟發。

其實,我們可以這樣做,定義一個接口或者抽象類,裡面有個support方法判斷參數傳的code是否自己可以處理,如果可以處理則走支付邏輯。

public interface IPay { boolean support(String code); void pay(); } @Servicepublic class AliaPay implements IPay { @Override public boolean support(String code) { return"alia".equals(code); } @Override public void pay() { System.out.println("===發起支付寶支付==="); } } @Servicepublic class WeixinPay implements IPay { @Override public boolean support(String code) { return"weixin".equals(code); } @Override public void pay() { System.out.println("===發起微信支付==="); } } @Servicepublic class JingDongPay implements IPay { @Override public boolean support(String code) { return"jingdong".equals(code); } @Override public void pay() { System.out.println("===發起京東支付==="); } }每個支付類都有一個support方法,判斷傳過來的code是否和自己定義的相等。

@Servicepublic class PayService4 implements ApplicationContextAware, InitializingBean { private ApplicationContext applicationContext; private List<IPay> payList = null; @Override public void afterPropertiesSet() throws Exception { if (payList == null) { payList = new ArrayList<>(); Map<String, IPay> beansOfType = applicationContext.getBeansOfType(IPay.class); beansOfType.forEach((key, value) -> payList.add(value)); } } @Override public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { this.applicationContext = applicationContext; } public void toPay(String code) { for (IPay iPay : payList) { if (iPay.support(code)) { iPay.pay(); } } } }這段代碼中先把實現了IPay接口的支付類實例初始化到一個list集合中,返回在調用支付接口時循環遍歷這個list集合,如果code跟自己定義的一樣,則調用當前的支付類實例的pay方法。

4.策略+工廠模式

這種方式也是用於code是有業務含義的場景。

策略模式定義了一組算法,把它們一個個封裝起來, 並且使它們可相互替換。 工廠模式用於封裝和管理對象的創建,是一種創建型模式。

public interface IPay { void pay();}@Servicepublic class AliaPay implements IPay { @PostConstruct public void init() { PayStrategyFactory.register("aliaPay", this); } @Override public void pay() { System.out.println("===發起支付寶支付==="); }}@Servicepublic class WeixinPay implements IPay { @PostConstruct public void init() { PayStrategyFactory.register("weixinPay", this); } @Override public void pay() { System.out.println("===發起微信支付==="); }}@Servicepublic class JingDongPay implements IPay { @PostConstruct public void init() { PayStrategyFactory.register("jingDongPay", this); } @Override public void pay() { System.out.println("===發起京東支付==="); }}public class PayStrategyFactory { private static Map<String, IPay> PAY_REGISTERS = new HashMap<>(); public static void register(String code, IPay iPay) { if (null != code && !"".equals(code)) { PAY_REGISTERS.put(code, iPay); } } public static IPay get(String code) { return PAY_REGISTERS.get(code); }}@Servicepublic class PayService3 { public void toPay(String code) { PayStrategyFactory.get(code).pay(); }}這段代碼的關鍵是PayStrategyFactory類,它是一個策略工廠,裡面定義了一個全局的map,在所有IPay的實現類中註冊當前實例到map中,然後在調用的地方通過PayStrategyFactory類根據code從map獲取支付類實例即可。

5.責任鏈模式

這種方式在代碼重構時用來消除if...else非常有效。

責任鏈模式:將請求的處理對象像一條長鏈一般組合起來,形成一條對象鏈。請求並不知道具體執行請求的對象是哪一個,這樣就實現了請求與處理對象之間的解耦。 常用的filter、spring aop就是使用了責任鏈模式,這裡我稍微改良了一下,具體代碼如下:

public abstract class PayHandler { @Getter @Setter protected PayHandler next; public abstract void pay(String pay);}@Servicepublic class AliaPayHandler extends PayHandler { @Override public void pay(String code) { if ("alia".equals(code)) { System.out.println("===發起支付寶支付==="); } else { getNext().pay(code); } }}@Servicepublic class WeixinPayHandler extends PayHandler { @Override public void pay(String code) { if ("weixin".equals(code)) { System.out.println("===發起微信支付==="); } else { getNext().pay(code); } }}@Servicepublic class JingDongPayHandler extends PayHandler { @Override public void pay(String code) { if ("jingdong".equals(code)) { System.out.println("===發起京東支付==="); } else { getNext().pay(code); } }}@Servicepublic class PayHandlerChain implements ApplicationContextAware, InitializingBean { private ApplicationContext applicationContext; private PayHandler header; public void handlePay(String code) { header.pay(code); } @Override public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { this.applicationContext = applicationContext; } @Override public void afterPropertiesSet() throws Exception { Map<String, PayHandler> beansOfTypeMap = applicationContext.getBeansOfType(PayHandler.class); if (beansOfTypeMap == null || beansOfTypeMap.size() == 0) { return; } List<PayHandler> handlers = beansOfTypeMap.values().stream().collect(Collectors.toList()); for (int i = 0; i < handlers.size(); i++) { PayHandler payHandler = handlers.get(i); if (i != handlers.size() - 1) { payHandler.setNext(handlers.get(i + 1)); } } header = handlers.get(0); }}這段代碼的關鍵是每個PayHandler的子類,都定義了下一個需要執行的PayHandler子類,構成一個鏈式調用,通過PayHandlerChain把這種鏈式結構組裝起來。

6、其他的消除if...else的方法

當然實際項目開發中使用if...else判斷的場景非常多,上面只是其中幾種場景。下面再列舉一下,其他常見的場景。

1.根據不同的數字返回不同的字符串

public String getMessage(int code) { if (code == 1) { return "成功"; } else if (code == -1) { return "失敗"; } else if (code == -2) { return "網絡超時"; } else if (code == -3) { return "參數錯誤"; } throw new RuntimeException("code錯誤"); }其實,這種判斷沒有必要,用一個枚舉就可以搞定。

public enum MessageEnum { SUCCESS(1, "成功"), FAIL(-1, "失敗"), TIME_OUT(-2, "網絡超時"), PARAM_ERROR(-3, "參數錯誤"); private int code; private String message; MessageEnum(int code, String message) { this.code = code; this.message = message; } public int getCode() { return this.code; } public String getMessage() { return this.message; } public static MessageEnum getMessageEnum(int code) { return Arrays.stream(MessageEnum.values()).filter(x -> x.code == code).findFirst().orElse(null); } }再把調用方法稍微調整一下

public String getMessage(int code) { MessageEnum messageEnum = MessageEnum.getMessageEnum(code); return messageEnum.getMessage(); }完美。

2.集合中的判斷

上面的枚舉MessageEnum中的getMessageEnum方法,如果不用java8的語法的話,可能要這樣寫

public static MessageEnum getMessageEnum(int code) { for (MessageEnum messageEnum : MessageEnum.values()) { if (code == messageEnum.code) { return messageEnum; } } return null; }對於集合中過濾數據,或者查找方法,java8有更簡單的方法消除if...else判斷。

public static MessageEnum getMessageEnum(int code) { return Arrays.stream(MessageEnum.values()).filter(x -> x.code == code).findFirst().orElse(null); }3.簡單的判斷

其實有些簡單的if...else完全沒有必要寫,可以用三目運算符代替,比如這種情況:

public String getMessage2(int code) { if(code == 1) { return "成功"; } return "失敗"; }改成三目運算符:

public String getMessage2(int code) { return code == 1 ? "成功" : "失敗"; }修改之後代碼更簡潔一些。

4.spring中的判斷

對於參數的異常,越早被發現越好,在spring中提供了Assert用來幫助我們檢測參數是否有效。

public void save(Integer code,String name) { if(code == null) { throw new Exception("code不能為空"); } else { if(name == null) { throw new Exception("name不能為空"); } else { System.out.println("doSave"); } } }如果參數非常多的話,if...else語句會很長,這時如果改成使用Assert類判斷,代碼會簡化很多:

public String save2(Integer code,String name) { Assert.notNull(code,"code不能為空"); Assert.notNull(name,"name不能為空"); System.out.println("doSave"); }當然,還有很多其他的場景可以優化if...else,我再這裡就不一一介紹了,感興趣的朋友可以給我留言,一起探討和研究一下。

相關焦點

  • 程式設計師如何寫出高質量的代碼程序
    編碼是程式設計師最重要的工作,每個程式設計師都希望自己可以寫出優雅,高性能,高質量的代碼,對於大師級別的程式設計師,他們的寫的代碼就和藝術品一樣,你會忍不住發出驚嘆,他們怎麼可以創造出如此驚豔的作品出來。下面筆者就以自己的淺薄學識和一些經驗來總結下優秀的程序應該具有的特點。
  • 使用if-else進行分支的方法已過時,分析多態性和現代方法更合適
    if-else和switch當然可以生成簡潔的代碼,你的軟體不應該由最少的行組成,也不必犧牲可讀性、可維護性或靈活性。在if-then-else語句中使用枚舉的後果是什麼呢?基於離散值的分支會使軟體難以更改。每個新功能都要求跟蹤分支發生的位置,並相應地修改現有代碼。這絕對不是我們想要的方式。
  • 你需要立刻學會的20個Python代碼段
    在必要時刻,這些小訣竅能夠減少你上網查Stack Overflow的麻煩。而且它們會在每日編程練習中助你一臂之力。1. 反轉字符串以下代碼使用Python切片操作來反轉字符串。列表解析在其他列表的基礎上,列表解析為創建列表提供一種優雅的方式。以下代碼通過將舊列表的每個對象乘兩次,創建一個新的列表。
  • PyTorch最佳實踐,教你寫出一手風格優美的代碼
    選自github 本文轉自機器之心(nearhuman2014) PyTorch是最優秀的深度學習框架之一,它簡單優雅,非常適合入門。本文將介紹PyTorch的最佳實踐和代碼風格都是怎樣的。
  • 經驗之談:代碼該怎樣寫才能幹淨整潔
    能把代碼寫出來是一回事,但是寫出整潔、可讀的代碼又是另一回事。然而,什麼是「乾淨的代碼」呢?怎麼才能寫出「乾淨的代碼」?為了解答這些問題,本文作者寫了一份針對初級開發者的乾淨代碼指南。不妨想像一下,你正在閱讀一篇文章。文章開頭有一個段落簡要概述了文章的內容。文中還有一些標題,每個小標題會引出幾個段落。
  • VBA中的If-Then-Else語句
    第一節 If...Then...Else語句大家好,我們再次理解If...Then...Else語句在代碼中的作用,這個語句在VBA代碼中隨處可見,對於VBA而言,條件判斷應用的非常靈活,或者可以說是EXCEL函數的終結者,當你利用VBA上手後,不用再去應用EXCEL函數去解決問題了。
  • 《代碼整潔之道》精讀與演繹】之四 優秀代碼的格式準則
    因為項目的緊迫性,需求的多樣性,我們無法時時刻刻都寫出整潔的代碼,保持自己輸出的都是高質量、優雅的代碼。  但若我們理解了代碼整潔之道的精髓,我們會知道怎樣讓自己的代碼更加優雅、整潔、易讀、易擴展,知道真正整潔的代碼應該是怎麼樣的,也許就會漸漸養成持續輸出整潔代碼的習慣。  而且或許你會發現,若你一直保持輸出整潔代碼的習慣,長期來看,會讓你的整體效率和代碼質量大大提升。
  • 能寫出這種代碼的程式設計師都是神仙吧!
    只要你腦洞夠大,你便能用代碼做到很多讓人驚訝的事!而且,並不需要你具備特別高深的敲代碼功底,沉下心來研究一下,你也可以做到。下面分享幾個讓人印象最深刻的案例,附部分代碼研讀,完整代碼文末Github見。
  • 10個 Javascript 小技巧幫你提升代碼質量
    獨立出來的函數有助於代碼復用。獨立出來的函數更容易被覆寫。獨立出來的函數如果擁有一個良好的命名,它本身就起到了注釋的作用。語義化將多段分離的邏輯放在不同的函數中實現,可以使代碼邏輯清晰,清楚的看到每一步在做什麼。
  • 「錦囊妙計」用英語怎麼說?
    大家好,今天我們分享一個非常有用且地道的表達——錦囊妙計, 這個短語的英文表達是:an ace up your sleeve 秘密王牌;錦囊妙計Never fear!我有錦囊妙計。My stamina is the ace up my sleeve for this race—the other runners don't stand a chance! 在這個賽跑中,我的毅力是我的秘密王牌,其他選手沒有機會。
  • 「EMNLP2018乾貨」為NLP研究寫出好代碼(254頁教程)
    新智元報導 來源:專知(Quan_Zhuanzhi)作者:{joelg,mattg,markn}@allenai.org【新智元導讀】艾倫AI研究所在EMNLP2018發布教程《為NLP研究寫出好代碼
  • 代碼詳解:使用NumPy,教你9步從頭搭建神經網絡
    Photo by Alina Grubnyak on Unsplash如果你是個對神經網絡有所了解的初級數據科學家,或是個對深度學習略有耳聞的機器學習愛好者,一定要讀一讀這篇文章。本文介紹了使用NumPy從頭搭建神經網絡的9個步驟,即從數據預處理到反向傳播這一「必經之路」。對機器學習、人工神經網絡、Python語法和編程邏輯有些基本理解最好,(但這也不是必需條件,你可以邊讀邊學)。1. 初始化導入NumPy。
  • 30段極簡Python代碼:這些小技巧你都Get了麼
    本文是 30 個極簡任務,初學者可以嘗試著自己實現;本文同樣也是 30 段代碼,Python 開發者也可以看看是不是有沒想到的用法。Python 是機器學習最廣泛採用的程式語言,它最重要的優勢在於編程的易用性。如果讀者對基本的 Python 語法已經有一些了解,那麼這篇文章可能會給你一些啟發。
  • 數據處理遇到麻煩不要慌,5個優雅的Numpy函數助你走出困境
    選自TowardsDataScience作者:Baijayanta Roy機器之心編譯參與:Luo Sainan、杜偉在機器學習和數據科學工程的日常數據處理中,我們會遇到一些特殊的情況,需要用樣板代碼來解決這些問題。在此期間,根據社區的需求和使用,一些樣板代碼已經被轉換成核心語言或包本身提供的基本功能。
  • 給你代碼:leetcode隨筆
    整數的各位積和之差給你一個整數 n,請你幫忙計算並返回該整數「各位數字之積」與「各位數字之和」的差。example 1:輸入:n = 234輸出:15 解釋:各位數之積 = 2 * 3 * 4 = 24 各位數之和 = 2 + 3 + 4 = 9 結果 = 24 - 9 = 15來源:力扣(LeetCode)這題非常簡單。只要轉換一下字符串就可以做。
  • 懶人秘籍:教你如何避免編寫pandas代碼
    而大家都在儘可能地避免這種懸崖峭壁,結果可想而知,都轉向了如何避免編寫pandas代碼。在過去4年裡,筆者一直使用pandas作為數據分析的主要工具。必須承認,「如何避免編寫pandas代碼」的大部分內容來自於使用pandas編程的起步階段。在進行代碼審閱時,筆者仍然看到許多經驗豐富的程式設計師在看一些熱門「如何避免使用」的帖子。
  • 代碼你打算寫到幾歲?雷軍、張一鳴都曾寫過...
    碩士畢業的第三年,張小龍就寫出一款非常成功的產品——FoxMail,並且一個人完成了前三個版本的迭代。1997年,FoxMail 在 Winsite 上線。同年,一位《電腦報》記者說,"只要你站在黃莊路口,大喊一聲,我是 Foxmail 張小龍,一定會有一大群人圍上來,讓你籤名。"此話也印證了 Foxmail 的成功。
  • 你會寫嗎?
    而騰訊公司是在1998年成立,也就是說這條代碼還是在騰訊成立不久,馬化騰寫下的。 聽騰訊的大師兄Tony(張志東)說,騰訊最早的辦公室,是一間舞蹈室,還掛著80年代「迪斯科」風格的大燈球,後來才搬去賽格。
  • 多個細節幫助你更優雅地書寫頁面
    現在,對代碼的好評還有一個更為時尚的詞「優雅」,是不是聽起來覺得很親切呢?頁面是網際網路產品的表現層面,不僅講求外觀,而且會應對更新迅速的網際網路產品需求。要成為一名優秀的開發者,經驗積累是必不可少的,而一部分經驗歸納起來正是在工作過程中的細節。下文介紹的即是在頁面開發流程中的多方面的細節內容,希望對這些細節內容的探討,可以幫助各位頁面開發者做得更出色,以更優雅的姿態來書寫頁面。
  • 數學公式太晦澀,不如用代碼寫出來:這是程式設計師學數學的獨特方式
    ∑、∏、∈……如果你學習過數學,你一定知道這些符號的含義,而如果我們能用最喜歡的程式語言來理解它們,也許還能帶來更加透徹的領悟。近日,MindbuilderAI & nurio 創始人、機器學習專家 Ian Rowan 介紹了自己藉助代碼來理解數學計算過程的經驗。