Laravel 項(xiàng)目開發(fā)規(guī)范 控制器規(guī)范

資源控制器

必須 優(yōu)先使用 Restful 資源控制器 。

單數(shù) or 復(fù)數(shù)？

必須 使用資源的復(fù)數(shù)形式，如：

• 類名：PhotosController
• 文件名：PhotosController.php

錯(cuò)誤的例子：

• 類名：PhotoController
• 文件名：PhotoController.php

保持短小精煉

必須 保持控制器文件代碼行數(shù)最小化，還有可讀性。一般來講，一個(gè)方法不應(yīng)該超過 20 行代碼，業(yè)務(wù)邏輯比較多，請(qǐng)封裝到一個(gè) Service 類里。

擴(kuò)展器里的注釋

不應(yīng)該 為「方法」書寫 很明顯的注釋，這要求方法取名要足夠合理，不需要過多注釋。

應(yīng)該 為一些復(fù)雜的邏輯代碼塊書寫注釋，主要介紹產(chǎn)品邏輯 - 為什么要這么做。，最重要的，寫好上下文。

私有方法

不應(yīng)該 在控制器中書寫「私有方法」，控制器里 應(yīng)該 只存放「路由動(dòng)作方法」。

多余的業(yè)務(wù)邏輯，請(qǐng)封裝到 Service 類中。

死方法和注釋代碼

絕不 遺留「死方法」，就是沒有用到的方法，控制器里的所有方法，都應(yīng)該被使用到，否則應(yīng)該刪除。

絕不 在控制器里批量注釋掉代碼，無用的邏輯代碼就必須清除掉。

項(xiàng)目中會(huì)使用 Git 來做版本控制，刪了后面也可以從記錄中找到，無需將這些無用的代碼留在項(xiàng)目中。