1.常見問題
1. 返回格式不統(tǒng)一
同一個接口，有時候返回數(shù)組套像，有時候返回單個衣撬；成功的時候返回對象乖订，失敗的時候返回錯誤信息字符串。工作中有個系統(tǒng)集成就是這樣定義的接口具练，真是辣眼睛乍构。這個對應(yīng)代碼上，返回的類型是map扛点，json哥遮，object，都是不應(yīng)該的陵究。實際工作中眠饮，我們會定義一個統(tǒng)一的格式，就是ResultBean铜邮，分頁的有另外一個PageResultBean
錯誤范例：
//返回map可讀性不好仪召，盡量不要
＠PostMapping("/delete")
publicMapdelete(longid,Stringlang){
}
// 成功返回boolean寨蹋，失敗返回string，大忌
＠PostMapping("/delete")
publicObject delete(longid,Stringlang){
try{
boolean result=configService.delete(id,local);
return result;
}catch(Exceptione){
log.error(e);
returne.toString();
}
}
2. 沒有考慮失敗情況
一開始只考慮成功場景扔茅，等后面測試發(fā)現(xiàn)有錯誤情況已旧，怎么辦，改接口唄咖摹，前后臺都改评姨，勞民傷財無用功。
錯誤范例：
//不返回任何數(shù)據(jù)萤晴，沒有考慮失敗場景吐句，容易返工
＠PostMapping("/update")
public void update(longid,xxx){
}
3. 出現(xiàn)和業(yè)務(wù)無關(guān)的輸入?yún)?shù)
如lang語言，當(dāng)前用戶信息 都不應(yīng)該出現(xiàn)參數(shù)里面店读，應(yīng)該從當(dāng)前會話里面獲取嗦枢。后面講ThreadLocal會說到怎么樣去掉。除了代碼可讀性不好問題外屯断，尤其是參數(shù)出現(xiàn)當(dāng)前用戶信息的文虏，這是個嚴(yán)重問題。
錯誤范例：
// （當(dāng)前用戶刪除數(shù)據(jù)）參數(shù)出現(xiàn)lang和userid殖演，尤其是userid氧秘，大忌
＠PostMapping("/delete")
public Map?delete(longid,Stringlang,StringuserId){
}
4. 出現(xiàn)復(fù)雜的輸入?yún)?shù)
一般情況下，不允許出現(xiàn)例如json字符串這樣的參數(shù)趴久，這種參數(shù)可讀性極差丸相。應(yīng)該定義對應(yīng)的bean。
錯誤范例：
// 參數(shù)出現(xiàn)json格式彼棍，可讀性不好灭忠，代碼也難看
＠PostMapping("/update")
public Map?update(longid,StringjsonStr){
}
5. 沒有返回應(yīng)該返回的數(shù)據(jù)
例如，新增接口一般情況下應(yīng)該返回新對象的id標(biāo)識座硕，這需要編程經(jīng)驗弛作。新手定義的時候因為前臺沒有用就不返回數(shù)據(jù)或者只返回true，這都是不恰當(dāng)?shù)幕摇e人要不要是別人的事情映琳，你該返回的還是應(yīng)該返回。
錯誤范例：
// 約定俗成蜘拉，新建應(yīng)該返回新對象的信息刊头，只返回boolean容易導(dǎo)致返工
＠PostMapping("/add")
public booleanadd(xxx){
//xxx
return configService.add();
}
＠Data
public class ResultBean?implements Serializable{
private static final longserialVersionUID=1L;
public static final int SUCCESS=0;
publics tatic final int FAIL=1;
public static final int NO_PERMISSION=2;
private String msg="success";
private int code=SUCCESS;
privateT data;
public ResultBean(){
super();
}
public Result Bean(T data){
super();
this.data=data;
}
public Result Bean(Throwablee){
super();
this.msg=e.toString();
this.code=FAIL;
}
}
2.Controller規(guī)范
Controller規(guī)范，主要的內(nèi)容是就是接口定義里面的內(nèi)容诸尽，你只要遵循里面的規(guī)范原杂，controller就問題不大，除了這些您机，還有另外的幾點：
所有函數(shù)返回統(tǒng)一的ResultBean/PageResultBean格式
原因沒有統(tǒng)一格式穿肄，AOP無法玩年局。
ResultBean/PageResultBean是controller專用的，不允許往后傳咸产！
Controller做參數(shù)格式的轉(zhuǎn)換矢否，不允許把json，map這類對象傳到services去脑溢，也不允許services返回json僵朗、map。
一般情況下屑彻！寫過代碼都知道验庙，map，json這種格式靈活社牲，但是可讀性差粪薛，如果放業(yè)務(wù)數(shù)據(jù)，每次閱讀起來都比較困難搏恤。定義一個bean看著工作量多了违寿，但代碼清晰多了。
參數(shù)中一般情況不允許出現(xiàn)Request熟空，Response這些對象
主要是可讀性問題藤巢。一般情況下。
不需要打印日志
日志在AOP里面會打印息罗，而且我的建議是大部分日志在Services這層打印掂咒。
規(guī)范里面大部分是 不要做的項多，要做的比較少阱当，落地比較容易俏扩。
ResultBean定義帶泛型糜工，使用了lombok弊添。
AOP代碼，主要就是打印日志和捕獲異常捌木，異常要區(qū)分已知異常和未知異常油坝，其中未知的異常是我們重點關(guān)注的，可以做一些郵件通知啥的刨裆，已知異吵喝Γ可以再細(xì)分一下，可以不同的異常返回不同的返回碼：
public class ControllerAOP{
private static final Loggerlogger=LoggerFactory.getLogger(ControllerAOP.class);
public Object handlerControllerMethod(ProceedingJoinPointpjp){
longstartTime=System.currentTimeMillis();
ResultBean?result;
try{
result=(ResultBean)pjp.proceed();
logger.info(pjp.getSignature()+"use time:"+(System.currentTimeMillis()-startTime));
}catch(Throwablee){
result=handlerException(pjp,e);
}
returnresult;
}
private ResultBean?handlerException(ProceedingJoinPointpjp,Throwablee){
Result Beanresult=newResultBean();
// 已知異常
if(e instanceof CheckException){
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)該重點關(guān)注的帆啃，這里可以做其他操作瞬女，如通知郵件，單獨寫到某個文件等等努潘。
}
return result;
}
}
AOP配置：(關(guān)于用java代碼還是xml配置诽偷，這里我傾向于xml配置坤学，因為這個會不定期改動)
現(xiàn)在知道為什么要返回統(tǒng)一的一個ResultBean了：
為了統(tǒng)一格式
為了應(yīng)用AOP
為了包裝異常信息
分頁的PageResultBean大同小異异袄，大家自己依葫蘆畫瓢自己完成就好了抹腿。
貼一個簡單的controller（左邊的箭頭表示AOP攔截了）。請對比程序員你為什么這么累池充？里面原來的代碼查看眠冈，沒有對比就沒有傷害飞苇。
最后說一句，先有統(tǒng)一的接口定義規(guī)范蜗顽，然后有AOP實現(xiàn)布卡。先有思想再有技術(shù)。
