群友总结的一点Controller规范

Controller规范

我见过很多同事除了代码对不齐，还存在 Service 层掉 Controller，甚至是 Dao 层掉用 Controller。除此之外，Controller 还经常会存在一大堆业务逻辑。

基于此，我们一起来说说 Controller 使用的规范，不喜轻喷！

统一返回 ResultBean 对象

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

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

// 查询所有配置项记录
function fetchAllConfigs() {
  $.getJSON('config/all', function(result) {
    handlerResult(result, renderConfigs);
  });
}

// 根据id删除配置项
function deleteConfig(id) {
  $.post('config/delete', {
    id : id
  }, function(result) {
    console.log('delete result', result);
    handlerResult(result, fetchAllConfigs);
  });
}

/**
  * 后台返回相同的数据结构，前台的代码才好写才能重用
  * @param result：ajax返回的结果
  * @param fn： 成功的处理函数（传入data）
  */
function handlerResult(result, fn) {
  // 成功执行操作，失败提示原因
  if (result.code == 0) {
    fn(result.data);
  }
  // 没有登陆异常，重定向到登陆页面
  else if (result.code == -1) {
    showError("没有登录");
  }
  // 参数校验出错，直接提示
  else if (result.code == 1) {
    showError(result.msg);
  }
  // 没有权限，显示申请权限电子流
  else if (result.code == 2) {
    showError("没有权限"); 
  } else {
    // 不应该出现的异常，应该重点关注
    showError(result.msg);
  }
}

ResultBean 不允许往后传

ResultBean/PageResultBean 是 controller 专用的，不允许往后传！往其他地方传之后，可读性立马下降，和传 map，json 好不了多少。

Controller 只做参数格式的转换

Controller 做参数格式的转换，不允许把 json，map 这类对象传到 services去，也不允许 services 返回 json、map。写过代码都知道，map，json 这种格式灵活，但是可读性差（编码一时爽，重构火葬场）。如果放业务数据，每次阅读起来都十分困难，需要从头到尾看完才知道里面有什么，是什么格式。定义一个 bean 看着工作量多了，但代码清晰多了。

参数不允许出现 Request，Response 这些对象

和 json/map 一样，主要是可读性差的问题。一般情况下不允许出现这些参数，除非要操作流。

日志打印

日志尽量在 AOP 里面打印，或在 Services 层打印。

Contorller 只做参数格式转换和部分参数校验，部分权限判断（通用注解实现最好）。日志建议放到 service 里面，毕竟 controller 层代码可重用的不多，而 service 重用较多。而我们的单元测试重点是测试 service 层。

下面列举一些常见使用错误的案例。

返回格式不统一

同一个接口，有时候返回数组，有时候返回单个；成功的时候返回对象，失败的时候返回错误信息字符串。工作中有个系统集成就是这样定义的接口，真是辣眼睛。这个对应代码上，返回的类型是 map，json，object，都是不应该的。实际工作中，我们会定义一个统一的格式，就是 ResultBean，分页的有另外一个 PageResultBean。

错误范例：

//返回map可读性不好，尽量不要
  @PostMapping("/delete")
  public Map<String, Object> delete(long id, String lang) {

  }

  // 成功返回boolean，失败返回string，大忌
  @PostMapping("/delete")
  public Object delete(long id, String lang) {
    try {
      boolean result = configService.delete(id, local);
      return result;
    } catch (Exception e) {
      log.error(e);
      return e.toString();
    }
  }

没有考虑失败情况

一开始只考虑成功场景，等后面测试发现有错误情况，怎么办，改接口呗，前后台都改，劳民伤财无用功。

错误范例：

//不返回任何数据，没有考虑失败场景，容易返工
 @PostMapping("/update")
  public void update(long id, xxx) {

  }

出现和业务无关的输入参数

如 lang 语言，当前用户信息 都不应该出现参数里面，应该从当前会话里面获取。除了代码可读性不好问题外，尤其是参数出现当前用户信息的，这是个严重问题。

错误范例：

 // （当前用户删除数据）参数出现lang和userid，尤其是userid，大忌
 @PostMapping("/delete")
  public Map<String, Object> delete(long id, String lang, String userId) {
  }

出现复杂的输入参数

一般情况下，不允许出现例如 json 字符串这样的参数，这种参数可读性极差。应该定义对应的 bean。

错误范例：

// 参数出现json格式，可读性不好，代码也难看
@PostMapping("/update")
public Map<String, Object> update(long id, String jsonStr) {

}

没有返回应该返回的数据

例如，新增接口一般情况下应该返回新对象的 id 标识，这需要编程经验。新手定义的时候因为前台没有用就不返回数据或者只返回 true，这都是不恰当的。别人要不要是别人的事情，你该返回的还是应该返回。

错误范例：

// 约定俗成，新建应该返回新对象的信息，只返回boolean容易导致返工
 @PostMapping("/add")
  public boolean add(xxx) {
    //xxx
    return configService.add();
  }

估计很多人看了这篇文章都觉得里面的技术也很简单，没有什么特别的地方，但是，实现这个代码框架之前，就是要你的接口的统一的格式 ResultBean，aop 才好做。有些人误解了，说规范不重要，技术才重要。我这篇重点说的是编码习惯工作方式，如果你重点还是放在什么技术上，那本文帮不了你进步。