工作中，少不了要定義各種接口，系統(tǒng)集成要定義接口，前后臺(tái)掉調(diào)用也要定義接口。接口定義一定程度上能反應(yīng)程序員的編程功底。列舉一下工作中我發(fā)現(xiàn)大家容易出現(xiàn)的問(wèn)題：
- 返回格式不統(tǒng)一
同一個(gè)接口，有時(shí)候返回?cái)?shù)組，有時(shí)候返回單個(gè)；成功的時(shí)候返回對(duì)象，失敗的時(shí)候返回錯(cuò)誤信息字符串。工作中有個(gè)系統(tǒng)集成就是這樣定義的接口，真是辣眼睛。這個(gè)對(duì)應(yīng)代碼上，返回的類型是map，json，object，都是不應(yīng)該的。實(shí)際工作中，我們會(huì)定義一個(gè)統(tǒng)一的格式，就是ResultBean，分頁(yè)的有另外一個(gè)PageResultBean
錯(cuò)誤范例：
//返回map可讀性不好，盡量不要
＠PostMapping("/delete")
public Map<String, Object> delete(long id, String lang) {
}
// 成功返回boolean，失敗返回string，大忌
＠PostMapping("/delete")
public Object delete(long id, String lang) {
try {
boolean result = configService.delete(id, local);
return result;
} catch (Exception e) {
log.error(e);
return e.toString();
}
}
- 沒(méi)有考慮失敗情況
一開(kāi)始只考慮成功場(chǎng)景，等后面測(cè)試發(fā)現(xiàn)有錯(cuò)誤情況，怎么辦，改接口唄，前后臺(tái)都改，勞民傷財(cái)無(wú)用功。
錯(cuò)誤范例：
//不返回任何數(shù)據(jù)，沒(méi)有考慮失敗場(chǎng)景，容易返工
＠PostMapping("/update")
public void update(long id, xxx) {
}
- 出現(xiàn)和業(yè)務(wù)無(wú)關(guān)的輸入?yún)?shù)
如lang語(yǔ)言，當(dāng)前用戶信息 都不應(yīng)該出現(xiàn)參數(shù)里面，應(yīng)該從當(dāng)前會(huì)話里面獲取。后面講ThreadLocal會(huì)說(shuō)到怎么樣去掉。除了代碼可讀性不好問(wèn)題外，尤其是參數(shù)出現(xiàn)當(dāng)前用戶信息的，這是個(gè)嚴(yán)重問(wèn)題。
錯(cuò)誤范例：
// （當(dāng)前用戶刪除數(shù)據(jù)）參數(shù)出現(xiàn)lang和userid，尤其是userid，大忌
＠PostMapping("/delete")
public Map<String, Object> delete(long id, String lang, String userId) {
}
- 出現(xiàn)復(fù)雜的輸入?yún)?shù)
一般情況下，不允許出現(xiàn)例如json字符串這樣的參數(shù)，這種參數(shù)可讀性極差。應(yīng)該定義對(duì)應(yīng)的bean。
錯(cuò)誤范例：
// 參數(shù)出現(xiàn)json格式，可讀性不好，代碼也難看
＠PostMapping("/update")
public Map<String, Object> update(long id, String jsonStr) {
}
- 沒(méi)有返回應(yīng)該返回的數(shù)據(jù)
例如，新增接口一般情況下應(yīng)該返回新對(duì)象的id標(biāo)識(shí)，這需要編程經(jīng)驗(yàn)。新手定義的時(shí)候因?yàn)榍芭_(tái)沒(méi)有用就不返回?cái)?shù)據(jù)或者只返回true，這都是不恰當(dāng)?shù)?。別人要不要是別人的事情，你該返回的還是應(yīng)該返回。
錯(cuò)誤范例：
// 約定俗成，新建應(yīng)該返回新對(duì)象的信息，只返回boolean容易導(dǎo)致返工
＠PostMapping("/add")
public boolean add(xxx) {
//xxx
return configService.add();
}
很多人看了我的這篇文章 [程序員你為什么這么累？]，都覺(jué)得里面的技術(shù)也很簡(jiǎn)單，沒(méi)有什么特別的地方，但是，實(shí)現(xiàn)這個(gè)代碼框架之前，就是要你的接口的統(tǒng)一的格式ResultBean，aop才好做。有些人誤解了，我那篇文章說(shuō)的都不是技術(shù)，重點(diǎn)說(shuō)的是編碼習(xí)慣工作方式，如果你重點(diǎn)還是放在什么技術(shù)上，那我也幫不了你了。同樣，如果我后面的關(guān)于習(xí)慣和規(guī)范的帖子，你重點(diǎn)還是放在技術(shù)上的話，那是丟了西瓜撿芝麻，有很多貼還是沒(méi)有任何技術(shù)點(diǎn)呢。
附上ResultBean，沒(méi)有任何技術(shù)含量：
＠Data
public class ResultBean<T> implements Serializable {
private static final long serialVersionUID = 1L;
public static final int SUCCESS = 0;
public static final int FAIL = 1;
public static final int NO_PERMISSION = 2;
private String msg = "success";
private int code = SUCCESS;
private T data;
public ResultBean() {
super();
}
public ResultBean(T data) {
super();
this.data = data;
}
public ResultBean(Throwable e) {
super();
this.msg = e.toString();
this.code = FAIL ;
}
}
統(tǒng)一的接口規(guī)范，能幫忙規(guī)避很多無(wú)用的返工修改和可能出現(xiàn)的問(wèn)題。能使代碼可讀性更加好，利于進(jìn)行aop和自動(dòng)化測(cè)試這些額外工作。大家一定要重視。
上一篇：《程序?yàn)槭裁催@么累》
下一篇：《接口定義規(guī)范》
本文原著作者：曉風(fēng)輕
原文鏈接：https://zhuanlan.zhihu.com/p/28708259
版權(quán)歸作者所有，轉(zhuǎn)載請(qǐng)注明出處
