重構if-else方法

源文章鏈接： https://mp.weixin.qq.com/s/Y6mOGs8_rVNxcnqVzCXdXA

前言

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

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

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

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

public interface IPay {  
    void pay();  
}  

@Service  
public class AliaPay implements IPay {  
     @Override  
     public void pay() {  
        System.out.println("===發起支付寶支付===");  
     }  
}  

@Service  
public class WeixinPay implements IPay {  
     @Override  
     public void pay() {  
         System.out.println("===發起微信支付===");  
     }  
}  
  
@Service  
public class JingDongPay implements IPay {  
     @Override  
     public void pay() {  
        System.out.println("===發起京東支付===");  
     }  
}  

@Service  
public 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();  
         } else if ("weixin".equals(code)) {  
              weixinPay.pay();  
         } else if ("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 = "支付寶支付")  
@Service  
public class AliaPay implements IPay {  

     @Override  
     public void pay() {  
         System.out.println("===發起支付寶支付===");  
     }  
}  

 
@PayCode(value = "weixin", name = "微信支付")  
@Service  
public class WeixinPay implements IPay {  
 
     @Override  
     public void pay() {  
         System.out.println("===發起微信支付===");  
     }  
} 

 
@PayCode(value = "jingdong", name = "京東支付")  
@Service  
public class JingDongPay implements IPay {  
 
     @Override  
     public void pay() {  
        System.out.println("===發起京東支付===");  
     }  
}

然後增加最關鍵的類。

@Service  
public 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是有業務含義的場景。

@Service  
public 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)) {  
        throw new UnknownAdviceTypeException(adviceObject);  
     }  
     Advice advice = (Advice) adviceObject;  
     if (advice instanceof MethodInterceptor) {    
        return new DefaultPointcutAdvisor(advice);  
     }  
     for (AdvisorAdapter adapter : this.adapters) {  
         if (adapter.supportsAdvice(advice)) {  
             return new DefaultPointcutAdvisor(advice);  
         }  
     }  
     throw new 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();  
        return new AfterReturningAdviceInterceptor(advice);  
     }   
}

該類的supportsAdvice方法非常簡單，只是判斷了一下advice的類型是不是AfterReturningAdvice。

我們看到這裏應該有所啓發。

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

public interface IPay {  
     boolean support(String code);   
     void pay();  
}  

@Service  
public class AliaPay implements IPay {   
     @Override  
     public boolean support(String code) {  
        return "alia".equals(code);  
     }  
 
     @Override  
     public void pay() {  
        System.out.println("===發起支付寶支付===");  
     }  
}  
 
@Service  
public class WeixinPay implements IPay {  
 
     @Override  
     public boolean support(String code) {  
        return "weixin".equals(code);  
     }  
 
     @Override  
     public void pay() {  
        System.out.println("===發起微信支付===");  
     }  
}  

@Service  
public class JingDongPay implements IPay {  
     @Override  
     public boolean support(String code) {  
        return "jingdong".equals(code);  
     }  
 
     @Override  
     public void pay() {  
        System.out.println("===發起京東支付===");  
     }  
}

每個支付類都有一個support方法，判斷傳過來的code是否和自己定義的相等。

@Service  
public 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();
}

@Service
public class AliaPay implements IPay {

    @PostConstruct
    public void init() {
        PayStrategyFactory.register("aliaPay", this);
    }


    @Override
    public void pay() {
        System.out.println("===發起支付寶支付===");
    }

}

@Service
public class WeixinPay implements IPay {

    @PostConstruct
    public void init() {
        PayStrategyFactory.register("weixinPay", this);
    }

    @Override
    public void pay() {
        System.out.println("===發起微信支付===");
    }
}

@Service
public 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);
    }
}

@Service
public 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);

}

@Service
public class AliaPayHandler extends PayHandler {


    @Override
    public void pay(String code) {
        if ("alia".equals(code)) {
            System.out.println("===發起支付寶支付===");
        } else {
            getNext().pay(code);
        }
    }

}

@Service
public class WeixinPayHandler extends PayHandler {

    @Override
    public void pay(String code) {
        if ("weixin".equals(code)) {
            System.out.println("===發起微信支付===");
        } else {
            getNext().pay(code);
        }
    }
}

@Service
public class JingDongPayHandler extends PayHandler {


    @Override
    public void pay(String code) {
        if ("jingdong".equals(code)) {
            System.out.println("===發起京東支付===");
        } else {
            getNext().pay(code);
        }
    }
}

@Service
public 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 Exception("code不能爲空");     
     } else {
         if(name == null) {
             throw 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

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

1、使用註解

2、動態拼接名稱

3、模板方法判斷

4.策略+工廠模式

5.責任鏈模式

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

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

2.集合中的判斷

3.簡單的判斷

4.spring中的判斷

Spring事務嵌套引發的異常: Transaction rolled back because it has been marked as rollback-only

整合阿里rocketmq的jar包實現消費端代碼無法消費消息

重構if-else方法

上傳功能-彈窗實現-vue

Element UI組件說明

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結