PHP DIY系列| PSR

Posted 2021-03-30 爱好历史的程序员

 
   
   
 

  
    
    
  
php DIY系列--一起手写一个api框架
 
   
   
 

在开发框架之前，我来介绍框架开发遵循的规范。

大多数编程语言都有自己的一套编码规范，作为“世界上最好的语言”，PHP当然也有自己的编码规范。这个规范就是PHP Standard Recommendation（简称PSR）。

当然，从我自己的工作中，我发现很多PHP程序员尤其是初级程序员，是不知道PHP是有这么一个规范的，我认为这是不科学的。

什么是PSR？

介绍PSR之前需要介绍一下制定此规范的组织-----PHP-FIG，全称是PHP Framework Interoperability。

组织成员制定规范，并且落实在自己的项目中，虽然不是官方组织，但也代表了大部分PHP社区项目，如CakePHP，Composer，Drupal，PEAR，Slim，Yii framework，Zend Framework等。并且有越来越多的项目加入并遵循此标准。

PSR项目的目的在于：通过框架作者或者框架的代表之间讨论，以最低程度的限制，制定一个协作标准，各个框架遵循统一的编码规范，让工程师一起更好协同工作。

截止目前，已经官网已有20条列出，除去起草中和舍弃的，有以下13条。

---

我们不妨来看看这些规范：

PSR-1 基础编码规范

• PHP 代码文件必须以

• PHP 代码文件必须以不带BOM的UTF-8编码

• PHP 代码中 应该 只定义类、函数、常量等声明，或其他会产生 副作用 的操作（如：生成文件输出以及修改 .ini 配置文件等），二者只能选其一

• 命名空间以及类必须符合 PSR 的自动加载规范PSR-4

• 类的命名必须遵循 StudlyCaps 式大写开头的驼峰命名规范

• 类中的常量所有字母都必须 大写，单词间用下划线分隔

• 方法名称必须符合 camelCase 式的小写开头驼峰命名规范

PSR-12 代码风格规范

PSR-12的规范很细致，包含了声明、命名空间、类及继承以及控制结构等说明。

我们先来看一个demo：

 
   
   
 

  
    
    
  
<?php
  
    
    
  


  
    
    
  
declare(strict_types=1);
  
    
    
  


  
    
    
  
namespace Vendor\Package;
  
    
    
  


  
    
    
  
use Vendor\Package\{ClassA as A, ClassB, ClassC as C};
  
    
    
  
use Vendor\Package\SomeNamespace\ClassD as D;
  
    
    
  


  
    
    
  
use function Vendor\Package\{functionA, functionB, functionC};
  
    
    
  


  
    
    
  
use const Vendor\Package\{ConstantA, ConstantB, ConstantC};
  
    
    
  


  
    
    
  
class Foo extends Bar implements FooInterface
  
    
    
  
{
  
    
    
  
 public function sampleFunction(int $a, int $b = null): array
  
    
    
  
 {
  
    
    
  
 if ($a === $b) {
  
    
    
  
 bar();
  
    
    
  
 } elseif ($a > $b) {
  
    
    
  
 $foo->bar($arg1);
  
    
    
  
 } else {
  
    
    
  
 BazClass::bar($arg2, $arg3);
  
    
    
  
 }
  
    
    
  
 }
  
    
    
  


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

• 代码 必须 遵循 [PSR-1] 中的编码规范

• 所有PHP文件必须使用Unix LF (linefeed)作为行的结束符；

• 所有PHP文件必须以一个空白行作为结束；

• 纯PHP代码文件必须省略最后的 ?> 结束标签

• 每行的字符数 应该软性保持在 80 个之内，理论上 一定不可 多于 120 个，但一定不可有硬性限制；非空行后一定不能有多余的空格符；

• 空行可以使得阅读代码更加方便以及有助于代码的分块。

• 每行一定不能存在多于一条语句

• 代码必须使用4个空格符的缩进，一定不能用 tab键

• PHP所有关键字必须全部小写

• 控制结构的基本规范如下：

 
   
   
 

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

代码风格规范内容很多，这里就不一一说明了，大家可自行阅读

PSR-4 自动加载

关于由文件路径 自动载入 对应类的相关规范， 本规范是可互操作的，可以作为任一自动载入规范的补充，其中包括 PSR-0，此外， 本 PSR 还包括自动载入的类对应的文件存放路径规范。

1. 
   

   此处的“类”泛指所有的class类、接口、traits可复用代码块以及其它类似结构。

   
   

2. 
   

   一个完整的类名需具有结构\<命名空间>(\<子命名空间>)\<类名>:

   
   

1. 完整的类名必须要有一个顶级命名空间，被称为 "vendor namespace"；

2. 完整的类名可以有一个或多个子命名空间；

3. 完整的类名必须有一个最终的类名；

4. 完整的类名中任意一部分中的下划线都是没有特殊含义的；

5. 完整的类名可以由任意大小写字母组成；

6. 所有类名都必须是大小写敏感的。

3. 
   

   当根据完整的类名载入相应的文件……

   
   

1. 完整的类名中，去掉最前面的命名空间分隔符，前面连续的一个或多个命名空间和子命名空间，作为“命名空间前缀”，其必须与至少一个“文件基目录”相对应；

2. 紧接命名空间前缀后的子命名空间必须与相应的”文件基目录“相匹配，其中的命名空间分隔符将作为目录分隔符。

3. 末尾的类名必须与对应的以 .php 为后缀的文件同名。

4. 自动加载器（autoloader）的实现一定不能抛出异常、一定不能触发任一级别的错误信息以及不应该有返回值。

例子

下表展示了符合规范完整类名、命名空间前缀和文件基目录所对应的文件路径。

完整类名	命名空间前缀	文件基目录	文件路径
\Acme\Log\Writer\File_Writer	Acme\Log\Writer	./acme-log-writer/lib/	./acme-log-writer/lib/File_Writer.php
\Aura\Web\Response\Status	Aura\Web	/path/to/aura-web/src/	/path/to/aura-web/src/Response/Status.php
\Symfony\Core\Request	Symfony\Core	./vendor/Symfony/Core/	./vendor/Symfony/Core/Request.php
\Zend\Acl	Zend	/usr/includes/Zend/	/usr/includes/Zend/Acl.php

暂且只介绍这比较常用的三个规范。

更多最新规范建议点击查看

---

本节主要介绍了PHP的编码规范PSR，建议大家在开发中尽量遵循此规范，特别是团队开发的时候，我们不应该各自有着各自的编码风格，应该尽可能统一风格。正如PHP-FIG组织的初衷所说，他们建立的规范不是限制大家的编码自由，只是寻找共性，为了我们一起更好的协同工作。