控制器规范

未匹配的标注

资源控制器

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

单数 or 复数?

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

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

错误的例子:

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

保持短小精炼

必须 保持控制器文件代码行数最小化,还有可读性。一般来讲,一个方法不应该超过 20 行代码,业务逻辑比较多,请封装到一个 Service 类里。

扩展器里的注释

不应该 为「方法」书写 很明显的注释,这要求方法取名要足够合理,不需要过多注释。

应该 为一些复杂的逻辑代码块书写注释,主要介绍产品逻辑 - 为什么要这么做。,最重要的,写好上下文。

私有方法

不应该 在控制器中书写「私有方法」,控制器里 应该 只存放「路由动作方法」。

多余的业务逻辑,请封装到 Service 类中。

死方法和注释代码

绝不 遗留「死方法」,就是没有用到的方法,控制器里的所有方法,都应该被使用到,否则应该删除。

绝不 在控制器里批量注释掉代码,无用的逻辑代码就必须清除掉。

项目中会使用 Git 来做版本控制,删了后面也可以从记录中找到,无需将这些无用的代码留在项目中。

本文章首发在 LearnKu.com 网站上。

上一篇 下一篇
《L05 电商实战》
从零开发一个电商项目,功能包括电商后台、商品 & SKU 管理、购物车、订单管理、支付宝支付、微信支付、订单退款流程、优惠券等
《L03 构架 API 服务器》
你将学到如 RESTFul 设计风格、PostMan 的使用、OAuth 流程,JWT 概念及使用 和 API 开发相关的进阶知识。
贡献者:1
讨论数量: 2
发起讨论 只看当前版本


Kuper
控制器的名称必须使用复数形式 ?
0 个点赞 | 4 个回复 | 问答 | 课程版本 5.5
ccccccccccc
例如模型,表单验证器都需要基类,而控制器不用呢?
0 个点赞 | 0 个回复 | 问答 | 课程版本 5.5