Laravel 项目开发规范 控制器规范

2023-02-16 17:12 更新

资源控制器

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

单数 or 复数?

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

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

错误的例子:

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

保持短小精炼

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

扩展器里的注释

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

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

私有方法

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

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

死方法和注释代码

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

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

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


以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号