工作中，少不了要定義各種接口除嘹，系統(tǒng)集成要定義接口姨丈，前后臺(tái)掉調(diào)用也要定義接口。接口定義一定程度上能反應(yīng)程序員的編程功底埃难。列舉一下工作中我發(fā)現(xiàn)大家容易出現(xiàn)的問題：
1. 返回格式不統(tǒng)一
同一個(gè)接口莹弊，有時(shí)候返回?cái)?shù)組，有時(shí)候返回單個(gè)涡尘；成功的時(shí)候返回對象忍弛，失敗的時(shí)候返回錯(cuò)誤信息字符串。工作中有個(gè)系統(tǒng)集成就是這樣定義的接口考抄，真是辣眼睛细疚。這個(gè)對應(yīng)代碼上，返回的類型是map川梅，json疯兼，object，都是不應(yīng)該的贫途。實(shí)際工作中吧彪，我們會(huì)定義一個(gè)統(tǒng)一的格式，就是ResultBean潮饱，分頁的有另外一個(gè)PageResultBean
錯(cuò)誤范例：
//返回map可讀性不好，盡量不要
＠PostMapping("/delete")
publicMapdelete(longid,Stringlang){
}
// 成功返回boolean诫给，失敗返回string香拉，大忌
＠PostMapping("/delete")
publicObjectdelete(longid,Stringlang){
try{
booleanresult=configService.delete(id,local);
returnresult;
}catch(Exceptione){
log.error(e);
returne.toString();
}
}
2. 沒有考慮失敗情況
一開始只考慮成功場景，等后面測試發(fā)現(xiàn)有錯(cuò)誤情況中狂，怎么辦凫碌，改接口唄，前后臺(tái)都改胃榕，勞民傷財(cái)無用功盛险。
錯(cuò)誤范例：
//不返回任何數(shù)據(jù)，沒有考慮失敗場景勋又，容易返工
＠PostMapping("/update")
publicvoidupdate(longid,xxx){
}
3. 出現(xiàn)和業(yè)務(wù)無關(guān)的輸入?yún)?shù)
如lang語言苦掘，當(dāng)前用戶信息 都不應(yīng)該出現(xiàn)參數(shù)里面，應(yīng)該從當(dāng)前會(huì)話里面獲取楔壤。后面講ThreadLocal會(huì)說到怎么樣去掉鹤啡。除了代碼可讀性不好問題外，尤其是參數(shù)出現(xiàn)當(dāng)前用戶信息的蹲嚣，這是個(gè)嚴(yán)重問題递瑰。
錯(cuò)誤范例：
// （當(dāng)前用戶刪除數(shù)據(jù)）參數(shù)出現(xiàn)lang和userid祟牲，尤其是userid，大忌
＠PostMapping("/delete")
publicMapdelete(longid,Stringlang,StringuserId){
}
4. 出現(xiàn)復(fù)雜的輸入?yún)?shù)
一般情況下抖部，不允許出現(xiàn)例如json字符串這樣的參數(shù)说贝，這種參數(shù)可讀性極差。應(yīng)該定義對應(yīng)的bean慎颗。
錯(cuò)誤范例：
// 參數(shù)出現(xiàn)json格式乡恕，可讀性不好，代碼也難看
＠PostMapping("/update")
publicMapupdate(longid,StringjsonStr){
}
5. 沒有返回應(yīng)該返回的數(shù)據(jù)
例如哗总，新增接口一般情況下應(yīng)該返回新對象的id標(biāo)識(shí)几颜，這需要編程經(jīng)驗(yàn)。新手定義的時(shí)候因?yàn)榍芭_(tái)沒有用就不返回?cái)?shù)據(jù)或者只返回true讯屈，這都是不恰當(dāng)?shù)牡翱蕖e人要不要是別人的事情，你該返回的還是應(yīng)該返回涮母。
錯(cuò)誤范例：
// 約定俗成谆趾，新建應(yīng)該返回新對象的信息，只返回boolean容易導(dǎo)致返工
＠PostMapping("/add")
publicbooleanadd(xxx){
//xxx
returnconfigService.add();
}
很多人看了我的這篇文章程序員你為什么這么累叛本？沪蓬，都覺得里面的技術(shù)也很簡單，沒有什么特別的地方来候，但是跷叉，實(shí)現(xiàn)這個(gè)代碼框架之前，就是要你的接口的統(tǒng)一的格式ResultBean营搅，aop才好做云挟。有些人誤解了，我那篇文章說的都不是技術(shù)转质，重點(diǎn)說的是編碼習(xí)慣工作方式园欣，如果你重點(diǎn)還是放在什么技術(shù)上，那我也幫不了你了休蟹。同樣沸枯，如果我后面的關(guān)于習(xí)慣和規(guī)范的帖子，你重點(diǎn)還是放在技術(shù)上的話赂弓，那是丟了西瓜撿芝麻绑榴，有很多貼還是沒有任何技術(shù)點(diǎn)呢。
附上ResultBean盈魁，沒有任何技術(shù)含量：
＠Data
publicclassResultBeanimplementsSerializable{
privatestaticfinallongserialVersionUID=1L;
publicstaticfinalintSUCCESS=0;
publicstaticfinalintFAIL=1;
publicstaticfinalintNO_PERMISSION=2;
privateStringmsg="success";
privateintcode=SUCCESS;
privateT data;
publicResultBean(){
super();
}
publicResultBean(T data){
super();
this.data=data;
}
publicResultBean(Throwablee){
super();
this.msg=e.toString();
this.code=FAIL;
}
}
統(tǒng)一的接口規(guī)范彭沼，能幫忙規(guī)避很多無用的返工修改和可能出現(xiàn)的問題。能使代碼可讀性更加好备埃，利于進(jìn)行aop和自動(dòng)化測試這些額外工作姓惑。大家一定要重視褐奴。
第一篇文章中，我貼了2段代碼于毙，第一個(gè)是原生態(tài)的敦冬，第2段是我指定了接口定義規(guī)范，使用AOP技術(shù)之后最終交付的代碼唯沮，從15行到一行脖旱，自己感受一下。今天來說說大家關(guān)注的AOP如何實(shí)現(xiàn)介蛉。
先說說Controller規(guī)范萌庆，主要的內(nèi)容是就是接口定義里面的內(nèi)容，你只要遵循里面的規(guī)范币旧，controller就問題不大践险，除了這些，還有另外的幾點(diǎn)：
所有函數(shù)返回統(tǒng)一的ResultBean/PageResultBean格式
原因見我的接口定義這個(gè)貼吹菱。沒有統(tǒng)一格式巍虫，AOP無法玩。
ResultBean/PageResultBean是controller專用的鳍刷，不允許往后傳占遥！
Controller做參數(shù)格式的轉(zhuǎn)換，不允許把json输瓜，map這類對象傳到services去瓦胎，也不允許services返回json、map尤揣。
一般情況下搔啊！寫過代碼都知道，map芹缔，json這種格式靈活坯癣，但是可讀性差瓶盛，如果放業(yè)務(wù)數(shù)據(jù)最欠，每次閱讀起來都比較困難。定義一個(gè)bean看著工作量多了惩猫，但代碼清晰多了芝硬。
參數(shù)中一般情況不允許出現(xiàn)Request，Response這些對象
主要是可讀性問題轧房。一般情況下拌阴。
不需要打印日志
日志在AOP里面會(huì)打印，而且我的建議是大部分日志在Services這層打印奶镶。
規(guī)范里面大部分是 不要做的項(xiàng)多迟赃，要做的比較少陪拘，落地比較容易。
ResultBean定義帶泛型纤壁，使用了lombok左刽。
AOP代碼，主要就是打印日志和捕獲異常酌媒，異常要區(qū)分已知異常和未知異常欠痴，其中未知的異常是我們重點(diǎn)關(guān)注的，可以做一些郵件通知啥的秒咨，已知異忱桑可以再細(xì)分一下，可以不同的異常返回不同的返回碼：
publicclassControllerAOP{
privatestaticfinalLoggerlogger=LoggerFactory.getLogger(ControllerAOP.class);
publicObjecthandlerControllerMethod(ProceedingJoinPointpjp){
longstartTime=System.currentTimeMillis();
ResultBeanresult;
try{
result=(ResultBean)pjp.proceed();
logger.info(pjp.getSignature()+"use time:"+(System.currentTimeMillis()-startTime));
}catch(Throwablee){
result=handlerException(pjp,e);
}
returnresult;
}
privateResultBeanhandlerException(ProceedingJoinPointpjp,Throwablee){
ResultBeanresult=newResultBean();
// 已知異常
if(einstanceofCheckException){
result.setMsg(e.getLocalizedMessage());
result.setCode(ResultBean.FAIL);
}else{
logger.error(pjp.getSignature()+" error ",e);
result.setMsg(e.toString());
result.setCode(ResultBean.FAIL);
// 未知異常是應(yīng)該重點(diǎn)關(guān)注的雨席，這里可以做其他操作菩咨，如通知郵件，單獨(dú)寫到某個(gè)文件等等舅世。
}
returnresult;
}
}
AOP配置：(關(guān)于用java代碼還是xml配置旦委，這里我傾向于xml配置，因?yàn)檫@個(gè)會(huì)不定期改動(dòng))
expression="execution(public xxx.common.beans.ResultBean *(..))"/>
現(xiàn)在知道為什么要返回統(tǒng)一的一個(gè)ResultBean了：
為了統(tǒng)一格式
為了應(yīng)用AOP
為了包裝異常信息
分頁的PageResultBean大同小異雏亚，大家自己依葫蘆畫瓢自己完成就好了缨硝。
貼一個(gè)簡單的controller（左邊的箭頭表示AOP攔截了）。請對比程序員你為什么這么累罢低？里面原來的代碼查看查辩，沒有對比就沒有傷害。
最后說一句网持，先有統(tǒng)一的接口定義規(guī)范宜岛，然后有AOP實(shí)現(xiàn)。先有思想再有技術(shù)功舀。技術(shù)不是關(guān)鍵萍倡，AOP技術(shù)也很簡單，這個(gè)帖子的關(guān)鍵點(diǎn)不是技術(shù)辟汰，而是習(xí)慣和思想列敲，不要撿了芝麻丟了西瓜。網(wǎng)絡(luò)上講技術(shù)的貼多帖汞，講習(xí)慣戴而、風(fēng)格的少，這些都是我工作多年的行之有效的經(jīng)驗(yàn)之談翩蘸，望有緣人珍惜所意。
覺得有用請點(diǎn)贊加關(guān)注，接下來再繼續(xù)其他規(guī)范。敬請期待扶踊。
