psr规范

来源:互联网 发布:稚优泉面膜知乎 编辑:程序博客网 时间:2024/05/21 02:53

PHP Standard Recommendations,一共5个规范psr[0-4],psr-0已经弃用。


PSR-1 基本代码规范

        

  • PHP代码文件必须以<?php 或<?= 标签开头
  • PHP代码文件必须以不带BOM的UTF-8编码
  • PHP代码中应该只定义类、函数、常量等声明,或其他会产生从属效应的操作(生成文件输出以及修改.ini配置文件等),二者只能选其一
  • 命名空间以及类必须符合PSR的自动加载规范:PSR-4;
  • 类的命名必须遵循StudlyCaps大写开头的驼峰命名规范;
  • 类中的常量所有字母都必须大写,单词间用下划线分隔;
  • 方法名称必须符合camelCase式的小写开头驼峰命名规范


PSR-2 代码风格规范

 

  • 代码必须遵循PSR-1中的编码规范
  • 代码必须使用四个空格符而不是tab键进行缩进。
  • 每行的字符数应该软性保持在80个内,理论上不可多于120个,但一定不能由硬性限制
  • 每个namespace命名空间声明语句和use声明语句块后面,必须插入一个空白行
  • 类的开始花名号({)必须在函数声明后自成一行,结束花名号(})也必须在函数主体后自成一行
  • 类的属性和方法必须添加访问修饰符(private protected以及public),abstract以及final必须声明在访问修饰符之前,而static必须声明在访问修饰符之后。
  • 控制结构的关键字后必须要有一个空格符,而调用方法或函数时则一定不能有。
  • 控制结构的开始花括号({)必须写在声明的同一行,而结束花括号(})必须写在主体后自成一行。
  • 控制结构的开始左括号后和结束右括号前,都一定不能有空格符。

PSR-3 日志接口规范


  • LoggerInterface 接口对外定义了八个方法,分别用来记录RFC 5424中定义的八个登记日志:debug、info、notice、warning、error、critical、alert以及emergency。
  • 第九个方法-log,其第一个参数为记录的等级,可使用一个预先定义的等级常量作为参数来调用此方法,必须与直接调用以上八个方法具有相同的效果。如果传入的等级常量参数没有预先定义,就必须抛出Psr\Log\InvalidArgumentException类型的异常,在不确定的情况下,使用者不该使用为支持的等级常量来调用此方法。

PSR-4 由文件路径自动载入类的规范


  • 此处的“类”泛指所有的class类、接口、traits可复用代码块以及其他类似结构。
  • 一个完整的类名需要具有以下结构
  • \<命名空间>(\<子命名空间>)*\<类名>
  • 1.完整的类名必须要有一个顶级命名空间,被称为“Vendor namespace”
  • 2.完成的类名可以有一个或多个子命名空间
  • 3.完整的类名必须有一个最终的类名
  • 4.完整的类名中任意一部分中的下划线都是没有特殊意义的
  • 5.完整的类名可以由任意大小写字母组成
  • 6.所有类名都必须是大小写敏感的
  • 当根据完整的类名载入相应的文件......
  • 1.完整的类名中,去掉最前面的命名空间分隔符,前面连续的一个或多个命名空间和子命名空间,作为“命名空间前缀”,其必须与至少一个“文件基目录”相对应。
  • 2.紧接命名空间前缀后的子命名空间必须与相对应的“文件基目录”相匹配,其中的命名空间分隔符作为目录分割符
  • 3.末尾的类名必须与对应的.php为后缀的文件同名
  • 4.自动加载器(autoloader)的实现一定不能抛出异常,一定不能触发任一级别的错误信息以及不应该有返回值。

 

原创粉丝点击