PHP代碼規範PSR2

時間  2019-11-12
標籤 php 代碼 規範 psr2 psr 欄目 PHP 简体版
原文   原文鏈接

FIG組織在制定跟PHP相關規範，簡稱PSR。目前已有4個代碼規範，近期抽空翻譯成了中文版。建議作PHP的同窗都關注一下。
文檔倉庫地址：https://github.com/hfcorriez/fig-standardsphp

全部已接受的規範參考：https://github.com/hfcorriez/fig-standards/tree/zh_CN/%E6%8E%A5%E5%8F%97html

代碼樣式規範git

本指南的意圖是爲了減小不一樣開發者在瀏覽代碼時減小認知的差別。 爲此列舉一組如何格式化PHP代碼的共用規則。github

各個成員項目的共性組成了本文的樣式規則。當不一樣的開發者在不一樣的項目中合做時，將會在這些不一樣的項目中使用一個共同的標準。 所以，本指南的好處不在於規則自己，而在於共用這些規則。閉包

在 RFC 2119中的特性關鍵詞"必須"(MUST)，「不可」(MUST NOT)，「必要」(REQUIRED)，「將會」(SHALL)，「不會」(SHALL NOT)，「應當」(SHOULD)，「不該」(SHOULD NOT)，「推薦」(RECOMMENDED)，「能夠」(MAY)和「可選」(OPTIONAL)在這文檔中將被用來描述。app

1. 大綱ide

  • 代碼必須遵照 PSR-1。函數

  • 代碼必須使用4個空格的縮進，而不是製表符。ui

  • 一行代碼長度不該硬性限制；軟限制必須爲120個字符；也應當是80個字符或者更少。google

  • 在namespace聲明下面必須有一個空行，而且use聲明代碼塊下面也必須有一個空行。

  • 類的左花括號必須放到下一行，右花括號必須放在類主體的下一行。

  • 方法的左花括號必須放在下一行，右花括號必須放在方法主體下面。

  • 全部的屬性和方法必須有可見性(譯者注：Public, Protect, Private)聲明；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()

    {

        // method body

    }

}

2. 歸納

2.1 基礎代碼規範

代碼必須遵照 PSR-1 的全部規則。

2.2 文件

全部的PHP文件必須使用Unix LF(換行)做爲行結束符。

全部PHP文件必須以一個空行結束。

純PHP代碼的文件關閉標籤?>必須省略

2.3. 行

行長度不可有硬限制。

行長度的軟限制必須是120個字符；對於軟限制，自動樣式檢查器必須警告但不可報錯。

行實際長度不該超過80個字符；較長的行應當被拆分紅多個不超過80個字符的後續行。

在非空行後面不可有空格。

空行能夠用來改善可讀性和區分相關的代碼塊。

一行不該多於一個語句。

2.4. 縮進

代碼必須使用4個空格的縮進，而且不可以使用製表符做爲縮進。

注意：只用空格，不和製表符混合使用，將會對避免代碼差別，補丁，歷史和註解中的一些問題有幫助。使用空格還可使調整細微的縮進來改進行間對齊變得很是簡單。

2.5. 關鍵詞和 True/False/Null

PHP keywords 必須使用小寫。

PHP常量true, false和null必須使用小寫。

3. Namespace和Use聲明

若是存在，namespace聲明以後必須有一個空行。

若是存在，全部的use聲明必須放在namespace聲明的下面。

一個use關鍵字必須只用於一個聲明。

在use聲明代碼塊後面必須有一個空行。

示例:

        <?php

namespace Vendor\Package;

 

use FooClass;

use BarClass as Bar;

use OtherVendor\OtherPackage\BazClass;

 

// ... additional PHP code ...

 

4. 類，屬性和方法

術語「類」指全部的類，接口和特性（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

{

    // constants, properties, methods

}

implements一個列表能夠被拆分爲多個有一次縮進的後續行。若是這麼作，列表的第一項必需要放在下一行，而且每行必須只有一個接口。

        <?php

