PHP編碼規范

整理自 PHP 標準規范

作為程序員來說,采用統一的編碼風格是非常重要的。這將給未來代碼的編寫、閱讀節省大量時間。這里整理一份自己的 PHP 編碼規范。

動詞說明:
  • 必須:嚴格遵守;
  • 禁止:一定不能這樣做;
  • 應該:強烈建議這樣做,但不強求;
  • 不該:強烈建議不這樣做,但不強求;
  • 可以:選擇性高一點。
一、基本代碼規范
  1. 概覽
  • PHP 代碼 必須<?php 標簽開始;
  • PHP 代碼文件 必須 以不帶 BOM 的 UTF-8 編碼;
  • PHP 代碼中 應該 只定義類、函數、常量等聲明,或其他會產生「副作用」的操作(如:生成文件輸出以及修改 .ini 配置文件等),二者只能選其一;
  • 命名空間以及類 必須 符合 PSR 的自動加載規范:PSR-4 中的一個;
  • 類的命名 必須 遵循 StudlyCaps 大寫 開頭的駝峰命名規范;
  • 類中的常量所有字母都 必須 大寫,單詞間用下劃線分隔;
  • 方法名稱 必須 符合 camelCase 式的小寫開頭駝峰命名規范。
  1. 文件
    2.1 PHP 標簽及 PHP 代碼 必須 使用 <?php ?> 長標簽; 禁止 使用 <?= ?> 短輸出標簽,或其它自定義標簽。
    2.2 字符編碼 PHP 代碼 必須 且只可使用不帶 BOM 的 UTF-8 編碼。
    2.3 副作用,一份 PHP 文件中 應該 要不就只定義新的聲明,如類、函數或常量等不產生「副作用」的操作,要不就只書寫會產生「副作用」的邏輯操作,但 不該 同時具有兩者。

「副作用」(side effects) 一詞的意思是,僅僅通過包含文件,不直接聲明類、函數和常量等,而執行的邏輯操作。 「副作用」包含卻不僅限于: 生成輸出 直接的 require 或 include 連接外部服務 修改 ini 配置 拋出錯誤或異常 修改全局或靜態變量 讀或寫文件等。

以下是一個反例,一份包含「函數聲明」以及產生「副作用」的代碼:

<?php 
// 「副作用」:修改 ini 配置 
ini_set('error_reporting', E_ALL);  

// 「副作用」:引入文件 
include "file.php";  

// 「副作用」:生成輸出 
echo "\n";  

// 聲明函數
function foo() { 
      // 函數主體部分 
}

下面是一個正確的范例,一份只包含聲明不產生「副作用」的代碼:

<?php 
// 聲明函數 
function foo() { 
      // 函數主體部分 
}

// 條件聲明 屬于「副作用」

if (!function_exists('bar')) {
      function bar() {
          // 函數主體部分 
      }
} 
  1. 命名空間和類
    3.1命名空間以及類的命名 必須 遵循 PSR-4 規范。 根據規范,每個類都獨立為一個文件,且命名空間至少有一個層次:頂級的組織名稱(vendor name)。
    3.2 類的命名 必須 遵循 StudlyCaps 大寫開頭的駝峰命名規范。 PHP 5.3 及以后版本的代碼 必須 使用正式的命名空間。
    例如:
<?php 
// PHP 5.3及以后版本的寫法 
namespace Vendor\Model;

class Foo { } 
  1. 類的常量、屬性和方法(此處的「類」指代所有的類、接口以及可復用代碼塊(traits))。
    4.1 常量,類的常量中所有字母都 必須 大寫,詞間以下劃線分隔。
    4.2 屬性,類屬性 應該 統一小寫開頭的駝峰式 ($camelCase),修飾符 public、protected、private 必須 加上。
    4.3 方法,方法名稱 必須 符合 camelCase() 式的小寫開頭駝峰命名規范,修飾符 public、protected、private 必須 加上。
    示例:
<?php
namespace Vendor\Model;

class Foo
{
      const VERSION = '1.0';
      const DATE_APPROVED = '2012-06-01';

      public $camelCase1;
      protected $camelCase2;
      private $camelCase3;

      public function camelCase()
      { 
           // do something ...
      }
}
二、編碼風格規范
  1. 概覽
  • 代碼 必須 遵循基本代碼規范;
  • 代碼 必須 使用4個空格符而不是「Tab 鍵」進行縮進;
  • 每行的字符數 應該 軟性保持在 80 個之內,理論上 禁止 多于 120 個,但同時 **禁止 **有硬性限制;
  • 每個 namespace 命名空間聲明語句和 use 聲明語句塊后面,必須 插入一個空白行;
  • 類的開始花括號 { 必須 寫在函數聲明后自成一行,結束花括號 }必須 寫在函數主體后自成一行;
  • 方法的開始花括號 { 必須 寫在函數聲明后自成一行,結束花括號 }必須 寫在函數主體后自成一行;
  • 類的屬性和方法 必須 添加訪問修飾符(private、protected 以及 public),abstract 以及 final 必須 聲明在訪問修飾符之前,而 static 必須 聲明在訪問修飾符之后;
  • 控制結構的關鍵字后 必須 要有一個空格符,而調用方法或函數時則 禁止 加空格符;
  • 控制結構的開始花括號 { 必須 寫在聲明的同一行,而結束花括號 } 必須 寫在主體后自成一行;
  • 控制結構的開始左括號后和結束右括號前,都 禁止 有空格符。

