|
PHP代码规范
代码风格规范
本规范期盼经过制定一系列规范化PHP代码的规则，以减少在浏览区别作者的代码时，因代码风格的区别而导致不方便。
当多名程序员在多个项目中合作时，就需要一个一起的编码规范， 而本文中的风格规范源自于多个区别项目代码风格的一起特性， 因此呢，本规范的价值在于咱们都遵循这个编码风格，而不是在于它本身。
关键词 “必须”("MUST")、“必定不可/必定不可”("MUST NOT")、“需要”("REQUIRED")、 “将会”("SHALL")、“不会”("SHALL NOT")、“应该”("SHOULD")、“不应”("SHOULD NOT")、 “举荐”("RECOMMENDED")、“能够”("MAY")和”可选“("OPTIONAL")的仔细描述可参见 RFC 2119 。 概览代码必须遵循 PSR-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()
{
// method body}
}通则2.1 基本编码准则
代码必须符合 PSR-1 中的所有规范。
2.2 文件
所有PHP文件必须运用Unix LF (linefeed)做为行的结束符。
所有PHP文件必须以一个空白行做为结束。
纯PHP代码文件必须省略最后的 ?> 结束标签。
2.3. 行
行的长度必定不可有硬性的约束。
软性的长度约束必定要限制在120个字符以内，若超过此长度，带代码规范检测的编辑器必定要发出警告，不外必定不可发出错误提示。
每行不该该多于80个字符，大于80字符的行应该折成多行。
非空行后必定不可有多余的空格符。
空行能够使得阅读代码更加方便以及有助于代码的分块。
每行必定不可存在多于一条语句。
2.4. 缩进
代码必须运用4个空格符的缩进，必定不可用 tab键 。
备注: 运用空格而不是tab键缩进的好处在于， 避免在比较代码差异、打补丁、重阅代码以及注释时产生混淆。 并且，运用空格缩进，让对齐变得更方便。
2.5. 关键字 以及 True/False/Null
PHP所有 关键字必须所有小写。
常量 true 、false 和 null 亦必须所有小写。 namespace 以及 use 声明namespace 声明后 必须 插进一个空白行。
所有 use 必须 在 namespace 后声明。
每条 use 声明语句 必须 仅有一个 use 关键词。
use 声明语句块后 必须 要有一个空白行。
例如： <?php
namespace Vendor\Package;use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
// ... additional PHP code ...
类、属性和办法
此处的“类”泛指所有的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
{
// constants, properties, methods
}
implements 的继承列表亦能够分成多行，这般的话，每一个继承接口名叫作都必须掰开独立成行，包含第1个。 <?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 声明一个属性。
每条语句必定不可定义超过一个属性。
不要运用下划线做为前缀，来区分属性是 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. 办法的参数
参数列表中，每一个逗号后面必须要有一个空格，而逗号前面必定不能有空格。
有默认值的参数，必须放到参数列表的末尾。 <?php
namespace Vendor\Package;
class ClassName
{
public function foo($arg1, &$arg2, $arg3 = [])
{
// method body
}
}
参数列表能够分列成多行，这般，包含第1个参数在内的每一个参数都必须单独成行。
拆分成多行的参数列表后，结束括号以及办法起始花括号 必须 写在同一行，中间用一个空格分隔。 <?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);
参数能够分列成多行，此时包含第1个参数在内的每一个参数都必须单独成行。 <?php$foo->bar(
$longArgument,
$longerArgument,
$muchLongerArgument
);掌控结构掌控结构的基本规范如下： 掌控结构关键词后必须有一个空格。左括号 ( 后必定不可有空格。右括号 ) 前亦必定不能有空格。右括号 ) 与起始花括号 { 间必定有一个空格。结构体主体一定要有一次缩进。结束花括号 } 必定在结构体主体后单独成行。每一个结构体的主体都必须被包括在成对的花括号之中， 这能让结构体更加结构话，以及减少加入新行时，出错的可能性。
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 进行一次缩进。 倘若存在非空的 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
}
闭包闭包声明时，关键词 function 后以及关键词 use 的前后都必须要有一个空格。
起始花括号必须写在声明的同一行，结束花括号必须紧跟主体结束的下一行。
参数列表和变量列表的左括号后以及右括号前，必须不可有空格。
参数和变量列表中，逗号前必须不可有空格，而逗号后必须要有空格。
闭包中有默认值的参数必须放到列表的后面。
标准的闭包声明语句如下所示，重视其 括号、逗号、空格以及花括号的位置。 <?php
$closureWithArgs = function ($arg1, $arg2) {
// body
};
$closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) {
// body
};
参数列表以及变量列表能够分成多行，这般，包含第1个在内的每一个参数或变量都必须单独成行，而列表的右括号与闭包的起始花括号必须放在同一行。
以下几个例子，包括了参数和变量列表被分成多行的多状况。 <?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
);
总结以上规范难免有疏忽，其中包含但不仅限于： 全局变量和常量的定义函数的定义操作符和赋值行内对齐注释和文档描述块类名的前缀及后缀最佳实践日志接口规范
本文制定了日志类库的通用接口规范。
本规范的重点目的，是为了让日志类库以简单通用的方式，经过接收一个 Psr\Log\LoggerInterface 对象，来记录日志信息。 框架以及CMS内容管理系统如有需要，能够对此接口进行扩展，但需遵循本规范， 这才可保准在运用第三方的类库文件时，日志接口仍能正常对接。
本文中的 实现者 指的是实现了 LoggerInterface 接口的类库或框架，反过来讲，她们便是 LoggerInterface 的 运用者。 规范说明1.1 基本规范LoggerInterface接口对外定义了八个办法，分别用来记录 RFC 5424 中定义的八个等级的日志：debug、 info、 notice、 warning、 error、 critical、 alert 以及 emergency 。第九个办法 ——log，其第1个参数为记录的等级。可运用一个预先定义的等级常量做为参数来调用此办法，必须与直接调用以上八个办法拥有相同的效果。倘若传入的等级常量参数无预先定义，则必须抛出 Psr\Log\InvalidArgumentException 类型的反常。在不确定的状况下，运用者不应运用未支持的等级常量来调用此办法。1.2 记录信息以上每一个办法都接受一个字符串类型或是有 __toString()办法的对象做为记录信息参数，这般，实现者就能把它当成字符串来处理，否则实现者必须自己把它转换成字符串。记录信息参数能够携带占位符，实现者能够按照上下文将其它替换成相应的值。其中占位符必须与上下文数组中的键名保持一致。
占位符的名叫作必须由一个左花括号 { 以及一个右括号 } 包括。但花括号与名叫作之间必定不可有空格符。
占位符的名叫作应该只由 A-Z、 a-z,0-9、下划线 _、以及英文的句号 .构成，其它字符做为将来占位符规范的保存。
实现者能够经过对占位符采用区别的转义和转换策略，来生成最后的日志。 而运用者在不晓得上下文的前提下，不应提前转义占位符。
以下是一个占位符运用的例子： /**
* 用上下文信息替换记录信息中的占位符
*/
function interpolate($message, array $context = array())
{
// 构建一个花括号包括的键名的替换数组
$replace = array();
foreach ($context as$key => $val) {
$replace[{ . $key . }] = $val;
}
// 替换记录信息中的占位符，最后返回修改后的记录信息。
return strtr($message, $replace);
}
// 含有带花括号占位符的记录信息。
$message = "User {username} created";
// 带有替换信息的上下文数组，键名为占位符名叫作，键值为替换值。
$context = array(username => bolivar);
// 输出 "Username bolivar created"
echo interpolate($message, $context);
1.3 上下文每一个记录函数都接受一个上下文数组参数，用来装载字符串类型没法暗示的信息。它能够装载任何信息，因此实现者必须保证能正确处理其装载的信息，针对其装载的数据，必定不可 抛出反常，或产生PHP出错、警告或提醒信息（error、warning、notice）。如需经过上下文参数传入了一个 Exception 对象， 必须以exception 做为键名。 记录反常信息是很广泛的，因此倘若它能够在记录类库的底层实现，就能够让实现者从反常信息中抽丝剥茧。 当然，实现者在运用它时，必须保证键名为 exception 的键值是不是真的是一个 Exception，毕竟它能够装载任何信息。1.4 助手类和接口Psr\Log\AbstractLogger 类使得只需继承它和实现其中的 log 办法，就能够很轻易地实现 LoggerInterface 接口，而另一八个办法就能够把记录信息和上下文信息传给它。一样地，运用 Psr\Log\LoggerTrait 亦只需实现其中的 log办法。不外，需要尤其重视的是，在traits可复用代码块还不可实现接口前，还需要implement LoggerInterface。在无可用的日志记录器时， Psr\Log\NullLogger 接口能够为运用者供给一个备用的日志“黑洞”。不外，当上下文的构建非常消耗资源时，带要求检测的日志记录或许是更好的办法。Psr\Log\LoggerAwareInterface接口仅包含一个setLogger(LoggerInterface $logger) 办法，框架能够运用它实现自动连接任意的日志记录实例。Psr\Log\LoggerAwareTrait trait可复用代码块能够在任何的类里面运用，只需经过它供给的 $this->logger，就能够容易地实现等同的接口。Psr\Log\LogLevel 类装载了八个记录等级常量。包以上的接口、类和关联的反常类，以及一系列的实现检测文件，都包括在 psr/log 文件包中。 Psr\Log\LoggerInterface<?php
namespace Psr\Log;
/**
* 日志记录实例
*
* 日志信息变量 —— message， **必须**是一个字符串或是实现了 __toString() 办法的对象。
*
* 日志信息变量中**能够**包括格式如 “{foo}” (表率foo) 的占位符，
* 它将会由上下文数组中键名为 "foo" 的键值替代。
*
* 上下文数组能够携带任意的数据，独一的限制是，当它携带的是一个 exception 对象时，它的键名 必须 是 "exception"。
*
* 详情可参阅： https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-3-logger-interface-cn.md
*/
interface LoggerInterface
{
/**
* 系统不可用
*
*@param string $message
* @param array $context
* @return null
*/
public function emergency($message, array $context = array());
/**
* **必须**立刻采取行动
*
* 例如：在全部网站都垮掉了、数据库不可用了或其他的状况下，**应该**发送一条警报短信把你叫醒。
*
*@param string $message
* @param array $context
* @return null
*/
public function alert($message, array $context = array());
/**
* 紧急状况
*
* 例如：程序组件不可用或显现非预期的反常。
*
* @paramstring $message
*@param array $context
* @return null
*/
public function critical($message, array $context = array());
/**
* 运行时显现的错误，不需要立刻采取行动，但必须记录下来以备检测。
*
*@param string $message
* @param array $context
* @returnnull
*/
public function error($message, array $context = array());
/**
* 显现非错误性的反常。
*
* 例如：运用了被弃用的API、错误地运用了API或非预想的不必要错误。
*
*@param string $message
* @param array $context
* @return null
*/
public function warning($message, array $context = array());
/**
* 通常性重要的事件。
*
* @param string $message
* @paramarray $context
*@return null
*/
public function notice($message, array $context = array());
/**
* 重要事件
*
* 例如：用户登录和SQL记录。
*
*@param string $message
* @param array $context
* @return null
*/
public function info($message, array $context = array());
/**
* debug 详情
*
* @param string $message
* @paramarray $context
*@return null
*/
public function debug($message, array $context = array());
/**
* 任意等级的日志记录
*
* @parammixed $level
*@param string $message
* @param array $context
* @return null
*/
public function log($level, $message, array $context = array());
}
Psr\Log\LoggerAwareInterface<?php
namespace Psr\Log;
/**
* logger-aware 定义实例
*/
interface LoggerAwareInterface
{
/**
* 设置一个日志记录实例
*
* @param LoggerInterface $logger
* @return null
*/
public function setLogger(LoggerInterface $logger);
}
Psr\Log\LogLevel<?php
namespace Psr\Log;
/**
* 日志等级常量定义
*/
class LogLevel
{
const EMERGENCY = emergency;
const ALERT = alert;
const CRITICAL = critical;
const ERROR = error;
const WARNING = warning;
const NOTICE = notice;
const INFO = info;
constDEBUG =debug;
}
Autoloader
1. 概述
本 PSR 是关于由文件路径 自动载入 对应类的关联规范， 本规范是可互操作的，能够做为任一自动载入规范的弥补，其中包含 PSR-0，另外， 本 PSR 还包含自动载入的类对应的文件存放路径规范。
2. 仔细说明此处的“类”泛指所有的class类、接口、traits可复用代码块以及其它类似结构。一个完整的类名需拥有以下结构: \<命名空间>(\<子命名空间>)*\<类名>
完整的类名必须要有一个顶级命名空间，被叫作为 "vendor namespace"；完整的类名能够有一个或多个子命名空间；完整的类名必须有一个最后的类名；完整的类名中任意一部分中的下划线都是无特殊含义的；完整的类名能够由任意体积写字母构成；所有类名都必须是体积写敏锐的。当按照完整的类名载入相应的文件……完整的类名中，去掉最前面的命名空间分隔符，前面连续的一个或多个命名空间和子命名空间，做为“命名空间前缀”，其必须与最少一个“文件基目录”相对应；紧接命名空间前缀后的子命名空间必须与相应的”文件基目录“相匹配，其中的命名空间分隔符将做为目录分隔符。末尾的类名必须与对应的以 .php 为后缀的文件同名。自动加载器（autoloader）的实现必定不可抛出反常、必定不可触发任一级别的错误信息以及不该该有返回值。3. 例子
下表展示了符合规范完整类名、命名空间前缀和文件基目录所对应的文件路径。
没法复制加载中的内容
关于本规范的实现，可参阅 关联实例
重视：实例并不属于规范的一部分，且随时会有所变动。
参考： https://github.com/PizzaLiu/PHP-FIG
4. 代码规范工具
PHP Mess Detector(http://phpmd.org/)
PHP项目体检工具，按照你设定的标准（如单一文件代码体积，未运用的参数个数，未运用的办法数）检测PHP代码，超出设定的标准时报警。
PHP Copy Paste Detector(https://github.com/sebastianbergmann/...)
顾名思义，检测冗余代码的
PHP Dead Code Detector(https://github.com/sebastianbergmann/...)
看名字就晓得了，检测从未被调用过的办法
PHP Code Sniffer(http://pear.php.net/package/PHP_CodeS...)
老牌代码格式化工具，PHP写的，Pear包，可自己hack，可集成到命令行里。
你还能够用jenkins把以上工具以plugins形式整合起来，做连续集成：http://jenkins-php.org/
你还能够用xinc+phing跟以上工具集成起来做连续集成后的自动化打包发布： http://code.google.com/p/xinc/
| 
发表于 2024-10-5 09:44:33