namespace Vendor\Package;

 

use FooClass;

use BarClass as Bar;

use OtherVendor\OtherPackage\BazClass;

 

class ClassName extends ParentClass implements

    \ArrayAccess,

    \Countable,

    \Serializable

{

    // constants, properties, methods

}

4.2. 屬性

全部的屬性必須聲明可見性。

var關鍵詞不可用來聲明屬性。

一個語句不可聲明多個屬性。

屬性名稱不該使用單個下劃線做爲前綴來代表保護或私有的可見性。

一個屬性聲明看起來應該下面這樣的。

        <?php

namespace Vendor\Package;

 

class ClassName

{

    public $foo = null;

}

4.3. 方法

全部的方法必須聲明可見性。

方法名不該只使用單個下劃線來代表是保護或私有的可見性。

方法名在聲明以後不可跟隨一個空格。左花括號必須放在下面自成一行，而且右花括號必須放在方法主體的下面自成一行。左括號後面不可有空格，右括號前面不可有空格。

一個方法定義看來應該像下面這樣。 注意括號，逗號，空格和花括號：

        <?php

namespace Vendor\Package;

 

class ClassName

{

    public function fooBarBaz($arg1, &$arg2, $arg3 = [])

    {

        // method body

    }

}

4.4. 方法參數

在參數列表中，逗號以前不可有空格，逗號以後必需要有一個空格。

方法中有默認值的參數必須放在參數列表的最後面。

        <?php

namespace Vendor\Package;

 

class ClassName

{

    public function foo($arg1, &$arg2, $arg3 = [])

    {

        // method body

    }

}

參數列表能夠被分爲多個有一次縮進的多個後續行。若是這麼作，列表的第一項必須放在下一行，而且每行必須只放一個參數。

當參數列表被分爲多行，右括號和左花括號必須夾帶一個空格放在一塊兒自成一行。

        <?php

namespace Vendor\Package;

 

class ClassName

{

    public function aVeryLongMethodName(

        ClassTypeHint $arg1,

        &$arg2,

        array $arg3 = []

    ) {

        // method body

    }

}

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

);

5. 控制結構

對於控制結構的樣式規則歸納以下：

  • 控制結構關鍵詞以後必須有一個空格

  • 左括號以後不可有空格

  • 右括號以前不可有空格

  • 在右括號和左花括號之間必須有一個空格

  • 代碼主體必須有一次縮進

  • 右花括號必須主體的下一行

每一個結構的主體必須被括在花括號裏。這結構看上去更標準化，而且當加新行的時候能夠減小引入錯誤的可能性。

5.1. if，elseif，else

一個if結構看起來應該像下面這樣。注意括號，空格，花括號的位置；而且else和elseif和前一個主體的右花括號在同一行。

        <?php

if ($expr1) {

    // if body

} elseif ($expr2) {

    // elseif body

} else {

    // else body;

}

關鍵詞elseif應該替代else if使用以保持全部的控制關鍵詞像一個單詞。

5.2. switch，case

一個switch結構看起來應該像下面這樣。注意括號，空格和花括號。case語句必須從switch處縮進，而且break關鍵字（或其餘停止關鍵字）必須和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

}

6. 閉包

閉包在聲明時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

);

7. 結論

在該指南中有不少風格的元素和作法有意被忽略掉。這些包括但不侷限於：

  • 全局變量和全局常量的聲明

  • 方法聲明

  • 操做符和賦值

  • 行間對齊

  • 註釋和文檔塊

  • 類名給你前綴和後綴

  • 最佳實踐

之後的建議能夠修改和擴展該指南以知足這些或其餘風格的元素和實踐。

附錄A 調查

爲了寫這個風格指南，咱們採用了調查個項目以肯定共同的作法。這個調查在這裏供他人查看。

A.1. 調查數據

