该内容已被发布者删除 该内容被自由微信恢复
文章于 2018年2月21日 被检测为删除。
查看原文
被用户删除
其他

程序员你为什么这么累【续】:编码习惯之Controller规范

2017-08-27 晓风轻 程序猿DD

由于昨天小编没有睡好,犯了两个错误(作者写错+第二张图贴错),重新发布纠正一下。非常抱歉,感谢大家的关注......

——请先阅读这2篇文章:

第一篇文章中,我贴了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代码,主要就是打印日志和捕获异常,异常要区分已知异常和未知异常,其中未知的异常是我们重点关注的,可以做一些邮件通知啥的,已知异常可以再细分一下,可以不同的异常返回不同的返回码:

  1. public class ControllerAOP {

  2.  private static final Logger logger = LoggerFactory.getLogger(ControllerAOP.class);

  3.  public Object handlerControllerMethod(ProceedingJoinPoint pjp) {

  4.    long startTime = System.currentTimeMillis();

  5.    ResultBean<?> result;

  6.    try {

  7.      result = (ResultBean<?>) pjp.proceed();

  8.      logger.info(pjp.getSignature() + "use time:" + (System.currentTimeMillis() - startTime));

  9.    } catch (Throwable e) {

  10.      result = handlerException(pjp, e);

  11.    }

  12.    return result;

  13.  }

  14.  private ResultBean<?> handlerException(ProceedingJoinPoint pjp, Throwable e) {

  15.    ResultBean<?> result = new ResultBean();

  16.    // 已知异常

  17.    if (e instanceof CheckException) {

  18.      result.setMsg(e.getLocalizedMessage());

  19.      result.setCode(ResultBean.FAIL);

  20.    } else {

  21.      logger.error(pjp.getSignature() + " error ", e);

  22.      result.setMsg(e.toString());

  23.      result.setCode(ResultBean.FAIL);

  24.     // 未知异常是应该重点关注的,这里可以做其他操作,如通知邮件,单独写到某个文件等等。

  25.    }

  26.    return result;

  27.  }

  28. }

AOP配置:(关于用java代码还是xml配置,这里我倾向于xml配置,因为这个会不定期改动)

  1. <!-- aop -->

  2.  <aop:aspectj-autoproxy />

  3.  <beans:bean id="controllerAop" class="xxx.common.aop.ControllerAOP" />

  4.  <aop:config>

  5.    <aop:aspect id="myAop" ref="controllerAop">

  6.      <aop:pointcut id="target"

  7.        expression="execution(public xxx.common.beans.ResultBean *(..))" />

  8.      <aop:around method="handlerControllerMethod" pointcut-ref="target" />

  9.    </aop:aspect>

  10.  </aop:config>

现在知道为什么要返回统一的一个ResultBean了:

  • 为了统一格式

  • 为了应用AOP

  • 为了包装异常信息

分页的PageResultBean大同小异,大家自己依葫芦画瓢自己完成就好了。

贴一个简单的controller(左边的箭头表示AOP拦截了)。请对比程序员你为什么这么累?里面原来的代码查看,没有对比就没有伤害。

最后说一句,先有统一的接口定义规范,然后有AOP实现。先有思想再有技术。技术不是关键,AOP技术也很简单,这个帖子的关键点不是技术,而是习惯和思想,不要捡了芝麻丢了西瓜。网络上讲技术的贴多,讲习惯、风格的少,这些都是我工作多年的行之有效的经验之谈,望有缘人珍惜。

觉得有用请点赞加关注,接下来再继续其他规范。敬请期待。

推荐阅读

长按指纹

一键关注

您可能也对以下帖子感兴趣

文章有问题?点此查看未经处理的缓存