作者:安卓大叔 來源:www.jianshu.com/p/57c065b124c4
寫在前面
不知大家有沒遇到過像“橫放著的金字塔”一樣的if else
巢狀:
if (true) {
if (true) {
if (true) {
if (true) {
if (true) {
if (true) {
}
}
}
}
}
}
我並沒誇大其詞,我是真的遇到過了!巢狀6、7層,一個函式幾百行,簡!直!看!死!人!
if else
作為每種程式語言都不可或缺的條件陳述句,我們在程式設計時會大量的用到。但if else
一般不建議巢狀超過三層,如果一段程式碼存在過多的if else
巢狀,程式碼的可讀性就會急速下降,後期維護難度也大大提高。所以,我們程式員都應該儘量避免過多的if else
巢狀。下麵將會談談我在工作中如何減少if else
巢狀的。
正文
在談我的方法之前,不妨先用個例子來說明if else
巢狀過多的弊端。
想象下一個簡單分享的業務需求:支援分享連結、圖片、文字和圖文,分享結果回呼給使用者(為了不跑題,這裡簡略了業務,實際複雜得多)。當接手到這麼一個業務時,是不是覺得很簡單,稍動下腦就可以動手了:
先定義分享的型別、分享Bean和分享回呼類:
private static final int TYPE_LINK = 0;
private static final int TYPE_IMAGE = 1;
private static final int TYPE_TEXT = 2;
private static final int TYPE_IMAGE_TEXT = 3;
public class ShareItem {
int type;
String title;
String content;
String imagePath;
String link;
}
public interface ShareListener {
int STATE_SUCC = 0;
int STATE_FAIL = 1;
void onCallback(int state, String msg);
}
好了,然後在定義個分享介面,對每種型別分別進行分享就ok了:
public void share (ShareItem item, ShareListener listener) {
if (item != null) {
if (item.type == TYPE_LINK) {
// 分享連結
if (!TextUtils.isEmpty(item.link) && !TextUtils.isEmpty(item.title)) {
doShareLink(item.link, item.title, item.content, listener);
} else {
if (listener != null) {
listener.onCallback(ShareListener.STATE_FAIL, "分享資訊不完整");
}
}
} else if (item.type == TYPE_IMAGE) {
// 分享圖片
if (!TextUtils.isEmpty(item.imagePath)) {
doShareImage(item.imagePath, listener);
} else {
if (listener != null) {
listener.onCallback(ShareListener.STATE_FAIL, "分享資訊不完整");
}
}
} else if (item.type == TYPE_TEXT) {
// 分享文字
if (!TextUtils.isEmpty(item.content)) {
doShareText(item.content, listener);
} else {
if (listener != null) {
listener.onCallback(ShareListener.STATE_FAIL, "分享資訊不完整");
}
}
} else if (item.type == TYPE_IMAGE_TEXT) {
// 分享圖文
if (!TextUtils.isEmpty(item.imagePath) && !TextUtils.isEmpty(item.content)) {
doShareImageAndText(item.imagePath, item.content, listener);
} else {
if (listener != null) {
listener.onCallback(ShareListener.STATE_FAIL, "分享資訊不完整");
}
}
} else {
if (listener != null) {
listener.onCallback(ShareListener.STATE_FAIL, "不支援的分享型別");
}
}
} else {
if (listener != null) {
listener.onCallback(ShareListener.STATE_FAIL, "ShareItem 不能為 null");
}
}
}
到此,簡單的分享模型就做出來了。有沒問題?老實說,如果沒什麼追求的話,還真沒什麼問題,至少思路是清晰的。但一週後呢?一個月後呢?或者一年後呢?share
方法的分支有15條,這意味著你每次回看程式碼得讓自己的大腦變成微型的處理器,考慮15種情況。如果出現bug,你又得考慮15種情況,並15種情況都要測試下。再如果現在需要加多分享小影片功能,你又得新增多3個分支,還要改程式碼,一點都不“開放-閉合”。再再如果後面專案交接給他人跟進,他人又要把自己大腦變成處理器來想每個分支的作用,我敢肯定有百分之八十的人都會吐槽程式碼。
我們程式員的腦力不應該花費在無止境的分支陳述句裡的,應該專註於業務本身。所以我們很有必要避免寫出多分支巢狀的陳述句。好的,我們來分析下上面的程式碼多分支的原因:
- 空值判斷
- 業務判斷
- 狀態判斷
幾乎所有的業務都離不開這幾個判斷,從而導致if else
巢狀過多。那是不是沒辦法解決了?答案肯定不是的。
上面的程式碼我是用java寫的,對於java程式員來說,空值判斷簡直使人很沮喪,讓人身心疲憊。上面的程式碼每次回呼都要判斷一次listener
是否為空,又要判斷使用者傳入的ShareItem
是否為空,還要判斷ShareItem
裡面的欄位是否為空……
對於這種情況,我採用的方法很簡單:介面分層。
減少 if else 方法一:介面分層
所謂介面分層指的是:把介面分為外部和內部介面,所有空值判斷放在外部介面完成,只處理一次;而內部介面傳入的變數由外部介面保證不為空,從而減少空值判斷。
來,看程式碼更加直觀:
public void share(ShareItem item, ShareListener listener) {
if (item == null) {
if (listener != null) {
listener.onCallback(ShareListener.STATE_FAIL, "ShareItem 不能為 null");
}
return;
}
if (listener == null) {
listener = new ShareListener() {
@Override
public void onCallback(int state, String msg) {
Log.i("DEBUG", "ShareListener is null");
}
};
}
shareImpl(item, listener);
}
private void shareImpl (ShareItem item, ShareListener listener) {
if (item.type == TYPE_LINK) {
// 分享連結
if (!TextUtils.isEmpty(item.link) && !TextUtils.isEmpty(item.title)) {
doShareLink(item.link, item.title, item.content, listener);
} else {
listener.onCallback(ShareListener.STATE_FAIL, "分享資訊不完整");
}
} else if (item.type == TYPE_IMAGE) {
// 分享圖片
if (!TextUtils.isEmpty(item.imagePath)) {
doShareImage(item.imagePath, listener);
} else {
listener.onCallback(ShareListener.STATE_FAIL, "分享資訊不完整");
}
} else if (item.type == TYPE_TEXT) {
// 分享文字
if (!TextUtils.isEmpty(item.content)) {
doShareText(item.content, listener);
} else {
listener.onCallback(ShareListener.STATE_FAIL, "分享資訊不完整");
}
} else if (item.type == TYPE_IMAGE_TEXT) {
// 分享圖文
if (!TextUtils.isEmpty(item.imagePath) && !TextUtils.isEmpty(item.content)) {
doShareImageAndText(item.imagePath, item.content, listener);
} else {
listener.onCallback(ShareListener.STATE_FAIL, "分享資訊不完整");
}
} else {
listener.onCallback(ShareListener.STATE_FAIL, "不支援的分享型別");
}
}
可以看到,上面的程式碼分為外部介面share
和內部介面shareImpl
,ShareItem
和ShareListener
的判斷都放在share
裡完成,那麼shareImpl
就減少了if else
的嵌套了,相當於把if else
分攤了。這樣一來,程式碼的可讀性好很多,巢狀也不超過3層了。
但可以看到,shareImpl
裡還是包含分享型別的判斷,也即業務判斷,我們都清楚產品經理的腦洞有多大了,分享的型別隨時會改變或新增。嗯說到這裡相信大家都想到用多型了。多型不但能應付業務改變的情況,也可以用來減少if else
的巢狀。
減少 if else 方法二:多型
利用多型,每種業務單獨處理,在介面不再做任何業務判斷。把ShareItem
抽象出來,作為基礎類,然後針對每種業務各自實現其子類:
public abstract class ShareItem {
int type;
public ShareItem(int type) {
this.type = type;
}
public abstract void doShare(ShareListener listener);
}
public class Link extends ShareItem {
String title;
String content;
String link;
public Link(String link, String title, String content) {
super(TYPE_LINK);
this.link = !TextUtils.isEmpty(link) ? link : "default";
this.title = !TextUtils.isEmpty(title) ? title : "default";
this.content = !TextUtils.isEmpty(content) ? content : "default";
}
@Override
public void doShare(ShareListener listener) {
// do share
}
}
public class Image extends ShareItem {
String imagePath;
public Image(String imagePath) {
super(TYPE_IMAGE);
this.imagePath = !TextUtils.isEmpty(imagePath) ? imagePath : "default";
}
@Override
public void doShare(ShareListener listener) {
// do share
}
}
public class Text extends ShareItem {
String content;
public Text(String content) {
super(TYPE_TEXT);
this.content = !TextUtils.isEmpty(content) ? content : "default";
}
@Override
public void doShare(ShareListener listener) {
// do share
}
}
public class ImageText extends ShareItem {
String content;
String imagePath;
public ImageText(String imagePath, String content) {
super(TYPE_IMAGE_TEXT);
this.imagePath = !TextUtils.isEmpty(imagePath) ? imagePath : "default";
this.content = !TextUtils.isEmpty(content) ? content : "default";
}
@Override
public void doShare(ShareListener listener) {
// do share
}
}
(註意:上面每個子類的構造方法還對每個欄位做了空值處理,為空的話,賦值default
,這樣如果使用者傳了空值,在除錯就會發現問題。)
實現了多型後,分享介面的就簡潔多了:
public void share(ShareItem item, ShareListener listener) {
if (item == null) {
if (listener != null) {
listener.onCallback(ShareListener.STATE_FAIL, "ShareItem 不能為 null");
}
return;
}
if (listener == null) {
listener = new ShareListener() {
@Override
public void onCallback(int state, String msg) {
Log.i("DEBUG", "ShareListener is null");
}
};
}
shareImpl(item, listener);
}
private void shareImpl (ShareItem item, ShareListener listener) {
item.doShare(listener);
}
嘻嘻,怎樣,內部介面一個if else
都沒了,是不是很酷~ 如果這個分享功能是自己App裡面的功能,不是第三方SDK,到這裡已經沒問題了。但如果是第三方分享SDK的功能的話,這樣暴露給使用者的類增加了很多(各ShareItem
的子類,相當於把if else
拋給使用者了),使用者的接入成本提高,違背了“迪米特原則”了。
處理這種情況也很簡單,再次封裝一層即可。把ShareItem
的子類的訪問許可權降低,在暴露給使用者的主類裡定義幾個方法,在內部幫助使用者建立具體的分享型別,這樣使用者就無需知道具體的類了:
public ShareItem createLinkShareItem(String link, String title, String content) {
return new Link(link, title, content);
}
public ShareItem createImageShareItem(String ImagePath) {
return new Image(ImagePath);
}
public ShareItem createTextShareItem(String content) {
return new Text(content);
}
public ShareItem createImageTextShareItem(String ImagePath, String content) {
return new ImageText(ImagePath, content);
}
或者有人會說,這樣使用者也需額外瞭解多幾個方法。我個人覺得讓使用者瞭解多幾個方法好過瞭解多幾個類,而已方法名一看就能知道意圖,成本還是挺小,是可以接受的。
其實這種情況,更多人想到的是使用工廠樣式。嗯,工廠樣式能解決這個問題(其實也需要使用者額外瞭解多幾個type
型別),但工廠樣式難免又引入分支,我們可以用Map
消除分支。
減少 if else 方法三:使用Map替代分支陳述句
把所有分享型別預先快取在Map
裡,那麼就可以直接get
獲取具體型別,消除分支:
private Map> map = new HashMap<>();
private void init() {
map.put(TYPE_LINK, Link.class);
map.put(TYPE_IMAGE, Image.class);
map.put(TYPE_TEXT, Text.class);
map.put(TYPE_IMAGE_TEXT, ImageText.class);
}
public ShareItem createShareItem(int type) {
try {
Class extends ShareItem> shareItemClass = map.get(type);
return shareItemClass.newInstance();
} catch (Exception e) {
return new DefaultShareItem(); // 傳回預設實現,不要傳回null
}
}
這種方式跟上面分為幾個方法的方式各有利弊,看大家取捨了~
寫在最後
講到這裡大家有沒收穫呢?總結下減少if else
的方法:
- 把介面分為外部和內部介面,所有空值判斷放在外部介面完成;而內部介面傳入的變數由外部介面保證不為空,從而減少空值判斷。
- 利用多型,把業務判斷消除,各子類分別關註自己的實現,並實現子類的建立方法,避免使用者瞭解過多的類。
- 把分支狀態資訊預先快取在
Map
裡,直接get
獲取具體值,消除分支。
好了,到此就介紹完了,希望大家以後寫程式碼能註意,有則避之,無則加勉。希望大家寫的程式碼越來越簡潔~