由于PHP的灵活性&＃xff0c;很多人写起代码来也不讲求一个好的代码规范&＃xff0c;使得本就灵活的PHP代码看起来很乱&＃xff0c;其实PSR规范中的PSR-1和PSR-2已经定义了在PHP编码中的一些规范&＃xff0c;只要我们好好遵守这些规范&＃xff0c;即使是使用灵活的脚本语言&＃xff0c;也能写出非常漂亮工整的代码。首先我们来看一下已经通过的PSR规范&＃xff0c;然后大致讲解一下PSR-1和PSR-2规范的一些具体要求。
已通过的PSR
PSR-1基础编码规范
- 开闭标签
首先&＃xff0c;PHP代码必须以 - 副作用
PHP文件要么声明类、接口、函数等&＃xff0c;要么执行逻辑操作(如读写文件或向浏览器发送输出)&＃xff0c;但不应该同时兼具两者。 - 命名
类的命名必须遵守大写开头的驼峰式命名规范。换言之&＃xff0c;类名应当以大写字母开头。属性的命名方式没有强制要求&＃xff0c;但应该保持一致。方法名称必须符合小写开头的驼峰式命名规范。类常量中的所有字母必须大写&＃xff0c;单词之间以下划线分隔。
PSR-2编码风格规范
- PSR-1要求PHP代码以标签结束&＃xff0c;而应该以一个空白行结束。
- namespace声明后应该插入一个空白行&＃xff0c;use声明语句块后也应该要有一个空白行。不要在同一行代码中进行多次use声明。
- 类的开始和结束
class关键字、类名&＃xff0c;以及extends和implements关键字必须在同一行中。如果一个类实现了多个接口&＃xff0c;那么这些接口名可以在类声明的同一行中&＃xff0c;也可以各占一行。如果选择将这些接口名放在多行中&＃xff0c;那么第一个接口名必须自成一行&＃xff0c;而不是跟在implements关键字后面。类的开始花括号({)应该写在函数声明后自成一行&＃xff0c;结束花括号(})也应该写在类体后自成一行。也就是说&＃xff0c;类声明看起来如下所示
class EarthGame extends Game implementsPlayable,Savable
{//类体
}
也可以将类名与类声明放在同一行中。
class EarthGame extends Game implements Playble, Savable
{//类体
}
- 属性声明
每个属性都必须有访问修饰符(public、private或protected)。不可以使用关键字var声明属性。PSR-1中已经涵盖了属性名的规范:可以使用下划线、小写驼峰式命名或大写驼峰式命名方式&＃xff0c;但应该保持一致。(个人推荐属性采用小写式驼峰) - 方法的开始和结束
所有方法必须具有访问修饰符(public、private或protected)。访问修饰符必须在abstract或final之后&＃xff0c;static之前。具有默认值得方法参数应该放在参数列表的末尾。
- 单行声明
方法的开始花括号({)应该写在方法名后自成一行&＃xff0c;结束花括号(})也应该写在方法体后自成一行(直接跟在方法代码之后)。方法参数列表不应该以空格开始或结束(即应该紧贴包裹着它们的圆括号)。对于每个参数&＃xff0c;参数名(或默认值)后面应该有一个逗号&＃xff0c;且逗号后面有一个空格。这听起来似乎有些复杂&＃xff0c;如下所示:
final public static function generateTile(int $diamondCount, bool $polluted &＃61; false)
{//方法体
}
多行声明
如果方法有很多参数&＃xff0c;那么单行方法声明是不实际的。此时我们可以分割参数列表&＃xff0c;以便将每个参数(包括类型、参数变量、默认值和逗号)单独放在缩进的一行中。这种情况下&＃xff0c;结束圆括号应该放在参数列表后面一行中&＃xff0c;并与方法声明的开始位置对齐。开始花括号({)应该在同一行的结束圆括号之后&＃xff0c;以空格分隔。方法体应该从新的一行开始。同样&＃xff0c;这听起来似乎很复杂&＃xff0c;以下示例应该能帮助你理解这条规定。
public function __construct(int $size,string $name,bool $warparound &＃61; false,bool $aliens &＃61; false
) {//方法体
}
- 行与缩进
代码应该使用4个空格符来缩进&＃xff0c;而不是使用制表符。我们可以检查编辑器设置&＃xff0c;将其设置为按下Tab键时使用4个空格而不是制表符。每行代码的长度不应该超过120个字符。 - 方法与函数调用
方法名称和开始圆括号之间不能有空格。方法调用中的参数列表的规则与方法声明中的参数列表规则相同。换言之&＃xff0c;对于单行调用&＃xff0c;开始圆括号后或结束圆括号前不能有空格。每个参数之后应该紧跟一个逗号&＃xff0c;下一个参数前应该有一个空格。如果需要使用多行代码进行方法调用&＃xff0c;那么每个参数应该自成一行并缩进&＃xff0c;而且结束圆括号也应该自成一行。
$earthGanme &＃61; new EarthGame(5,&＃39;earth&＃39;,true,true
);
$earthGame::generateTile(5, true);
流程控制
流程控制关键字(if、for、while等)后面必须紧跟一个空格。但是&＃xff0c;开始圆括号后不能有空格。同样&＃xff0c;结束圆括号前不能有空格。因此内容应该紧贴在括号内的。与类和(单行)函数声明相比&＃xff0c;流程控制代码的开始花括号应该与结束圆括号在同一行。结束花括号应该自成一行。以下是一个简单的示例。
$title &＃61; [];
for ($x &＃61; 0; $x <$diamondCount; $x&＃43;&＃43;) {if ($polluted) {$title[] &＃61; new PollutionDecorator(new DiamondDecorator(new Plains()));} else {$title[] &＃61; new DiamondDecorator(new Plains());}
}
注意if和for之后的空格。for和if语句与圆括号在同一行&＃xff0c;而且它们的结束圆括号后都有一个空格&＃xff0c;然后是流程控制体的开始花括号。
以上内容希望帮助到大家&＃xff0c;很多PHPer在进阶的时候总会遇到一些问题和瓶颈&＃xff0c;业务代码写多了没有方向感&＃xff0c;不知道该从那里入手去提升&＃xff0c;对此我整理了一些资料&＃xff0c;包括但不限于&＃xff1a;分布式架构、高可扩展、高性能、高并发、服务器性能调优、TP6&＃xff0c;laravel&＃xff0c;YII2&＃xff0c;Redis&＃xff0c;Swoole、Swoft、Kafka、Mysql优化、shell脚本、Docker、微服务、Nginx等多个知识点高级进阶干货需要的可以免费分享给大家&＃xff0c;需要戳这里PHP进阶架构师>>>视频、面试文档免费获取
或 者关注我每天分享技术文章
PHP架构师之路www.zhihu.com
京公网安备 11010802041100号