個人專案開發規範

張無忌發表於2019-08-06

路由設計規範，參考了restful API的設計規範

對於資源的具體操作型別，由 HTTP 動詞表示。常用的 HTTP 動詞有下面五個。
  • GET（SELECT）：從伺服器取出資源（一項或多項）。
  • POST（CREATE）：在伺服器新建一個資源。
  • PUT（UPDATE）：在伺服器更新資源（客戶端提供改變後的完整資源）。
  • PATCH（UPDATE）：在伺服器更新資源（客戶端提供改變的屬性）。
  • DELETE（DELETE）：從伺服器刪除資源。

所有 URL 必須 是全小寫,所有的路由都要用name

 Route::get('user/create','UserController@create')->name('admin.user.create');

檢視的設計規範

我們常用的後臺模板一般都是layui搭建的，有iframe和單頁面版，大多模板裡面的一些方法都是大差不差的

  • 一個模板一個資料夾

  • 對資料的操作一般都是增刪改查，資料的提交一般都在form表單裡,檢視檔案裡基本應有create,edit,index,_form檢視檔案

  • create:create.blade.php 用於建立頁面

  • edit:edit.blade.php 用於編輯頁面

  • _form:_form.balde.php 編輯和建立一般有交叉，避免重複造輪子，應該提取公共頁面放在_form頁面下供二者引用。

  • index:index.blade.php 頁面主資料展示

常遇到的情況，舉個例子，一個是開啟create頁面的請求，一個是create資料的請求,其中的路由規範如下：

路由採用reseful API的設計規範

        Route::get('member/create', 'MemberController@create')->name('admin.member.create');
        Route::post('member/store', 'MemberController@store')->name('admin.member.store');

ORM的設計規範

框架的ORM只單純的做模型關聯使用,另外新建Repsitory層做資料庫的邏輯處理,

Repsitory的命名採用駝峰法命令規範，比如

<?php
namespace App\Repository\Admin;
use App\Models\User;

class UserRepository {

Controller的設計規範

  • 資料驗證在request層進行處理，保證進行控制器的資料是乾淨的。
  • 對於資料的處理則呼叫對應的Repsitory層處理，控制器只做響應和返回對應的資料。

待續。。。。

本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章