url,http://www.horde.org/apps/horde/docs/CODING_STANDARDS,http://pear.php.net/manual/en/standards.php,http://solarphp.com/manual/appendix-standards.style,http://framework.zend.com/manual/en/coding-standard.html,http://symfony.com/doc/2.0/contributing/code/standards.html,http://www.ppi.io/docs/coding-standards.html,https://github.com/ezsystems/ezp-next/wiki/codingstandards,http://book.cakephp.org/2.0/en/contributing/cakephp-coding-conventions.html,https://github.com/UnionOfRAD/lithium/wiki/Spec%3A-Coding,http://drupal.org/coding-standards,http://code.google.com/p/sabredav/,http://area51.phpbb.com/docs/31x/coding-guidelines.html,https://docs.google.com/a/zikula.org/document/edit?authkey=CPCU0Us&hgd=1&id=1fcqb93Sn-hR9c0mkN6m_tyWnmEvoswKBtSc0tKkZmJA,http://www.chisimba.com,n/a,https://github.com/Respect/project-info/blob/master/coding-standards-sample.php,n/a,Object Calisthenics for PHP,http://doc.nette.org/en/coding-standard,http://flow3.typo3.org,https://github.com/propelorm/Propel2/wiki/Coding-Standards,http://developer.joomla.org/coding-standards.html

voting,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,no,no,no,?,yes,no,yes

indent_type,4,4,4,4,4,tab,4,tab,tab,2,4,tab,4,4,4,4,4,4,tab,tab,4,tab

line_length_limit_soft,75,75,75,75,no,85,120,120,80,80,80,no,100,80,80,?,?,120,80,120,no,150

line_length_limit_hard,85,85,85,85,no,no,no,no,100,?,no,no,no,100,100,?,120,120,no,no,no,no

class_names,studly,studly,studly,studly,studly,studly,studly,studly,studly,studly,studly,lower_under,studly,lower,studly,studly,studly,studly,?,studly,studly,studly

class_brace_line,next,next,next,next,next,same,next,same,same,same,same,next,next,next,next,next,next,next,next,same,next,next

constant_names,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper

true_false_null,lower,lower,lower,lower,lower,lower,lower,lower,lower,upper,lower,lower,lower,upper,lower,lower,lower,lower,lower,upper,lower,lower

method_names,camel,camel,camel,camel,camel,camel,camel,camel,camel,camel,camel,lower_under,camel,camel,camel,camel,camel,camel,camel,camel,camel,camel

method_brace_line,next,next,next,next,next,same,next,same,same,same,same,next,next,same,next,next,next,next,next,same,next,next

control_brace_line,same,same,same,same,same,same,next,same,same,same,same,next,same,same,next,same,same,same,same,same,same,next

control_space_after,yes,yes,yes,yes,yes,no,yes,yes,yes,yes,no,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes

always_use_control_braces,yes,yes,yes,yes,yes,yes,no,yes,yes,yes,no,yes,yes,yes,yes,no,yes,yes,yes,yes,yes,yes

else_elseif_line,same,same,same,same,same,same,next,same,same,next,same,next,same,next,next,same,same,same,same,same,same,next

case_break_indent_from_switch,0/1,0/1,0/1,1/2,1/2,1/2,1/2,1/1,1/1,1/2,1/2,1/1,1/2,1/2,1/2,1/2,1/2,1/2,0/1,1/1,1/2,1/2

function_space_after,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no

closing_php_tag_required,no,no,no,no,no,no,no,no,yes,no,no,no,no,yes,no,no,no,no,no,yes,no,no

line_endings,LF,LF,LF,LF,LF,LF,LF,LF,?,LF,?,LF,LF,LF,LF,?,,LF,?,LF,LF,LF

static_or_visibility_first,static,?,static,either,either,either,visibility,visibility,visibility,either,static,either,?,visibility,?,?,either,either,visibility,visibility,static,?

control_space_parens,no,no,no,no,no,no,yes,no,no,no,no,no,no,yes,?,no,no,no,no,no,no,no