1.1 示例,以下例子程序簡單地展示了以上大部分規范:

<?php
namespace Vendor\Package;

use FooInterface;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;

class Foo extends Bar implements FooInterface
{

      public function sampleFunction($a, $b = null)
      {
          if ($a === $b) {
               bar();
          } elseif ($a > $b) {
               $foo->bar($arg1);
          } else {
              BazClass::bar($arg2, $arg3);
          }
      }

      final public static function bar()
      {
          // 方法的內容
      }

}
  1. 通則
    2.1 基本編碼準則
    代碼 必須 符合 基本代碼規范

2.2 文件
所有 PHP 文件 必須 以一個空白行作為結束。 純 PHP 代碼文件 必須 省略最后的 ?> 結束標簽。

2.3 行
行的長度 禁止 有硬性的約束,軟性的長度約束 應該 要限制在 120 個字符以內。
非空行后 禁止 有多余的空格符。
每行 禁止 存在多于一條語句。

2.4 縮進
代碼 必須 使用 4 個空格符的縮進,禁止 用 tab 鍵。

備注:使用空格而不是「tab鍵縮進」的好處在于, 避免在比較代碼差異、打補丁、重閱代碼以及注釋時產生混淆。 并且,使用空格縮進,讓對齊變得更方便。

2.5 關鍵字以及 True/False/Null
PHP 所有關鍵字 必須 全部小寫。
常量 true 、false 和 null 也 **必須 ** 全部小寫。

  1. namespace 以及 use 聲明
    namespace 聲明后 必須 插入一個空白行。
    所有 use 必須 在 namespace 后聲明。
    每條 use 聲明語句 必須 只有一個 use 關鍵詞。
    use 聲明語句塊后 必須 要有一個空白行。
    示例:
<?php
namespace Vendor\Package;

use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;

// ... 更多的 PHP 代碼在這里 ...
  1. 類、屬性和方法
    此處的「類」泛指所有的「class類」、「接口」以及「traits 可復用代碼塊」。

4.1 擴展與繼承
關鍵詞 extends 和 implements 必須 寫在類名稱的同一行。
類的開始花括號 必須 獨占一行,結束花括號也 必須 在類主體后獨占一行。

<?php
namespace Vendor\Package;

use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;

class ClassName extends ParentClass implements \ArrayAccess, \Countable
{
    // 這里面是常量、屬性、類方法
}

implements 的繼承列表也 可以 分成多行,這樣的話,每個繼承接口名稱都 必須 分開獨立成行,包括第一個。

<?php
namespace Vendor\Package;

use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;

class ClassName extends ParentClass implements
\ArrayAccess,
\Countable,
\Serializable 
{
    // 這里面是常量、屬性、類方法 
}

4.2 屬性
每個屬性都 必須 添加訪問修飾符。
禁止 使用關鍵字 var 聲明一個屬性。
禁止 一條語句定義超過一個屬性。
不該 使用下劃線作為前綴,來區分屬性是 protected 或 private。
示例:

<?php
namespace Vendor\Package;

class ClassName
{
      public $foo = null;
}

4.3 方法
所有方法都 必須 添加訪問修飾符。
不該 使用下劃線作為前綴,來區分方法是 protected 或 private。
方法名稱后 禁止 有空格符,其開始花括號 必須 獨占一行,結束花括號也 必須 在方法主體后單獨成一行。
參數左括號后和右括號前 禁止 有空格。
示例:

<?php
namespace Vendor\Package;

class ClassName
{ 
      public function fooBarBaz($arg1, &$arg2, $arg3 = [])
      {
          // method body
      }
}

4.4 方法的參數
參數列表中,每個逗號后面 必須 要有一個空格,而逗號前面 禁止 有空格。
有默認值的參數,必須 放到參數列表的末尾。
參數類型為數組或對象的 應該 加上訪問修飾符 array 或對應對象的類修飾。

<?php
namespace Vendor\Package;

class ClassName
{
      public function foo($arg1, &$arg2, array $arg3 = [])
      {
          // method body
      }
}

參數列表 可以 分列成多行,這樣,包括第一個參數在內的每個參數都 必須 單獨成行。 拆分成多行的參數列表后,結束括號以及方法開始花括號 必須 寫在同一行,中間用一個空格分隔。

<?php
namespace Vendor\Package;

class ClassName
{
      public function aVeryLongMethodName(
          ClassTypeHint $arg1,
          &$arg2,
          array $arg3 = [] 
      ) {
          // 方法的內容
      }
 }

4.5 abstract、final 以及 static
需要添加 abstract 或 final 聲明時,必須 寫在訪問修飾符前,而 static 則 必須 寫在其后。

