查看: 1682|回复: 0

[手机开发] 程序员你为什么这么累? - Controller规范

发表于 2018-5-9 08:00:03

导读:程序员你为什么这么累?

接口定义:程序员你为什么这么累? - 接口定义

第一篇文章中,我贴了2段代码,第一个是原生态的,第2段是我指定了接口定义规范,使用AOP技术之后最终交付的代码,从15行到1行,自己感受一下。今天来说说大家关注的AOP如何实现。

先说说Controller规范,主要的内容是就是接口定义里面的内容,你只要遵循里面的规范,controller就问题不大,除了这些,还有另外的几点:

1 所有函数返回统一的ResultBean/PageResultBean格式

所有函数返回统一的ResultBean/PageResultBean格式,原因见我的接口定义这个贴。没有统一格式,AOP无法玩,更加重要的是前台代码很不好写。当然类名你可以按照自己喜好随便定义,如就叫Result。

大家都知道,前台代码很难写好做到重用,而我们返回相同数据结构后,前台代码可以这样写(方法handlerResult的重用):

  1. // 查询所有配置项记录
  2. function fetchAllConfigs() {
  3. $.getJSON('config/all', function(result) {
  4. handlerResult(result, renderConfigs);
  5. });
  6. }
  7. // 根据id删除配置项
  8. function deleteConfig(id) {
  9. $.post('config/delete', {
  10. id : id
  11. }, function(result) {
  12. console.log('delete result', result);
  13. handlerResult(result, fetchAllConfigs);
  14. });
  15. }
  16. /**
  17. * 后台返回相同的数据结构,前台的代码才好写才能重用
  18. * @param result: ajax返回的结果
  19. * @param fn: 成功的处理函数(传入data)
  20. */
  21. function handlerResult(result, fn) {
  22. // 成功执行操作,失败提示原因
  23. if (result.code == 0) {
  24. fn(result.data);
  25. }
  26. // 没有登陆异常,重定向到登陆页面
  27. else if (result.code == -1) {
  28. showError("没有登录");
  29. }
  30. // 参数校验出错,直接提示
  31. else if (result.code == 1) {
  32. showError(result.msg);
  33. }
  34. // 没有权限,显示申请权限电子流
  35. else if (result.code == 2) {
  36. showError("没有权限");
  37. } else {
  38. // 不应该出现的异常,应该重点关注
  39. showError(result.msg);
  40. }
  41. }
复制代码
2 ResultBean/PageResultBean是controller专用的,不允许往后传! 3 Controller做参数格式的转换,不允许把json,map这类对象传到services去,也不允许services返回json、map。

一般情况下!写过代码都知道,map,json这种格式灵活,但是可读性差,如果放业务数据,每次阅读起来都比较困难。定义一个bean看着工作量多了,但代码清晰多了。

4 参数中一般情况不允许出现Request,Response这些对象

主要是可读性问题。一般情况下不允许,除非要操作流。

5 不需要打印日志

日志在AOP里面会打印,而且我的建议是大部分日志在Services这层打印。

规范里面大部分是 不要做的项多,要做的比较少,落地比较容易。

ResultBean定义带泛型,使用了lombok

  1. @Data
  2. public class ResultBean<T> implements Serializable {
  3. private static final long serialVersionUID = 1L;
  4. public static final int NO_LOGIN = -1;
  5. public static final int SUCCESS = 0;
  6. public static final int FAIL = 1;
  7. public static final int NO_PERMISSION = 2;
  8. private String msg = "success";
  9. private int code = SUCCESS;
  10. private T data;
  11. public ResultBean() {
  12. super();
  13. }
  14. public ResultBean(T data) {
  15. super();
  16. this.data = data;
  17. }
  18. public ResultBean(Throwable e) {
  19. super();
  20. this.msg = e.toString();
  21. this.code = FAIL;
  22. }
  23. }
复制代码

AOP代码,主要就是打印日志和捕获异常,异常要区分已知异常和未知异常,其中未知的异常是我们重点关注的,可以做一些邮件通知啥的,已知异常可以再细分一下,可以不同的异常返回不同的返回码

  1. /**
  2. * 处理和包装异常
  3. */
  4. public class ControllerAOP {
  5. private static final Logger logger = LoggerFactory.getLogger(ControllerAOP.class);
  6. public Object handlerControllerMethod(ProceedingJoinPoint pjp) {
  7. long startTime = System.currentTimeMillis();
  8. ResultBean<?> result;
  9. try {
  10. result = (ResultBean<?>) pjp.proceed();
  11. logger.info(pjp.getSignature() + "use time:" + (System.currentTimeMillis() - startTime));
  12. } catch (Throwable e) {
  13. result = handlerException(pjp, e);
  14. }
  15. return result;
  16. }
  17. private ResultBean<?> handlerException(ProceedingJoinPoint pjp, Throwable e) {
  18. ResultBean<?> result = new ResultBean();
  19. // 已知异常
  20. if (e instanceof CheckException) {
  21. result.setMsg(e.getLocalizedMessage());
  22. result.setCode(ResultBean.FAIL);
  23. } else if (e instanceof UnloginException) {
  24. result.setMsg("Unlogin");
  25. result.setCode(ResultBean.NO_LOGIN);
  26. } else {
  27. logger.error(pjp.getSignature() + " error ", e);
  28. //TODO 未知的异常,应该格外注意,可以发送邮件通知等
  29. result.setMsg(e.toString());
  30. result.setCode(ResultBean.FAIL);
  31. }
  32. return result;
  33. }
  34. }
复制代码

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拦截了)。请对比 程序员你为什么这么累?里面原来的代码查看,没有对比就没有伤害。

controller

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

=============GITHUB地址==============

所有的代码细节都在已经上了github了,地址 xwjie/PLMCodeTemplate,欢迎加星。有问题欢迎提出。

觉得有用请点赞加关注,加星,fork,:)



回复

使用道具 举报