工作中，少不了要定义各种接口，系统集成要定义接口，前后台掉调用也要定义接口。接口定义一定程度上能反应程序员的编程功底。列举一下工作中我发现大家容易出现的问题：
1. 返回格式不统一
同一个接口，有时候返回数组，有时候返回单个；成功的时候返回对象，失败的时候返回错误信息字符串。工作中有个系统集成就是这样定义的接口，真是辣眼睛。这个对应代码上，返回的类型是map，json，object，都是不应该的。实际工作中，我们会定义一个统一的格式，就是ResultBean，分页的有另外一个PageResultBean
错误范例：
//返回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. 没有考虑失败情况
一开始只考虑成功场景，等后面测试发现有错误情况，怎么办，改接口呗，前后台都改，劳民伤财无用功。
错误范例：
//不返回任何数据，没有考虑失败场景，容易返工
＠PostMapping("/update")
publicvoidupdate(longid,xxx){
}
3. 出现和业务无关的输入参数
如lang语言，当前用户信息 都不应该出现参数里面，应该从当前会话里面获取。后面讲ThreadLocal会说到怎么样去掉。除了代码可读性不好问题外，尤其是参数出现当前用户信息的，这是个严重问题。
错误范例：
// （当前用户删除数据）参数出现lang和userid，尤其是userid，大忌
＠PostMapping("/delete")
publicMapdelete(longid,Stringlang,StringuserId){
}
4. 出现复杂的输入参数
一般情况下，不允许出现例如json字符串这样的参数，这种参数可读性极差。应该定义对应的bean。
错误范例：
// 参数出现json格式，可读性不好，代码也难看
＠PostMapping("/update")
publicMapupdate(longid,StringjsonStr){
}
5. 没有返回应该返回的数据
例如，新增接口一般情况下应该返回新对象的id标识，这需要编程经验。新手定义的时候因为前台没有用就不返回数据或者只返回true，这都是不恰当的。别人要不要是别人的事情，你该返回的还是应该返回。
错误范例：
// 约定俗成，新建应该返回新对象的信息，只返回boolean容易导致返工
＠PostMapping("/add")
publicbooleanadd(xxx){
//xxx
returnconfigService.add();
}
很多人看了我的这篇文章程序员你为什么这么累？，都觉得里面的技术也很简单，没有什么特别的地方，但是，实现这个代码框架之前，就是要你的接口的统一的格式ResultBean，aop才好做。有些人误解了，我那篇文章说的都不是技术，重点说的是编码习惯工作方式，如果你重点还是放在什么技术上，那我也帮不了你了。同样，如果我后面的关于习惯和规范的帖子，你重点还是放在技术上的话，那是丢了西瓜捡芝麻，有很多贴还是没有任何技术点呢。
附上ResultBean，没有任何技术含量：
＠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;
}
}
统一的接口规范，能帮忙规避很多无用的返工修改和可能出现的问题。能使代码可读性更加好，利于进行aop和自动化测试这些额外工作。大家一定要重视。
第一篇文章中，我贴了2段代码，第一个是原生态的，第2段是我指定了接口定义规范，使用AOP技术之后最终交付的代码，从15行到一行，自己感受一下。今天来说说大家关注的AOP如何实现。
先说说Controller规范，主要的内容是就是接口定义里面的内容，你只要遵循里面的规范，controller就问题不大，除了这些，还有另外的几点：
所有函数返回统一的ResultBean/PageResultBean格式
原因见我的接口定义这个贴。没有统一格式，AOP无法玩。
ResultBean/PageResultBean是controller专用的，不允许往后传！
Controller做参数格式的转换，不允许把json，map这类对象传到services去，也不允许services返回json、map。
一般情况下！写过代码都知道，map，json这种格式灵活，但是可读性差，如果放业务数据，每次阅读起来都比较困难。定义一个bean看着工作量多了，但代码清晰多了。
参数中一般情况不允许出现Request，Response这些对象
主要是可读性问题。一般情况下。
不需要打印日志
日志在AOP里面会打印，而且我的建议是大部分日志在Services这层打印。
规范里面大部分是 不要做的项多，要做的比较少，落地比较容易。
ResultBean定义带泛型，使用了lombok。
AOP代码，主要就是打印日志和捕获异常，异常要区分已知异常和未知异常，其中未知的异常是我们重点关注的，可以做一些邮件通知啥的，已知异常可以再细分一下，可以不同的异常返回不同的返回码：
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);
// 未知异常是应该重点关注的，这里可以做其他操作，如通知邮件，单独写到某个文件等等。
}
returnresult;
}
}
AOP配置：(关于用java代码还是xml配置，这里我倾向于xml配置，因为这个会不定期改动)
expression="execution(public xxx.common.beans.ResultBean *(..))"/>
现在知道为什么要返回统一的一个ResultBean了：
为了统一格式
为了应用AOP
为了包装异常信息
分页的PageResultBean大同小异，大家自己依葫芦画瓢自己完成就好了。
贴一个简单的controller（左边的箭头表示AOP拦截了）。请对比程序员你为什么这么累？里面原来的代码查看，没有对比就没有伤害。
最后说一句，先有统一的接口定义规范，然后有AOP实现。先有思想再有技术。技术不是关键，AOP技术也很简单，这个帖子的关键点不是技术，而是习惯和思想，不要捡了芝麻丢了西瓜。网络上讲技术的贴多，讲习惯、风格的少，这些都是我工作多年的行之有效的经验之谈，望有缘人珍惜。
觉得有用请点赞加关注，接下来再继续其他规范。敬请期待。
网友评论