编码习惯之Controller规范

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

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

原因见我的接口定义这个贴。没有统一格式，AOP无法玩。

• ResultBean/PageResultBean是controller专用的，不允许往后传！

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

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

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

主要是可读性问题。一般情况下。

• 不需要打印日志

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

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

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

编码习惯之Controller规范

 

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 {

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

     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技术也很简单

总结Controller:

用来校验参数封装参数到service

处理异常

返回参数格式最好一致

controller常见的返回对象类型

1.VO类

它是最规范的方式,因为数据库中的一些字段不需要暴露给前端或者需要处理后暴露给前端,这时候我们就需要VO封装处理后的数据,但是又不少业务VO的字段与DAO的字段一样,这样就会增加我们的编码量
2.直接返回entity对象
这种方式直接把数据库中的字段返回给了前端安全性不高, 而且有些数据需要我们处理后返回给前端显示这种方式不方便我们处理数据
3.返回Map
这种方式非常灵活,可以方便组织对象,缺点是编码量大操作map容易出错