实战|如何消除又臭又长的if...else判断更优雅的编程？

头像
苏三说技术
    阅读 10 分钟
    2

    最近在做代码重构，发现了很多代码的烂味道。其他的不多说，今天主要说说那些又臭又长的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判断，判断多了就会导致逻辑越来越多？

    很明显，这里违法了设计模式六大原则的：开闭原则 和 单一职责原则。

    ❝

    开闭原则：对扩展开放，对修改关闭。就是说增加新功能要尽量少改动已有代码。

    单一职责原则：顾名思义，要求逻辑尽量单一，不要太复杂，便于复用。

    ❞

    那有什么办法可以解决这个问题呢？

    二、使用注解

    代码中之所以要用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可以没有业务含义，可以是纯数字，只有不重复就行。

    三、动态拼接名称

    再看看这种方法，主要针对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实例的方法不只一种。

    四、模板方法判断

    当然除了上面介绍的两种方法之外，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) {  
        // So well-known it doesn't even need an adapter.  
        return new DefaultPointcutAdvisor(advice);  
     }  
     for (AdvisorAdapter adapter : this.adapters) {  
         // Check that it is supported.  
         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方法。

    五、其他的消除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.判断是否为null

    java中自从有了null之后，很多地方都要判断实例是否为null，不然可能会出现NPE的异常。

     public String getMessage2(int code) {  
     return code == 1 ? "成功" : "失败";  
 }  
​  
 public String getMessage3(int code) {  
     Test test = null;  
     return test.getMessage2(1);  
 }

    这里如果不判断异常的话，就会出现NPE异常。我们只能老老实实加上判断。

    public String getMessage3(int code) {  
     Test test = null;  
     if (test != null) {  
     return test.getMessage2(1);  
     }  
     return null;  
}

    有没有其他更优雅的处理方式呢？

    public String getMessage3(int code) {  
     Test test = null;  
     Optional<Test> testOptional = Optional.of(test);  
     return testOptional.isPresent() ? testOptional.get().getMessage2(1) : null;  
}

    答案是使用Optional

    当然，还有很多其他的场景可以优化if...else，我再这里就不一一介绍了，感兴趣的朋友可以给我留言，一起探讨和研究一下。

    如果这篇文章对您有帮助或者有所启发的话，请帮忙扫码关注下面的公众账号。原创不易，谢谢您的支持。

    推荐阅读

    java后端springspringboot
    本文系转载，阅读原文
    https://mp.weixin.qq.com/s/dCo499IH3aabKiKT8FPtdg
    苏三说技术
    211 声望33 粉丝
    « 上一篇
    实战|从0到1一步步搭建自己的springboot starter
    下一篇 »
    面试前看了这篇spring事务的文章，让我多要了2k的工资

    引用和评论

    推荐阅读
    头像
    表设计的18个军规

    苏三说技术赞 2阅读 488

    头像
    Bitmap 和 布隆过滤器傻傻分不清？你这不应该啊

    程序员小富赞 10阅读 4.5k评论 1

    头像
    Jerry和您聊聊Chrome开发者工具

    注销赞 9阅读 4.8k评论 3

    头像
    Spring 实现 3 种异步流式接口，干掉接口超时烦恼

    程序员小富赞 6阅读 2.3k

    头像
    💢线上高延迟请求排查

    crossoverJie赞 6阅读 3.8k评论 5

    头像
    每一个前端，都要拥有属于自己的埋点库~

    幸福的闹钟赞 3阅读 854

    头像
    Spring Boot起步，CRUD、错误处理与宝塔部署

    微芒不朽赞 3阅读 3.5k

    0 条评论
    得票最新