<?php
namespace Vendor\Package;

abstract class ClassName
{
      protected static $foo;
     
      abstract protected function zim();
    
      final public static function bar()
      {
          // method body
      }

}

4.6 方法及函數調用
方法及函數調用時,方法名或函數名與參數左括號之間 禁止 有空格,參數右括號前也 禁止 有空格。
每個參數前 禁止 有空格,但其后 必須 有一個空格。

<?php
bar();
$foo->bar($arg1);
Foo::bar($arg2, $arg3);

參數 可以 分列成多行,此時包括第一個參數在內的每個參數都 必須 單獨成行。

<?php
$foo->bar(
$longArgument,
$longerArgument,
$muchLongerArgument
);
  1. 控制結構
    控制結構的基本規范如下:
    控制結構關鍵詞后 必須 有一個空格;
    左括號 (禁止 有空格;
    右括號 ) 前也 禁止 有空格;
    右括號 ) 與開始花括號 {必須 有一個空格;
    結構體主體 必須 要有一次縮進;
    結束花括號 } 必須 在結構體主體后單獨成行。
    每個結構體的主體都 必須 被包含在成對的花括號之中,這能讓結構體更加結構話,以及減少加入新行時,出錯的可能性。

5.1 if、elseif 和 else
標準的 if 結構如下代碼所示,請留意「括號」、「空格」以及「花括號」的位置, 注意 else 和 elseif 都與前面的結束花括號在同一行。

<?php
if ($expr1) {
      // if body
} elseif ($expr2) {
      // elseif body
} else {
      // else body;
}

5.2 switch 和 case
標準的 switch 結構如下代碼所示,留意括號、空格以及花括號的位置。 case 語句 必須 相對 switch 進行一次縮進,而 break 語句以及 case 內的其它語句都 必須 相對 case 進行一次縮進。 如果存在非空的 case 直穿語句,主體里 必須 有類似 // no break 的注釋。

<?php
switch ($expr) {
      case 0:
           echo 'First case, with a 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;
}

5.3 while 和 do while
一個規范的 while 語句應該如下所示,注意其「括號」、「空格」以及「花括號」的位置。

<?php
while ($expr) {
      // structure body
}

標準的 do while 語句如下所示,同樣的,注意其「括號」、「空格」以及「花括號」的位置。

<?php
do {
      // structure body;
} while ($expr);

5.4 for
標準的 for 語句如下所示,注意其「括號」、「空格」以及「花括號」的位置。

<?php
for ($i = 0; $i < 10; $i++) {
      // for body
}

5.5 foreach
標準的 foreach 語句如下所示,注意其「括號」、「空格」以及「花括號」的位置。

<?php
foreach ($iterable as $key => $value) {
      // foreach body
}

5.6 try,catch
標準的 try catch 語句如下所示,注意其「括號」、「空格」以及「花括號」的位置。

<?php
try {
      // try body
} catch (FirstExceptionType $e) {
      // catch body
} catch (OtherExceptionType $e) {
      // catch body
}
  1. 閉包
    閉包聲明時,關鍵詞 function 后以及關鍵詞 use 的前后都 必須 要有一個空格。
    開始花括號 必須 寫在聲明的同一行,結束花括號 必須 緊跟主體結束的下一行。
    參數列表和變量列表的左括號后以及右括號前,禁止 有空格。
    參數和變量列表中,逗號前 禁止 有空格,而逗號后 必須 要有空格。
    閉包中有默認值的參數 必須 放到列表的后面。
    標準的閉包聲明語句如下所示,注意其「括號」、「空格」以及「花括號」的位置。
<?php
$closureWithArgs = function ($arg1, $arg2) {
      // body
};

$closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) {
      // body
};

參數列表以及變量列表 可以 分成多行,這樣,包括第一個在內的每個參數或變量都 必須 單獨成行,而列表的右括號與閉包的開始花括號 必須 放在同一行。以下幾個例子,包含了參數和變量列表被分成多行的多情況。

<?php
$longArgs_noVars = function (
      $longArgument,
      $longerArgument,
      $muchLongerArgument
) {
      // body
};

$noArgs_longVars = function () use (
      $longVar1,
      $longerVar2,
      $muchLongerVar3
) {
      // body
};

$longArgs_longVars = function (
      $longArgument,
      $longerArgument,
      $muchLongerArgument
) use (
      $longVar1,
      $longerVar2,
      $muchLongerVar3
) {
      // body
};

$longArgs_shortVars = function (
      $longArgument,
      $longerArgument,
      $muchLongerArgument
) use ($var1) {
      // body
};

$shortArgs_longVars = function ($arg) use (
      $longVar1,
      $longerVar2,
      $muchLongerVar3
) {
      // body
};

注意,閉包被直接用作函數或方法調用的參數時,以上規則仍然適用。

<?php
$foo->bar(
      $arg1,
      function ($arg2) use ($var1) {
            // body
      },
      $arg3
);

本規范僅為本人習慣,有遺漏后續再更新。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容