最近在做代碼重構,發現了很多代碼的爛味道。其他的不多說,今天主要說說那些又臭又長的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,我再這裡就不一一介紹了,感興趣的朋友可以給我留言,一起探讨和研究一下。
如果這篇文章對您有幫助或者有所啟發的話,請幫忙掃碼關注下面的公衆賬号。原創不易,謝謝您的支援。