1 概述

1.1 说明

  • 本规范适用于PHP项目代码相关规范的约定
  • 规范的作用,系提高代码的可读性、通用性、交付性以及整体质量
  • 该文档大量参考了PSR通用规范

1.2 注意

  • 变量、类属性的初始化
  • 考虑代码复用、耦合的权衡
  • 架构类、方法时需考虑扩展性,适当引入设计模式

2 命名规范

2.1 空间名和类名

  • 命名空间(namespace)类(class)必须遵守 PSR-0。 这意味着一个源文件中只能有一个类(class),并且每个类(class)至少要有一级空间名(namespace):即一个顶级的组织名(vendor name)
  • 类名必须遵循StudlyCaps大写开头的驼峰命名规范。
  • 新项目或新功能的代码应该使用正式的命名空间(namespace)
<?php
namespace Vendor\Model;

class Foo {
}

2.2 类的常量、属性和方法

此处的「类」指代所有的类(class)接口(interface)代码复用(trait)

2.2.1 常量

  • 类中的常量所有字母都必须大写,单词间用下划线分隔。
  • 普通的全局常量与类常量风格一致。
<?php
namespace Vendor\Model;

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

2.2.2 属性

  • 属性名必须使用小写开头的驼峰式($camelCase)
  • 变量名与属性名风格一致。
<?php
namespace Vendor\Model;

class Foo {
    public $camelCase;
    public $registerType = 'mobile';
}

2.2.3 方法

  • 方法名必须符合camelCase式的小写开头驼峰命名规范。
  • 函数名与方法名风格一致。

2.3 命名规则

以下规则适用于类、接口、traits、namespace、方法、函数、变量、属性、常量等命名。

  • 采用有意义的命名。名字必须准确反映它的含义和内容,通过名称就能理解要表达的意思,不要贪图简短。
  • 类、变量、常量、参数应当用名词或名词短语,方法、函数应当用动词或动词短语。
  • 尽量使用英文单词全称,避免使用缩写或拼音。
  • 不要使用过长的名称。过长的名称会导致代码丑陋和难以阅读。

3 代码风格

3.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() {
        // 方法的内容
    }
}

3.2 通则

3.2.1 文件

  • PHP代码 必须<?php 长标签开始,不可 使用其它自定义标签。
  • 所有PHP文件 必须 使用 Unix LF (linefeed) 作为行的结束符。
  • 所有PHP文件 必须 以一个空白行作为结束。
  • 纯PHP代码文件 必须 省略最后的 ?> 结束标签。

3.2.2 行

  • 行的长度 一定不可 有硬性的约束。
  • 软性的长度约束 必须 要限制在 120 个字符以内,若超过此长度,带代码规范检查的编辑器 必须 要发出警告,不过 一定不可 发出错误提示。
  • 每行 不该 多于80个字符,大于80字符的行 应该 折成多行。
  • 非空行后 一定不可 有多余的空格符。
  • 空行 可以 使得阅读代码更加方便以及有助于代码的分块。
  • 每行 一定不可 存在多于一条语句。

3.2.3 缩进

代码 必须 使用4个空格符的缩进,一定不可 用 tab键。

备注:使用空格而不是「tab键缩进」的好处在于, 避免在比较代码差异、打补丁、重阅代码以及注释时产生混淆。 并且,使用空格缩进,让对齐变得更方便。

3.2.4 关键字 以及 true/false/null

  • PHP所有 关键字 必须 全部小写。
  • 常量 truefalsenull必须 全部小写。

3.3 namespace 以及 use 声明

  • namespace 声明后 必须 插入一个空白行。
  • 所有 use 必须namespace 后声明。
  • 每条 use 声明语句 必须 只有一个 use 关键词。
  • use 声明语句块后 必须 要有一个空白行。

例如:

<?php
namespace Vendor\Package;

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

// ... 更多的 PHP 代码在这里 ...

3.4 类、属性和方法

此处的「类」泛指所有的「class类」、「接口」以及「traits 可复用代码块」。

