编码习惯 - Controller规范

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

 

1 全部函数返回统一的ResultBean/PageResultBean格式

缘由见个人接口定义这个贴。没有统一格式，AOP没法玩。

 

2 ResultBean/PageResultBean是controller专用的，不容许日后传！

 

3 Controller作参数格式的转换，不容许把json，map这类对象传到services去，也不容许services返回json、map。

通常状况下！写过代码都知道，map，json这种格式灵活，可是可读性差，若是放业务数据，每次阅读起来都比较困难。定义一个bean看着工做量多了，但代码清晰多了。

 

4 参数中通常状况不容许出现Request，Response这些对象

主要是可读性问题。通常状况下。

 

5 不须要打印日志

日志在AOP里面会打印，并且个人建议是大部分日志在Services这层打印。

 

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

 

ResultBean定义带泛型，使用了lombok。

@Data
public class ResultBean<T> implements Serializable {

  private static final long serialVersionUID = 1L;

  public static final int NO_LOGIN = -1;

  public static final int SUCCESS = 0;

  public static final int FAIL = 1;

  public static final int NO_PERMISSION = 2;

  private String msg = "success";

  private int code = SUCCESS;

  private T data;

  public ResultBean() {
    super();
  }

  public ResultBean(T data) {
    super();
    this.data = data;
  }

  public ResultBean(Throwable e) {
    super();
    this.msg = e.toString();
    this.code = FAIL;
  }
}

 

AOP代码，主要就是打印日志和捕获异常，异常要区分已知异常和未知异常，其中未知的异常是咱们重点关注的，能够作一些邮件通知啥的，已知异常能够再细分一下，能够不一样的异常返回不一样的返回码：

/**
 * 处理和包装异常
 */
public class ControllerAOP {
  private static final Logger logger = LoggerFactory.getLogger(ControllerAOP.class);

  public Object handlerControllerMethod(ProceedingJoinPoint pjp) {
    long startTime = System.currentTimeMillis();

    ResultBean<?> result;

    try {
      result = (ResultBean<?>) pjp.proceed();
      logger.info(pjp.getSignature() + "use time:" + (System.currentTimeMillis() - startTime));
    } catch (Throwable e) {
      result = handlerException(pjp, e);
    }

    return result;
  }

  private ResultBean<?> handlerException(ProceedingJoinPoint pjp, Throwable e) {
    ResultBean<?> result = new ResultBean();

    // 已知异常
    if (e instanceof CheckException) {
      result.setMsg(e.getLocalizedMessage());
      result.setCode(ResultBean.FAIL);
    } else if (e instanceof UnloginException) {
      result.setMsg("Unlogin");
      result.setCode(ResultBean.NO_LOGIN);
    } else {
      logger.error(pjp.getSignature() + " error ", e);
      //TODO 未知的异常，应该格外注意，能够发送邮件通知等
      result.setMsg(e.toString());
      result.setCode(ResultBean.FAIL);
    }

    return result;
  }
}

 

AOP配置：(关于用java代码仍是xml配置，这里我倾向于xml配置，由于这个会不按期改动)

<!-- aop -->
  <aop:aspectj-autoproxy />
  <beans:bean id="controllerAop" class="xxx.common.aop.ControllerAOP" />
  <aop:config>
    <aop:aspect id="myAop" ref="controllerAop">
      <aop:pointcut id="target"
        expression="execution(public xxx.common.beans.ResultBean *(..))" />
      <aop:around method="handlerControllerMethod" pointcut-ref="target" />
    </aop:aspect>
  </aop:config>

 

如今知道为何要返回统一的一个ResultBean了：

• 为了统一格式
• 为了应用AOP
• 为了包装异常信息

分页的PageResultBean大同小异，你们本身依葫芦画瓢本身完成就行了。

 

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

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