资源控制器

必须 优先使用 Restful 资源控制器

单数或复数?

必须 使用资源的单数形式,如:

  • 类名:PhotoController
  • 文件名:PhotoController.php

错误的例子:

  • 类名:PhotosController
  • 文件名:PhotosController.php

保持短小精炼

必须 保持控制器文件代码行数最小化,还有可读性。

  • 不应该 为「方法」书写注释,这要求方法取名要足够合理,不需要过多注释;
  • 应该 为一些复杂的逻辑代码块书写注释,主要介绍产品逻辑 - 为什么要这么做
  • 不应该 在控制器中书写「私有方法」,控制器里 应该 只存放「路由动作方法」;
  • 绝不 遗留「死方法」,就是没有用到的方法,控制器里的所有方法,都应该被使用到,否则应该删除;
  • 绝不 在控制器里批量注释掉代码,无用的逻辑代码必须清除掉。