應用插件開發(fā)規(guī)范

應用插件要求

• 插件不能包含侵權的代碼、圖標、圖片等
• 插件源碼保證是完整的代碼，且不能加密
• 插件必須是完整的功能，不能是簡單的功能
• 必須提供完整的功能介紹、文檔
• 插件中不建議使用協(xié)程功能，因為用戶可能并沒有開啟協(xié)程

應用插件標識

每個應用插件都有一個唯一標識，這個標識由字母組成。這個標識影響應用插件所在源碼目錄名、類的命名空間、插件數(shù)據(jù)庫表前綴。

假設開發(fā)者以foo為插件標識，那么插件源碼所在目錄為{主項目}/plugin/foo，相應的插件的命名空間為plugin\foo，表前綴為foo_。

由于標識全網(wǎng)唯一，所以開發(fā)者在開發(fā)前需要檢測標識是否可用，檢測地址應用標識檢測。

數(shù)據(jù)庫

• 表名由小寫字母a-z以及下劃線_組成
• 插件數(shù)據(jù)表應該以插件標識為前綴，例如foo插件article表為foo_article
• 表主鍵應該id為索引
• 存儲引擎統(tǒng)一使用innodb引擎
• 字符集統(tǒng)一使用utf8mb4_general_ci
• 數(shù)據(jù)庫ORM使用laravel或者think-orm都可以
• 時間字段建議使用DateTime

代碼規(guī)范

PSR規(guī)范

代碼應符合PSR4加載規(guī)范

類的命名為大寫開頭的駝峰式

<?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
    {

    }
}

注釋

類的屬性以及函數(shù)必須包含注釋，包括概述、參數(shù)、返回類型

縮進

代碼應該使用4個空格符來縮進，而不是使用制表符

流程控制

流程控制關鍵字(if for while foreach等)后面緊跟一個空格，流程控制代碼開始花括號應該與結束圓括號在同一行。

foreach ($users as $uid => $user) {

}

臨時變量名

建議以小寫開頭駝峰式命名(不強制)

$articleCount = 100;