應用插件開發規範
應用插件要求
- 插件不能包含侵權的程式碼、圖示、圖片等
- 插件原始碼保證是完整的程式碼,且不能加密
- 插件必須是完整的功能,不能是簡單的功能
- 必須提供完整的功能介紹、文檔
- 插件中不建議使用協程功能,因為用戶可能並沒有開啟協程
應用插件標識
每個應用插件都有一個唯一標識,這個標識由字母組成。這個標識影響應用插件所在原始碼目錄名、類的命名空間、插件資料庫表前綴。
假設開發者以foo為插件標識,那麼插件原始碼所在目錄為{主專案}/plugin/foo
,相應的插件的命名空間為plugin\foo
,表前綴為foo_
。
由於標識全網唯一,所以開發者在開發前需要檢測標識是否可用,檢測地址應用標識檢測。
資料庫
- 表名由小寫字母
a-z
以及下劃線_
組成 - 插件資料表應該以插件標識為前綴,例如foo插件article表為
foo_article
- 表主鍵應該id為索引
- 儲存引擎統一使用innodb引擎
- 字符集統一使用utf8mb4_general_ci
- 資料庫ORM使用laravel或者think-orm都可以
- 時間字段建議使用DateTime
程式碼規範
PSR規範
程式碼應符合PSR4加載規範
類的命名為大寫開頭的駝峰式
<?php
namespace plugin\foo\app\controller;
class ArticleController
{
}
類的屬性及方法以小寫開頭駝峰式
<?php
namespace plugin\foo\app\controller;
class ArticleController
{
/**
* 不需要驗權的方法
* @var array
*/
protected $noNeedAuth = ['getComments'];
/**
* 獲得評論
* @param Request $request
* @return Response
* @throws BusinessException
*/
public function getComments(Request $request): Response
{
}
}
註解
類的屬性以及函數必須包含註解,包括概述、參數、返回類型
縮進
程式碼應該使用4個空格符來縮進,而不是使用製表符
流程控制
流程控制關鍵字(if for while foreach等)後面緊跟一個空格,流程控制程式碼開始大括號應該與結束圓括號在同一行。
foreach ($users as $uid => $user) {
}
臨時變數名
建議以小寫開頭駝峰式命名(不強制)
$articleCount = 100;