一号俐、基本約定
1师枣、源文件
（1）、純PHP代碼源文件只使用 <?php 標(biāo)簽萧落，省略關(guān)閉標(biāo)簽 ?> 洗贰；
（2）敛滋、源文件中PHP代碼的編碼格式必須是無BOM的UTF-8格式；
（3）兴革、使用 Unix LF(換行符)作為行結(jié)束符绎晃；
（4）杂曲、一個源文件只做一種類型的聲明庶艾，即，這個文件專門用來聲明Class, 那個文件專門用來設(shè)置配置信息擎勘，別混在一起寫；
2煤裙、縮進
使用Tab鍵來縮進噪漾，每個Tab鍵長度設(shè)置為4個空格欣硼；
3、行
一行推薦的是最多寫120個字符诈胜，多于這個字符就應(yīng)該換行了耘斩，一般的編輯器是可以設(shè)置的桅咆。
4岩饼、關(guān)鍵字 和 True/False/Null
PHP的關(guān)鍵字，必須小寫版述，boolean值：true渴析，false晚伙，null 也必須小寫咆疗。
下面是PHP的“關(guān)鍵字”母债，必須小寫：
'__halt_compiler', 'abstract', 'and', 'array', 'as', 'break', 'callable', 'case', 'catch', 'class', 'clone', 'const', 'continue', 'declare', 'default', 'die', 'do', 'echo', 'else', 'elseif', 'empty', 'enddeclare', 'endfor', 'endforeach', 'endif', 'endswitch', 'endwhile', 'eval', 'exit', 'extends', 'final', 'for', 'foreach', 'function', 'global', 'goto', 'if', 'implements', 'include', 'include_once', 'instanceof', 'insteadof', 'interface', 'isset', 'list', 'namespace', 'new', 'or', 'print', 'private', 'protected', 'public', 'require', 'require_once', 'return', 'static', 'switch', 'throw', 'trait', 'try', 'unset', 'use', 'var', 'while', 'xor'
5毡们、命名
（1）衙熔、類名 使用大駝峰式（StudlyCaps）寫法；
（2）挺据、（類的）方法名 使用小駝峰（cameCase）寫法扁耐；
（3）产阱、函數(shù)名使用 小寫字母 + 下劃線 寫法构蹬，如 function http_send_post()；
（4）俗壹、變量名 使用小駝峰寫法绷雏，如 $userName怖亭；
6兴猩、代碼注釋標(biāo)簽
如 函數(shù)注釋、變量注釋等讨勤，常用標(biāo)簽有 <u>@package</u>潭千、<u>@var</u>、<u>@param</u>逝段、<u>@return</u>奶躯、<u>@author</u>亿驾、<u>@todo</u>莫瞬、<u>@throws</u>
必須遵守 phpDocument 標(biāo)簽規(guī)則疼邀，不要另外去創(chuàng)造新的標(biāo)簽，更多標(biāo)簽查看 <u>phpDocument官網(wǎng)</u>
7获询、業(yè)務(wù)模塊
（1）吉嚣、涉及到多個數(shù)據(jù)表 更新/添加 操作時蹬铺，最外層要用事務(wù)甜攀，保證數(shù)據(jù)庫操作的原子性赴邻；
（2）、Model層彤敛，只做簡單的數(shù)據(jù)表的查詢墨榄；
（3）袄秩、業(yè)務(wù)邏輯統(tǒng)一封裝到 Logic層之剧；
（4）、控制器只做URL路由贰军，不要當(dāng)作 業(yè)務(wù)方法 調(diào)用词疼；
（5）帘腹、控制器層不能出現(xiàn)SQL操作語句阳欲，如 ThinkPHP框架的 where()胸完、order() 等模型方法，
即爆惧，控制器中扯再，不要出現(xiàn)類似這樣的SQL語句：D('XXX')->where()->order()->limit()->find();
where()址遇、order()倔约、limit() 等SQL方法只能出現(xiàn)在 Model層、業(yè)務(wù)層鳄袍！
二吏恭、代碼樣式風(fēng)格
1樱哼、命名空間(Namespace) 和 導(dǎo)入(Use)聲明
先簡單文字描述下：
命名空間(namespace)的聲明后面必須有一行空行；
所有的導(dǎo)入(use)聲明必須放在命名空間(namespace)聲明的下面勾栗；
一句聲明中围俘，必須只有一個導(dǎo)入(use)關(guān)鍵字界牡；
在導(dǎo)入(use)聲明代碼塊后面必須有一行空行漾抬；
用代碼來說明下：
|
1
2
3
4
5
6
|
<?php
namespace Lib\Databases; // 下面必須空格一行
class Mysql {
}
|
namespace下空一行纳令，才能使用use平绩，再空一行捏雌，才能聲明class
|
1
2
3
4
5
6
7
8
9
10
|
<?php
namespace Lib\Databases; // 下面必須空格一行
use FooInterface; // use 必須在namespace 后面聲明
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass; // 下面必須空格一行
class Mysql {
}
|
2、類(class)纬傲，屬性(property)和方法(method)
（1）、繼承(extends) 和實現(xiàn)(implement) 必須和 class name 寫在一行。
|
1
2
3
4
5
6
|
<?php
namespace Lib\Databaes;
class Mysql extends ParentClass implements \PDO, \DB { // 寫一行
}
|
（2）祟牲、屬性(property)必須聲明其可見性，到底是 public 還是 protected 還是 private，不能省略袁翁，也不能使用var, var是php老版本中的什么方式，等用于public。
|
1
2
3
4
5
6
7
8
|
<?php
namespace Lib\Databaes;
class Mysql extends ParentClass implements \PDO, \DB { // 寫一行
public $foo = null;
private $name = 'yangyi';
protected $age = '17';
}
|
（3）、方法(method)，必須 聲明其可見性绰沥，到底是 public 還是 protected 還是 private麸塞，不能省略甜刻。如果有多個參數(shù)，第一個參數(shù)后緊接“,” ，再加一個空格：function_name (par2, $pa3), 如果參數(shù)有默認值蜕径，“=”左右各有一個空格分開梦染。
|
1
2
3
4
5
6
7
8
|
<?php
namespace Lib\Databaes;
class Mysql extends ParentClass implements \PDO, \DB { // 寫一行
public getInfo($name, $age, $gender = 1) { // 參數(shù)之間有一個空格。默認參數(shù)的“=”左右各有一個空格，) 與 { 之間有一個空格
}
}
|
（4）、當(dāng)用到抽象(abstract)和終結(jié)(final)來做類聲明時，它們必須放在可見性聲明 （public 還是protected還是private）的前面巍举。而當(dāng)用到靜態(tài)(static)來做類聲明時梦皮，則必須放在可見性聲明的后面剑肯。
直接上代碼：
|
1
2
3
4
5
6
7
8
9
10
11
|
<?php
namespace Vendor\Package;
abstract class ClassName {
protected static $foo; // static放后面
abstract protected function zim(); // abstract放前面
final public static function bar() { // final放前面溃睹，static放最后泞辐。
// 方法主體部分
}
}
|
3、控制結(jié)構(gòu)
控制接口厢塘，就是 if else while switch等牍颈。這一類的寫法規(guī)范也是經(jīng)常容易出現(xiàn)問題的，也要規(guī)范一下画机。
（1）徒爹、if，elseif泡躯，else寫法，直接上規(guī)范代碼吧：
|
1
2
3
4
5
6
7
8
|
<?php
if ($expr1) { // if 與 ( 之間有一個空格，) 與 { 之間有一個空格
} elseif ($expr2) { // elesif 連著寫弓颈，與 ( 之間有一個空格，) 與 { 之間有一個空格
} else { // else 左右各一個空格
}
|
（2）、switch控硼，case 注意空格和換行缚够，還是直接上規(guī)范代碼：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
<?php
switch ($expr) { // switch 與 ( 之間有一個空格误堡，) 與 { 之間有一個空格
case 0:
echo 'First case, with a break'; // 對齊
break; // 換行寫break，也對齊。
case 1:
echo 'Second case, which falls through';
// no break
case 2:
case 3:
case 4:
echo 'Third case, return instead of break';
return;
default:
echo 'Default case';
break;
}
|
（3）、while媳否，do while 的寫法也是類似步绸，上代碼：
|
1
2
3
4
5
6
7
8
|
<?php
while ($expr) { // while 與 ( 之間有一個空格赘那， ) 與 { 之間有一個空格
}
do { // do 與 { 之間有一個空格
} while ($expr); // while 左右各有一個空格
|
（4）、for的寫法
|
1
2
3
4
|
<?php
for (i < 10; $i++) { // for 與 ( 之間有一個空格，二元操作符 "="呢灶、"<" 左右各有一個空格隧期，) 與 { 之間有一個空格
}
|
（5）、foreach的寫法
|
1
2
3
4
|
<?php
foreach (key => $value) { // foreach 與 ( 之間有一個空格性置，"=>" 左右各有一個空格，) 與 { 之間有一個空格
}
|
（6）、try catch的寫法
|
1
2
3
4
5
6
7
8
|
<?php
try { // try 右邊有一個空格
} catch (FirstExceptionType $e) { // catch 與 ( 之間有一個空格，) 與 { 之間有一個空格
} catch (OtherExceptionType $e) { // catch 與 ( 之間有一個空格式塌，) 與 { 之間有一個空格
}
|
4收恢、注釋
（1）链沼、行注釋
// 后面需要加一個空格曲掰；
如果 // 前面有非空字符栏妖，則 // 前面需要加一個空格；
（2）、函數(shù)注釋
參數(shù)名岩榆、屬性名、標(biāo)簽的文本 上下要對齊；
在第一個標(biāo)簽前加一個空行；
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
<?php
/**
This is a sample function to illustrate additional PHP
formatter options.
@param $one The first parameter
@param int $two The second parameter
@param string $three The third parameter with a longer
comment to illustrate wrapping.@return void
@author 52php.cnblogs.com
@license GPL
*/
function foo(two = 0, $three = "String") {
}
|
5函筋、空格
（1）首懈、賦值操作符（=滤否，+= 等）、邏輯操作符（&&，||）、等號操作符（==浙宜，!=）称开、關(guān)系運算符（<扶镀，>昆雀，<=，>=）、按位操作符（&智亮，|，^）、連接符（.） 左右各有一個空格遭笋；
（2）测暗、if，else饲宿，elseif昌讲，while，do窄驹，switch乐埠，for豪治，foreach负拟，try掩浙，catch秸歧，finally 等 與 緊挨的左括號“(”之間有一個空格键菱；
（3）经备、函數(shù)侵蒙、方法的各個參數(shù)之間，逗號（","）后面有一個空格算凿；
6、空行
（1）波桩、所有左花括號 { 都不換行镐躲，并且 ｛ 緊挨著的下方萤皂，一定不是空行裆熙；
（2）入录、同級代碼（縮進相同）的 注釋（行注釋/塊注釋）前面僚稿，必須有一個空行；
（3）缅刽、各個方法/函數(shù) 之間有一個空行衰猛；
（4）啡省、namespace語句冕杠、use語句分预、clase語句 之間有一個空行薪捍；
（5）、return語句
如果 return 語句之前只有一行PHP代碼凳干，return 語句之前不需要空行救赐；
如果 return 語句之前有至少二行PHP代碼只磷，return 語句之前加一個空行钮追；
（5）、if轧叽，while，switch待逞，for识樱，foreach牺荠、try 等代碼塊之間 以及 與其他代碼之間有一個空行驴一；
【參考示例 匯總】
參考1：
|
1
2
3
4
5
6
7
8
|
<?php
namespace Lib\Databaes;
class Mysql extends ParentClass implements \PDO, \DB { // 寫一行
public getInfo($name, $age, $gender = 1) { // 參數(shù)之間有一個空格肝断。默認參數(shù)的“=”左右各有一個空格胸懈，) 與 { 之間有一個空格
}
}
|
參考2:
|
1
2
3
4
5
6
7
8
9
10
11
|
<?php
namespace Vendor\Package;
abstract class ClassName {
protected static $foo; // static放后面
abstract protected function zim(); // abstract放前面
final public static function bar() { // final放前面趣钱，static放最后首有。
// 方法主體部分
}
}
|
參考3：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
|
<?php
namespace library\Model;
use library\Helper\ImageHelper;
use library\Logic\UserMainLogic;
/**
用戶表 數(shù)據(jù)模型
@package library\Model
*/
class UserMainModel extends BasicModel {
/**
* 獲得用戶統(tǒng)計信息
*
* @param int $userId 用戶ID
* @return array
*/
public function getUserCard($userId) {
$userId = intval($userId);
return UserMainLogic::instance()->getUserCard($userId);
}
/**
* 根據(jù)Id 獲取用戶信息
*
* @param int $userId 用戶Id
* @param string $field 顯示字段
* @return array
*/
public function getByUserId($userId = 0, $field = '*') {
if (empty($userId)) {
return array();
}
$where = array('id' => $userId);
$info = $this->field($field)->where($where)->find();
if (isset($info['image']) && isset($info['sex'])) {
$info['image'] = ImageHelper::GetImageUrl($info['image'], $info['sex']);
}
return $info;
}
}
|
參考4：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
|
$serv = new swoole_server("127.0.0.1", 9502);
// sets server configuration, we set task_worker_num config greater than 0 to enable task workers support
$serv->set(array('task_worker_num' => 4));
// attach handler for receive event, which have explained above.
serv,
from_id, $data) {
// we dispath a task to task workers by invoke the task() method of $serv
// this method returns a task id as the identity of ths task
$task_id = $serv->task($data);
echo "Dispath AsyncTask: id=$task_id\n";
});
// attach handler for task event, the handler will be executed in task workers.
serv,
from_id, $data) {
// handle the task, do what you want with $data
echo "New AsyncTask[id=$task_id]".PHP_EOL;
// after the task task is handled, we return the results to caller worker.
$serv->finish("$data -> OK");
});
// attach handler for finish event, the handler will be executed in server workers, the same worker dispatched this task before.
serv,
data) {
echo "AsyncTask[$task_id] Finish: $data".PHP_EOL;
});
$serv->start();
|
[圖片上傳失敗...(image-e136e3-1587193343840)]
總結(jié)：所有左花括號 { 都不換行，并且 ｛ 緊挨著的下方轴捎，一定不是空行侦副！
上面的 代碼樣式規(guī)范蝗锥，參考了 Java终议、JavaScript穴张、Objective-C皂甘、Go 等開發(fā)語言的規(guī)范！
Java語言對中國程序員影響太深璧瞬，大部分人還是習(xí)慣把 左花括號 **{ **不換行嗤锉！
書寫原則：做到 代碼緊湊 而又不失 小模塊化 墓塌！
PSR-4 規(guī)范
PSR-4規(guī)范是剛出沒多久的一條新的規(guī)范苫幢，它也是規(guī)范 自動加載(autoload)的，是對PSR-0的修改触菜，屬于補充規(guī)范涡相，
我簡單說下谜诫，主要是以下幾點：
廢除了PSR-0中就是目錄分割符的寫法喻旷，下劃線在完全限定類名中是沒有特殊含義了且预。
類文件名要以 .php 結(jié)尾。
類名必須要和對應(yīng)的文件名要一模一樣遍尺，大小寫也要一模一樣乾戏。
【補充】數(shù)組 的書寫格式
只有一個鍵值對時鼓择，就寫成一行：
|
1
|
$where = array('id' => 789);
|
有多個（二個或二個以上）鍵值對時，就換行：
|
1
2
3
4
|
$where = array(
'id' => 789,
'user_name' => '52php'
);
|
