PSR规范

阅读更多

 

 

PSR规范-2

 

PSR-2 规范的官网链接在此：PSR-2 这一规范主要是约束代码风格的，可是说是所有里面最关键最重要的，也是需要好好规范和共同遵守的。 我们一个个来看下，只能我大略的写一些比较重要的，或者说平时用的最多的。

 

1、源文件

1. 文件末尾必须空一行。
2. 必须使用Unix LF(换行)作为行结束符。
3. 纯PHP代码源文件的关闭标签?>必须省略。

        第3点其实是蛮重要的，我之前还老写闭合，现在不写了。这可以避免在 PHP 结束标记之后万一意外加入了空格或者换行符，会导致 PHP 开始输出这些空白，而脚本中此时并无输出的意图。

 

 2、缩进

        必须使用4个空格来缩进，不能使用Tab键。当然你如果把Tab在编辑器里手动设置为4个空格也可以。这样的目的是因为：每个人的机器上的Tab键都不一样，有些是4个空格，有些是8个空格，在你的机器上看着很爽的代码，在别人机器上了就各种恶心了。所以，统一搞成4个空格，不管在哪里打开都是美观的。

 

3、行

 一行推荐的是最多写80个字符，多于这个字符就应该换行了，一般的编辑器是可以设置的。

 

 4、关键字和 True/False/Null

php的关键字，必须小写，boolean值：true，false，null 也必须小写

 

下面是php的keyword，必须小写。

 

'__halt_compiler', 'abstract', 'and', 'array', 'as', 'break', 'callable', 'case', 'catch', 'class', 'clone', 'const', 'continue', 'declare', 'default', 'die', 'do', 'echo', 'else', 'elseif', 'empty', 'enddeclare', 'endfor', 'endforeach', 'endif', 'endswitch', 'endwhile', 'eval', 'exit', 'extends', 'final', 'for', 'foreach', 'function', 'global', 'goto', 'if', 'implements', 'include', 'include_once', 'instanceof', 'insteadof', 'interface', 'isset', 'list', 'namespace', 'new', 'or', 'print', 'private', 'protected', 'public', 'require', 'require_once', 'return', 'static', 'switch', 'throw', 'trait', 'try', 'unset', 'use', 'var', 'while', 'xor'

 

5、命名空间(Namespace)和导入(Use)声明

先简单文字描述下：

1. 命名空间(namespace)的声明后面必须有一行空行。
2. 所有的导入(use)声明必须放在命名空间(namespace)声明的下面。
3. 一句声明中，必须只有一个导入(use)关键字。
4. 在导入(use)声明代码块后面必须有一行空行。

用代码来说明下：

 

   
  
 
 
  
namespace下空一行，才能使用use，再空一行，才能声明class
 
  
 
 
  
   
  
 
 
  
6、类(class)，属性(property)和方法(method)
 
  
 
 
  
（1）、继承(extends) 和实现(implement) 必须和 class name 写在一行，切花括号要换行写。
 
  
 
 
  
 
 
  
   
  （2）、属性(property)必须声明其可见性，到底是 public 还是 protected 还是 private，不能省略，也不能使用var, var是php老版本中的什么方式，等用于public。 
  
 
 
  
 
 
  
 
   （3）、方法(method)，必须 声明其可见性，到底是 public 还是 protected 还是 private，不能省略。并且，花括号{必须换行写。如果有多个参数，第一个参数后紧接, ,再加个空格，且函数name和( 之间必须要有个空格：function_name ($par, $par2, $pa3), 如果参数有默认值，也要用左右空格分开。 
  
 
 
  
 
 
  
   
  （4）、当用到抽象(abstract)和终结(final)来做类声明时，它们必须放在可见性声明 （public 还是protected还是private）的前面。而当用到静态(static)来做类声明时，则必须放在可见性声明的后面。 
  
 
 
  
直接上代码：
 
  
 
 
  
   
  
 
 
  
7、控制结构
 
  
 
 
  
控制接口，就是 if else while switch等。这一类的写法规范也是经常容易出现问题的，也要规范一下。
 
  
（1）、if，elseif，else写法，直接上规范代码吧：
 
  
 
  
 （2）、switch，case 注意左右空格和换行，还是直接上规范代码：
 
  
 
  
 （3）、while，do while 的写法也是类似，要左右空格，上代码：
 
  
 
  
 （4）、for的写法
 
  
 
  
 （5）、foreach的写法
 
  
 $value) { // 还是空格问题
    // foreach body
}
 
  
 
 
  
（6）、try catch的写法
 
  
 
  
 基本用到的就是这些了，其他什么闭包啥的用的不多就不过多的累述了。
 
  
 
 
  
PSR-4 规范
 
  
 
   
 
此处的“类”泛指所有的class类、接口、traits可复用代码块以及其它类似结构。
 
 
   
 
一个完整的类名需具有以下结构:
 
 
  
 
  
 \<命名空间>(\<子命名空间>)*\<类名>
 
  
 
   
 
完整的类名必须要有一个顶级命名空间，被称为 “vendor namespace”；
 
 
   
 
完整的类名可以有一个或多个子命名空间；
 
 
   
 
完整的类名必须有一个最终的类名；
 
 
   
 
完整的类名中任意一部分中的下滑线都是没有特殊含义的；
 
 
   
 
完整的类名可以由任意大小写字母组成；
 
 
   
 
所有类名都必须是大小写敏感的。
 
 
   
 
当根据完整的类名载入相应的文件……
 
 
   
 
完整的类名中，去掉最前面的命名空间分隔符，前面连续的一个或多个命名空间和子命名空间，作为“命名空间前缀”，其必须与至少一个“文件基目录”相对应；
 
 
   
 
紧接命名空间前缀后的子命名空间必须与相应的”文件基目录“相匹配，其中的命名空间分隔符将作为目录分隔符。
 
 
   
 
末尾的类名必须与对应的以 .php 为后缀的文件同名。
 
 
   
 
自动加载器（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

 
 
    
 
   
 
  
 
  
 
 
  
关于本规范的实现，可参阅 相关实例
注意：实例并不属于规范的一部分，且随时会有所变动。
 
  
 
 
  
 
 
  
参考文献：
 
  
https://www.kancloud.cn/thinkphp/php-fig-psr/3144
 
  
 
 
  
http://www.cnblogs.com/52php/p/5852572.html