blank_line_after_php,no,no,no,no,yes,no,no,no,no,yes,yes,no,no,yes,?,yes,yes,no,yes,no,yes,no

class_method_control_brace,next/next/same,next/next/same,next/next/same,next/next/same,next/next/same,same/same/same,next/next/next,same/same/same,same/same/same,same/same/same,same/same/same,next/next/next,next/next/same,next/same/same,next/next/next,next/next/same,next/next/same,next/next/same,next/next/same,same/same/same,next/next/same,next/next/next

A.2. 調查說明

indent_type: 縮進類型。 tab = "使用製表符"，2 or 4 = "空格數量"

line_length_limit_soft: 行長度的「軟」限制，用字符。 ? = 不表示或者數字 no 意爲不限制.

line_length_limit_hard: 行長度的"硬"限制，用字符。 ? = 不表示或者數字, no 意爲不限制.

class_names: 類名如何命名 lower = 只是小寫, lower_under = 小寫加下劃線, studly = 駱駝型.

class_brace_line: 類的左花括號是放在同(same)一行仍是在下(next)一行？

constant_names: 類常量如何命名？upper = 大寫加下劃線分隔符。

true_false_null: 全校寫或者全大寫？

method_names: 方法名如何命名？camel = 駝峯式, lower_under = 小寫加下劃線分隔符。

method_brace_line: 方法的左花括號在同(same)一行仍是在下(next)一行？

control_brace_line: 控制結構的左花括號在同(same)一行仍是在下(next)一行？

control_space_after: 控制結構關鍵詞後是否有空格？

always_use_control_braces: 控制結構老是使用花括號？

else_elseif_line: 當使用else和elseif，是否放在同(same)一行仍是在下(next)一行？

case_break_indent_from_switch: case和break分別從swith語句處縮進多少次？

function_space_after: 函數調用的函數名和左括號是否有空格？

closing_php_tag_required: 如過是純PHP文件，關閉標籤?>是否須要？

line_endings: 使用何種的行結束符？

static_or_visibility_first: 在定義方法的時候static和可見性誰在前面？

control_space_parens: 在控制結構表達式中，左括號後面和右括號前面是否要有一個空格？yes = if ( $expr ), no =if ($expr).

blank_line_after_php: PHP的開始標籤後面是否須要一個空行？

class_method_control_brace: 左花括號在類，方法和控制結構中的位置。

A.3. 調查結果

indent_type:

    tab: 7

    2: 1

    4: 14

line_length_limit_soft:

    ?: 2

    no: 3

    75: 4

    80: 6

    85: 1

    100: 1

    120: 4

    150: 1

line_length_limit_hard:

    ?: 2

    no: 11

    85: 4

    100: 3

    120: 2

class_names:

    ?: 1

    lower: 1

    lower_under: 1

    studly: 19

class_brace_line:

    next: 16

    same: 6

constant_names:

    upper: 22

true_false_null:

    lower: 19

    upper: 3

method_names:

    camel: 21

    lower_under: 1

method_brace_line:

    next: 15

    same: 7

control_brace_line:

    next: 4

    same: 18

control_space_after:

    no: 2

    yes: 20

always_use_control_braces:

    no: 3

    yes: 19

else_elseif_line:

    next: 6

    same: 16

case_break_indent_from_switch:

    0/1: 4

    1/1: 4

    1/2: 14

function_space_after:

    no: 22

closing_php_tag_required:

    no: 19

    yes: 3

line_endings:

    ?: 5

    LF: 17

static_or_visibility_first:

    ?: 5

    either: 7

    static: 4

    visibility: 6

control_space_parens:

    ?: 1

    no: 19

    yes: 2

blank_line_after_php:

    ?: 1

    no: 13

    yes: 8

class_method_control_brace:

    next/next/next: 4

    next/next/same: 11

    next/same/same: 1

    same/same/same: 6

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程