前言
最近在做代碼重構妓蛮,發(fā)現(xiàn)了很多代碼的爛味道。其他的不多說圾叼,今天主要說說那些又臭又長的if...else要如何重構蛤克。
在介紹更更優(yōu)雅的編程之前,讓我們一起回顧一下夷蚊,不好的if...else代碼
一构挤、又臭又長的if...else
廢話不多說,先看看下面的代碼惕鼓。
public interface IPay {
void pay();
}
@Service
public class AliaPay implements IPay {
@Override
public void pay() {
System.out.println("===發(fā)起支付寶支付===");
}
}
@Service
public class WeixinPay implements IPay {
@Override
public void pay() {
System.out.println("===發(fā)起微信支付===");
}
}
@Service
public class JingDongPay implements IPay {
@Override
public void pay() {
System.out.println("===發(fā)起京東支付===");
}
}
@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方法主要是為了發(fā)起支付筋现,根據(jù)不同的code,決定調(diào)用用不同的支付類(比如:aliaPay)的pay方法進行支付箱歧。
這段代碼有什么問題呢矾飞?也許有些人就是這么干的。
試想一下叫胁,如果支付方式越來越多凰慈,比如:又加了百度支付、美團支付驼鹅、銀聯(lián)支付等等微谓,就需要改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("===發(fā)起支付寶支付===");
}
}
@PayCode(value = "weixin", name = "微信支付")
@Service
public class WeixinPay implements IPay {
@Override
public void pay() {
System.out.println("===發(fā)起微信支付===");
}
}
@PayCode(value = "jingdong", name = "京東支付")
@Service
public class JingDongPay implements IPay {
@Override
public void pay() {
System.out.println("===發(fā)起京東支付===");
}
}
然后增加最關鍵的類:
@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類實現(xiàn)了ApplicationListener
接口轧铁,這樣在onApplicationEvent
方法中,就可以拿到ApplicationContext
的實例齿风。我們再獲取打了PayCode注解的類,放到一個map中聂宾,map中的key就是PayCode注解中定義的value系谐,跟code參數(shù)一致,value是支付類的實例纪他。
這樣,每次就可以每次直接通過code獲取支付類實例茶袒,而不用if...else判斷了。如果要加新的支付方法薪寓,只需在支付類上面打上PayCode注解定義一個新的code即可。
注意:這種方式的code可以沒有業(yè)務含義向叉,可以是純數(shù)字,只有不重復就行母谎。
2、動態(tài)拼接名稱
該方法主要針對code是有業(yè)務含義的場景京革。
@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保持一致来惧。調(diào)用的支付類的實例是直接從ApplicationContext
實例中獲取的冗栗,默認情況下bean是單例的,放在內(nèi)存的一個map中,所以不會有性能問題隅居。
特別說明一下钠至,這種方法實現(xiàn)了ApplicationContextAware接口跟上面的ApplicationListener
接口不一樣,是想告訴大家獲取ApplicationContext
實例的方法不只一種胎源。
3棉钧、模板方法判斷
當然除了上面介紹的兩種方法之外,spring的源碼實現(xiàn)中也告訴我們另外一種思路涕蚤,解決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
方法万栅,有三個類實現(xiàn)了這個方法佑钾。我們隨便抽一個類看看
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
烦粒。
我們看到這里應該有所啟發(fā)休溶。
其實,我們可以這樣做扰她,定義一個接口或者抽象類兽掰,里面有個support
方法判斷參數(shù)傳的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("===發(fā)起支付寶支付===");
}
}
@Service
public class WeixinPay implements IPay {
@Override
public boolean support(String code) {
return "weixin".equals(code);
}
@Override
public void pay() {
System.out.println("===發(fā)起微信支付===");
}
}
@Service
public class JingDongPay implements IPay {
@Override
public boolean support(String code) {
return "jingdong".equals(code);
}
@Override
public void pay() {
System.out.println("===發(fā)起京東支付===");
}
}
每個支付類都有一個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();
}
}
}
}
這段代碼中先把實現(xiàn)了IPay接口的支付類實例初始化到一個list集合中忧勿,返回在調(diào)用支付接口時循環(huán)遍歷這個list集合杉女,如果code跟自己定義的一樣,則調(diào)用當前的支付類實例的pay方法宠纯。
4.策略+工廠模式
這種方式也是用于code是有業(yè)務含義的場景层释。
策略模式定義了一組算法,把它們一個個封裝起來, 并且使它們可相互替換廉白。
工廠模式用于封裝和管理對象的創(chuàng)建猴蹂,是一種創(chuàng)建型模式楣嘁。
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("===發(fā)起支付寶支付===");
}
}
@Service
public class WeixinPay implements IPay {
@PostConstruct
public void init() {
PayStrategyFactory.register("weixinPay", this);
}
@Override
public void pay() {
System.out.println("===發(fā)起微信支付===");
}
}
@Service
public class JingDongPay implements IPay {
@PostConstruct
public void init() {
PayStrategyFactory.register("jingDongPay", this);
}
@Override
public void pay() {
System.out.println("===發(fā)起京東支付===");
}
}
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的實現(xiàn)類中注冊當前實例到map中把曼,然后在調(diào)用的地方通過PayStrategyFactory類根據(jù)code從map獲取支付類實例即可嗤军。
5.責任鏈模式
這種方式在代碼重構時用來消除if...else非常有效。
責任鏈模式:將請求的處理對象像一條長鏈一般組合起來当凡,形成一條對象鏈。請求并不知道具體執(zhí)行請求的對象是哪一個浪慌,這樣就實現(xiàn)了請求與處理對象之間的解耦权纤。
常用的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("===發(fā)起支付寶支付===");
} else {
getNext().pay(code);
}
}
}
@Service
public class WeixinPayHandler extends PayHandler {
@Override
public void pay(String code) {
if ("weixin".equals(code)) {
System.out.println("===發(fā)起微信支付===");
} else {
getNext().pay(code);
}
}
}
@Service
public class JingDongPayHandler extends PayHandler {
@Override
public void pay(String code) {
if ("jingdong".equals(code)) {
System.out.println("===發(fā)起京東支付===");
} 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的子類,都定義了下一個需要執(zhí)行的PayHandler子類庞萍,構成一個鏈式調(diào)用钝计,通過PayHandlerChain把這種鏈式結(jié)構組裝起來齐佳。
6炼吴、其他的消除if...else的方法
當然實際項目開發(fā)中使用if...else判斷的場景非常多缺厉,上面只是其中幾種場景隧土。下面再列舉一下,其他常見的場景辐脖。
1.根據(jù)不同的數(shù)字返回不同的字符串
public String getMessage(int code) {
if (code == 1) {
return "成功";
} elseif (code == -1) {
return "失敗";
} elseif (code == -2) {
return "網(wǎng)絡超時";
} elseif (code == -3) {
return "參數(shù)錯誤";
}
thrownew RuntimeException("code錯誤");
}
其實嗜价,這種判斷沒有必要久锥,用一個枚舉就可以搞定异剥。
publice num MessageEnum {
SUCCESS(1, "成功"),
FAIL(-1, "失敗"),
TIME_OUT(-2, "網(wǎng)絡超時"),
PARAM_ERROR(-3, "參數(shù)錯誤");
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);
}
}
再把調(diào)用方法稍微調(diào)整一下
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;
}
對于集合中過濾數(shù)據(jù)蚪腋,或者查找方法辣吃,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中的判斷
對于參數(shù)的異常稼稿,越早被發(fā)現(xiàn)越好讳窟,在spring中提供了Assert用來幫助我們檢測參數(shù)是否有效丽啡。
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");
}
}
}
如果參數(shù)非常多的話改执,if...else語句會很長辈挂,這時如果改成使用Assert類判斷裹粤,代碼會簡化很多:
public String save2(Integer code蛹尝,String name) {
Assert.notNull(code,"code不能為空");
Assert.notNull(name,"name不能為空");
System.out.println("doSave");
}
當然突那,還有很多其他的場景可以優(yōu)化if...else构眯,我再這里就不一一介紹了惫霸,感興趣的朋友可以給我留言,一起探討和研究一下猜丹。
最后說一句(求關注射窒,別白嫖我)
如果這篇文章對您有所幫助,或者有所啟發(fā)的話脉顿,幫忙掃描下發(fā)二維碼關注一下艾疟,您的支持是我堅持寫作最大的動力。
求一鍵三連:點贊弟疆、轉(zhuǎn)發(fā)兽间、在看正塌。
在公眾號中回復:面試、代碼神器帜羊、開發(fā)手冊讼育、時間管理有超贊的粉絲福利稠集,另外回復:加群剥纷,可以跟很多BAT大廠的前輩交流和學習。