干掉if...else，這幾種寫(xiě)法更優(yōu)雅！
前言
最近在做代碼重構(gòu)，發(fā)現(xiàn)了很多代碼的爛味道。其他的不多說(shuō)，今天主要說(shuō)說(shuō)那些又臭又長(zhǎng)的if...else要如何重構(gòu)。
在介紹更更優(yōu)雅的編程之前，讓我們一起回顧一下，不好的if...else代碼
一、又臭又長(zhǎng)的if...else
廢話不多說(shuō)，先看看下面的代碼。
public interface IPay {
void pay();
}
@Service
publicclass AliaPay implements IPay {
@Override
public void pay() {
System.out.println("===發(fā)起支付寶支付===");
}
}
@Service
publicclass WeixinPay implements IPay {
@Override
public void pay() {
System.out.println("===發(fā)起微信支付===");
}
}
@Service
publicclass JingDongPay implements IPay {
@Override
public void pay() {
System.out.println("===發(fā)起京東支付===");
}
}
@Service
publicclass 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類(lèi)的toPay方法主要是為了發(fā)起支付，根據(jù)不同的code，決定調(diào)用用不同的支付類(lèi)（比如：aliaPay）的pay方法進(jìn)行支付。
這段代碼有什么問(wèn)題呢？也許有些人就是這么干的。
試想一下，如果支付方式越來(lái)越多，比如：又加了百度支付、美團(tuán)支付、銀聯(lián)支付等等，就需要改toPay方法的代碼，增加新的else...if判斷，判斷多了就會(huì)導(dǎo)致邏輯越來(lái)越多？
很明顯，這里違法了設(shè)計(jì)模式六大原則的：開(kāi)閉原則 和 單一職責(zé)原則。
開(kāi)閉原則：對(duì)擴(kuò)展開(kāi)放，對(duì)修改關(guān)閉。就是說(shuō)增加新功能要盡量少改動(dòng)已有代碼。
單一職責(zé)原則：顧名思義，要求邏輯盡量單一，不要太復(fù)雜，便于復(fù)用。
那有什么辦法可以解決這個(gè)問(wèn)題呢？
二、消除if...else的錦囊妙計(jì)
1、使用注解
代碼中之所以要用code判斷使用哪個(gè)支付類(lèi)，是因?yàn)閏ode和支付類(lèi)沒(méi)有一個(gè)綁定關(guān)系，如果綁定關(guān)系存在了，就可以不用判斷了。
我們先定義一個(gè)注解。
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface PayCode {
String value();
String name();
}在所有的支付類(lèi)上都加上該注解：
@PayCode(value = "alia", name = "支付寶支付")
@Service
publicclass AliaPay implements IPay {
@Override
public void pay() {
System.out.println("===發(fā)起支付寶支付===");
}
}
@PayCode(value = "weixin", name = "微信支付")
@Service
publicclass WeixinPay implements IPay {
@Override
public void pay() {
System.out.println("===發(fā)起微信支付===");
}
}
@PayCode(value = "jingdong", name = "京東支付")
@Service
publicclass JingDongPay implements IPay {
@Override
public void pay() {
System.out.println("===發(fā)起京東支付===");
}
}然后增加最關(guān)鍵的類(lèi)：
@Service
publicclass PayService2 implements ApplicationListener<ContextRefreshedEvent> {
privatestatic 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類(lèi)實(shí)現(xiàn)了ApplicationListener接口，這樣在onApplicationEvent方法中，就可以拿到ApplicationContext的實(shí)例。
我們?cè)佾@取打了PayCode注解的類(lèi)，放到一個(gè)map中，map中的key就是PayCode注解中定義的value，跟code參數(shù)一致，value是支付類(lèi)的實(shí)例。
這樣，每次就可以每次直接通過(guò)code獲取支付類(lèi)實(shí)例，而不用if...else判斷了。
如果要加新的支付方法，只需在支付類(lèi)上面打上PayCode注解定義一個(gè)新的code即可。
注意：這種方式的code可以沒(méi)有業(yè)務(wù)含義，可以是純數(shù)字，只有不重復(fù)就行。
2、動(dòng)態(tài)拼接名稱(chēng)
該方法主要針對(duì)code是有業(yè)務(wù)含義的場(chǎng)景。
@Service
publicclass PayService3 implements ApplicationContextAware {
private ApplicationContext applicationContext;
privatestaticfinal 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;
}
}我們可以看到，支付類(lèi)bean的名稱(chēng)是由code和后綴拼接而成，比如：aliaPay、weixinPay和jingDongPay。
這就要求支付類(lèi)取名的時(shí)候要特別注意，前面的一段要和code保持一致。
調(diào)用的支付類(lèi)的實(shí)例是直接從ApplicationContext實(shí)例中獲取的，默認(rèn)情況下bean是單例的，放在內(nèi)存的一個(gè)map中，所以不會(huì)有性能問(wèn)題。
特別說(shuō)明一下，這種方法實(shí)現(xiàn)了ApplicationContextAware接口跟上面的ApplicationListener接口不一樣，是想告訴大家獲取ApplicationContext實(shí)例的方法不只一種。
3、模板方法判斷
當(dāng)然除了上面介紹的兩種方法之外，spring的源碼實(shí)現(xiàn)中也告訴我們另外一種思路，解決if...else問(wèn)題。
我們先一起看看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);
}重點(diǎn)看看supportAdvice方法，有三個(gè)類(lèi)實(shí)現(xiàn)了這個(gè)方法。我們隨便抽一個(gè)類(lèi)看看
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);
}
}該類(lèi)的supportsAdvice方法非常簡(jiǎn)單，只是判斷了一下advice的類(lèi)型是不是AfterReturningAdvice。
我們看到這里應(yīng)該有所啟發(fā)。
其實(shí)，我們可以這樣做，定義一個(gè)接口或者抽象類(lèi)，里面有個(gè)support方法判斷參數(shù)傳的code是否自己可以處理，如果可以處理則走支付邏輯。
public interface IPay {
boolean support(String code);
void pay();
}
@Service
publicclass AliaPay implements IPay {
@Override
public boolean support(String code) {
return"alia".equals(code);
}
@Override
public void pay() {
System.out.println("===發(fā)起支付寶支付===");
}
}
@Service
publicclass WeixinPay implements IPay {
@Override
public boolean support(String code) {
return"weixin".equals(code);
}
@Override
public void pay() {
System.out.println("===發(fā)起微信支付===");
}
}
@Service
publicclass JingDongPay implements IPay {
@Override
public boolean support(String code) {
return"jingdong".equals(code);
}
@Override
public void pay() {
System.out.println("===發(fā)起京東支付===");
}
}每個(gè)支付類(lèi)都有一個(gè)support方法，判斷傳過(guò)來(lái)的code是否和自己定義的相等。
@Service
publicclass 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();
}
}
}
}這段代碼中先把實(shí)現(xiàn)了IPay接口的支付類(lèi)實(shí)例初始化到一個(gè)list集合中，返回在調(diào)用支付接口時(shí)循環(huán)遍歷這個(gè)list集合，如果code跟自己定義的一樣，則調(diào)用當(dāng)前的支付類(lèi)實(shí)例的pay方法。
4.策略+工廠模式
這種方式也是用于code是有業(yè)務(wù)含義的場(chǎng)景。
策略模式定義了一組算法，把它們一個(gè)個(gè)封裝起來(lái), 并且使它們可相互替換。
工廠模式用于封裝和管理對(duì)象的創(chuàng)建，是一種創(chuàng)建型模式。
public interface IPay {
void pay();
}
@Service
publicclass AliaPay implements IPay {
@PostConstruct
public void init() {
PayStrategyFactory.register("aliaPay", this);
}
@Override
public void pay() {
System.out.println("===發(fā)起支付寶支付===");
}
}
@Service
publicclass WeixinPay implements IPay {
@PostConstruct
public void init() {
PayStrategyFactory.register("weixinPay", this);
}
@Override
public void pay() {
System.out.println("===發(fā)起微信支付===");
}
}
@Service
publicclass JingDongPay implements IPay {
@PostConstruct
public void init() {
PayStrategyFactory.register("jingDongPay", this);
}
@Override
public void pay() {
System.out.println("===發(fā)起京東支付===");
}
}
publicclass PayStrategyFactory {
privatestatic 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
publicclass PayService3 {
public void toPay(String code) {
PayStrategyFactory.get(code).pay();
}
}這段代碼的關(guān)鍵是PayStrategyFactory類(lèi)，它是一個(gè)策略工廠，里面定義了一個(gè)全局的map，在所有IPay的實(shí)現(xiàn)類(lèi)中注冊(cè)當(dāng)前實(shí)例到map中，然后在調(diào)用的地方通過(guò)PayStrategyFactory類(lèi)根據(jù)code從map獲取支付類(lèi)實(shí)例即可。
5.責(zé)任鏈模式
這種方式在代碼重構(gòu)時(shí)用來(lái)消除if...else非常有效。
責(zé)任鏈模式：將請(qǐng)求的處理對(duì)象像一條長(zhǎng)鏈一般組合起來(lái)，形成一條對(duì)象鏈。請(qǐng)求并不知道具體執(zhí)行請(qǐng)求的對(duì)象是哪一個(gè)，這樣就實(shí)現(xiàn)了請(qǐng)求與處理對(duì)象之間的解耦。
常用的filter、spring aop就是使用了責(zé)任鏈模式，這里我稍微改良了一下，具體代碼如下：
public abstractclass PayHandler {
@Getter
@Setter
protected PayHandler next;
public abstract void pay(String pay);
}
@Service
publicclass AliaPayHandler extends PayHandler {
@Override
public void pay(String code) {
if ("alia".equals(code)) {
System.out.println("===發(fā)起支付寶支付===");
} else {
getNext().pay(code);
}
}
}
@Service
publicclass WeixinPayHandler extends PayHandler {
@Override
public void pay(String code) {
if ("weixin".equals(code)) {
System.out.println("===發(fā)起微信支付===");
} else {
getNext().pay(code);
}
}
}
@Service
publicclass JingDongPayHandler extends PayHandler {
@Override
public void pay(String code) {
if ("jingdong".equals(code)) {
System.out.println("===發(fā)起京東支付===");
} else {
getNext().pay(code);
}
}
}
@Service
publicclass 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);
}
}這段代碼的關(guān)鍵是每個(gè)PayHandler的子類(lèi)，都定義了下一個(gè)需要執(zhí)行的PayHandler子類(lèi)，構(gòu)成一個(gè)鏈?zhǔn)秸{(diào)用，通過(guò)PayHandlerChain把這種鏈?zhǔn)浇Y(jié)構(gòu)組裝起來(lái)。
三. 其他的消除if...else的方法
當(dāng)然實(shí)際項(xiàng)目開(kāi)發(fā)中使用if...else判斷的場(chǎng)景非常多，上面只是其中幾種場(chǎng)景。
下面再列舉一下，其他常見(jiàn)的場(chǎng)景。
1.根據(jù)不同的數(shù)字返回不同的字符串
public String getMessage(int code) {
if (code == 1) {
return"成功";
} elseif (code == -1) {
return"失敗";
} elseif (code == -2) {
return"網(wǎng)絡(luò)超時(shí)";
} elseif (code == -3) {
return"參數(shù)錯(cuò)誤";
}
thrownew RuntimeException("code錯(cuò)誤");
}其實(shí)，這種判斷沒(méi)有必要，用一個(gè)枚舉就可以搞定。
public enum MessageEnum {
SUCCESS(1, "成功"),
FAIL(-1, "失敗"),
TIME_OUT(-2, "網(wǎng)絡(luò)超時(shí)"),
PARAM_ERROR(-3, "參數(shù)錯(cuò)誤");
privateint code;
private String message;
MessageEnum(int code, String message) {
this.code = code;
this.message = message;
}
public int getCode() {
returnthis.code;
}
public String getMessage() {
returnthis.message;
}
public static MessageEnum getMessageEnum(int code) {
return Arrays.stream(MessageEnum.values()).filter(x -> x.code == code).findFirst().orElse(null);
}
}再把調(diào)用方法稍微調(diào)整一下
public String getMessage(int code) {
MessageEnum messageEnum = MessageEnum.getMessageEnum(code);
return messageEnum.getMessage();
}完美。
2.集合中的判斷
上面的枚舉MessageEnum中的getMessageEnum方法，如果不用java8的語(yǔ)法的話，可能要這樣寫(xiě)
public static MessageEnum getMessageEnum(int code) {
for (MessageEnum messageEnum : MessageEnum.values()) {
if (code == messageEnum.code) {
return messageEnum;
}
}
return null;
}對(duì)于集合中過(guò)濾數(shù)據(jù)，或者查找方法，java8有更簡(jiǎn)單的方法消除if...else判斷。
public static MessageEnum getMessageEnum(int code) {
return Arrays.stream(MessageEnum.values()).filter(x -> x.code == code).findFirst().orElse(null);
}3.簡(jiǎn)單的判斷
其實(shí)有些簡(jiǎn)單的if...else完全沒(méi)有必要寫(xiě)，可以用三目運(yùn)算符代替，比如這種情況：
public String getMessage2(int code) {
if(code == 1) {
return "成功";
}
return "失敗";
}改成三目運(yùn)算符：
public String getMessage2(int code) {
return code == 1 ? "成功" : "失敗";
}修改之后代碼更簡(jiǎn)潔一些。
4.Spring中的判斷
對(duì)于參數(shù)的異常，越早被發(fā)現(xiàn)越好，在Spring中提供了Assert類(lèi)，用來(lái)幫助我們檢測(cè)參數(shù)是否有效。
以前我們的參數(shù)判斷一般是下面這樣的：
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");
}
}
}如果參數(shù)非常多的話，if...else語(yǔ)句會(huì)很長(zhǎng)。
這時(shí)如果改成使用Assert類(lèi)判斷，代碼會(huì)簡(jiǎn)化很多：
public String save2(Integer code，String name) {
Assert.notNull(code,"code不能為空");
Assert.notNull(name,"name不能為空");
System.out.println("doSave");
}當(dāng)然，還有很多其他的場(chǎng)景可以優(yōu)化if...else，我再這里就不一一介紹了。