3.4.1 扩展与继承

  • 关键词 extendsimplements 必须 写在类名称的同一行。
  • 类的左花括号与类名同行,如果继承分成多行,则左花括号可独占一行;右花括号 必须 在类主体后独占一行。
<?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
{
    // 这里面是常量、属性、类方法
}

3.4.2 属性

  • 每个属性都 必须 添加访问修饰符。
  • 一定不可 使用关键字 var 声明一个属性。
  • 每条语句 一定不可 定义超过一个属性。
  • 不该 使用下划线作为前缀,来区分属性是 protected 或 private。

以下是属性声明的一个范例:

<?php
namespace Vendor\Package;

class ClassName {
    public $foo = null;
}

3.4.3 方法

  • 所有方法都 必须 添加访问修饰符。
  • 不该 使用下划线作为前缀,来区分方法是 protected 或 private。
  • 方法名称后 一定不可 有空格符,其左花括号与参数左括号 必须 写在同一行,中间用一个空格分隔。
  • 参数左括号后和右括号前 一定不可 有空格。

一个标准的方法声明可参照以下范例,留意其括号、逗号、空格以及花括号的位置。

<?php
namespace Vendor\Package;

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

3.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 = []
    ) {
        // 方法的内容
    }
}

3.4.5 abstract、final、以及static

  • 需要添加 abstractfinal 声明时,必须 写在访问修饰符前,而 static必须 写在其后。
<?php
namespace Vendor\Package;

abstract class ClassName {
    protected static $foo;

    abstract protected function zim();

    final public static function bar() {
        // method body
    }
}

3.4.6 方法及函数调用

  • 方法及函数调用时,方法名或函数名与参数左括号之间 一定不可 有空格,参数右括号前也 一定不可 有空格。每个参数前 一定不可 有空格,但其后 必须 有一个空格。
<?php
bar();
$foo->bar($arg1);
Foo::bar($arg2, $arg3);
  • 参数 可以 分列成多行,此时包括第一个参数在内的每个参数都 必须 单独成行。
<?php
$foo->bar(
    $longArgument,
    $longerArgument,
    $muchLongerArgument
);

3.5 控制结构

控制结构的基本规范如下:

  • 控制结构关键词后 必须 有一个空格。
  • 左括号 (一定不可 有空格。
  • 右括号 ) 前也 一定不可 有空格。
  • 右括号 ) 与开始花括号 {必须 有一个空格。
  • 结构体主体 必须 要有一次缩进。
  • 结束花括号 } 必须 在结构体主体后单独成行。

每个结构体的主体都 必须 被包含在成对的花括号之中, 这能让结构体更加结构话,以及减少加入新行时,出错的可能性。

3.5.1 ifelseifelse

  • 标准的 if 结构如下代码所示,请留意「括号」、「空格」以及「花括号」的位置,注意 elseelseif 都与前面的结束花括号在同一行。
<?php
if ($expr1) {
    // if body
} elseif ($expr2) {
    // elseif body
} else {
    // else body;
}
  • 应该 使用关键词 elseif 代替所有 else if ,以使得所有的控制关键字都像是单独的一个词。

3.5.2 switchcase

  • 标准的 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;
}

3.5.3 whiledo while

-一个规范的 while 语句应该如下所示,注意其「括号」、「空格」以及「花括号」的位置。

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

标准的 do while 语句如下所示,同样的,注意其「括号」、「空格」以及「花括号」的位置。

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

3.5.4 for

标准的 for 语句如下所示,注意其「括号」、「空格」以及「花括号」的位置。

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

3.5.5 foreach

标准的 foreach 语句如下所示,注意其「括号」、「空格」以及「花括号」的位置。

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

3.5.6 try, catch

标准的 try catch 语句如下所示,注意其「括号」、「空格」以及「花括号」的位置。

<?php
try {
    // try body
} catch (FirstExceptionType $e) {
    // catch body
} catch (OtherExceptionType $e) {
    // catch body
}

3.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
);