PHP-PSR 现代PHPer的开发规范
psr是php standards recommendation的简称,意为php推荐标准。要想了解psr,首先得知道制定这一标准的人/组织是谁————php-fig。
php-fig
php-fig全称为php framework interop group,是一个组织,这个组织的成员由一些php框架的代表组成,这些人聚在一起“讨论框架之间的共性,寻找可以合作的方式”。php-fig制订了推荐规范,php框架可以自愿实现这些规范,改进其他框架的通信和共享功能。 php-fig的使命是实现框架之间的互操作性。
psr-1:基本的代码风格
在文章的最开始,我们就已经简单介绍过什么是psr,psr是php标准,而psr-1是php最基本也是最简单的标准。
php标签
必须把代码放在<?php ?>或<? ?>标签中。不得使用其它的标签句法
这点相信很多phper都很容易遵守,而且在现实撸代码中一般都是采用正常的<?php ?>
标签
编码
所有php文件都必须使用utf-8字符集编码,而且不能有字节顺序标记(byte order mark,bom)
这个也很常见,就是无bom和有bom格式,记得刚开始敲php代码的时候,前辈总是很关照,一定要用ide调成无bom格式啊,当时表示懵懂,然后就跟着做了,现在看到这里,又重新查了资料,找到了为什么不能使用有bom格式的原因,bom会产生多余的输出,就像平白无故多了一个空行:
php在处理bom头的时候,有时候存在错误,可能造成你在使用 header 或 session_start 之类的函数时,出现 文件已经输出的错误,多数都是因为bom头送出去了。。因为在php看来,成了一个空格。所以使用无bom的格式
目的
一个php文件可以定义符号(类、性状、函数、常量等),或者执行有副作用的操作(生成结果或者处理数据),但不能同时做两件事
这个规定的意思差不多就是一个变量、方法或者一个类,只能相应完成一个操作、做一件事情,这样保证了代码的清晰易懂,也保证了方法、变量的单一性,各司其职。其实也是为了方便,我们在以后项目/应用较大时,可以很好的解耦
自动加载
php的命名空间和类必须遵守psr-4自动加载器标准
后续看psr-4的具体解释
类的名称
php类的名称必须使用驼峰式,又名标题式
驼峰式和分词式(每个单词用_隔开)这两种写法,记得以前存在很大的争议,有人支持驼峰(girlfriend),有人支持分词式(girl_friend),现在好了,统一规定出来了,为了php更好的发展,那就委屈支持分词式的兄弟,统一驼峰了。记得公司的ci2项目,用的就是这种分词式,不过也是框架规定,后来在自己的项目中,自己有预感的使用了驼峰式,哈哈,为自己的眼光点赞~
常量的名称
php的常量名称必须大写;
这点应该是毋庸置疑的吧,最开始写php的时候,这个写法已经根深蒂固了。
方法的名称
使用驼峰式(boyfriend)
方法的命名和类的命名方式有些相似,不过还是有些区别:类的命名规定首字母大写(boyfriendmoney),而方法的命名规定首字母小写(boyfriendmoney)
psr-2:严格的代码风格
psr-2 相较于psr-1是更为严格的代码规范。个人和官方都认为开发者应该遵循更为严格的代码标准,在现代的php生态系统中,风格统一,可以更好的让其他开发者理解php代码。
贯彻psr-1
使用psr-2 之前先要贯彻psr-1
缩进
使用四个空格缩进。
关于缩进这个问题,相信有很多争议。我在真正正视这个问题之前,一直使用的都是ide的tab键。然后当同事和自己在编写同一文件的时候,就会出先代码缩进不一的情况,导致代码结构非常乱。所以在出现这个问题之后,就统一了一下文件缩进的标准,以四个空格为缩进。这样的话,就算是用不一致的编辑器打开,效果也是一样的。
很多ide都可以设置tab键,百度一下就可以搜到。
文件和代码行
php文件必须使用unix风格的换行符(lf),最后要有一个空行,而且不能使用php关闭 ?> 标签。
最开始我也不懂为什么在纯php页面中不使用关闭 ?>
标签,后来在书中找到了答案
为了避免意料之外的输出错误,如果加上关闭标签,而且在关闭标签后有空行,那么这个空行也被当成输出,导致错误(例如,设定http首部时)
关键字
关键字,要使用小写;
之前不知道在哪儿看的php的教程,上面写的php代码像true
、false
这样的关键字都使用的是大写true
、false
,我也一直在这样使用,后来看到psr-2的规范,才知道应该要使用小写,心累~
命名空间
每个命名空间语句后必须跟着一个空行。类似的,使用use关键字导入命名空间或为命名空间创建别名时,在一系列use声明语句后要加一个空行
类似于:
<?php // 声明本文件的命名空间 namespace my\friend; // 导入命名空间 use other\friend; class girlfrined { }
类
类定义体的起始括号应在类名之后另起一行写;
类定义体的结束括号必须在定义体之后新起一行写;
例:
<?php class frined { public function getsex() { // do something } }
方法
方法定义体的起始括号应在方法名之后另起一行写;
方法定义体的结束括号必须在方法定义体之后新起一行写;
请参考上面类示例中方法的例子。
可见性
1、类中的每个属性和方法都要声明可见性。可见性由public、protected或者private指定,其作用是决定在类的内部和外部如何访问属性的方法。
2、私有方法的名称前加上下划线
3、如果类属性声明为abstract和final,这两个限定符必须放在可见性关键字之前
4、如果属性、方法声明为static,这个限定符必须放在可见性关键字之后
例子:
// 1、2 public $sex; private $_sex; protected $sex; // 3、 abstract public $sex; final public $sex; // 4、 public static $sex; public static $age;
控制结构
所有控制结构关键字后面都要有一个空格。控制结构关键字包括:if、elseif、else、switch、case、while、do while、for、foreach、try、catch。如果控制结构关键字后面有一对圆括号,起始圆括号后面不能有空格,结束圆括号之前不能有空格。与类和方法的定义体不同,控制结构关键字后面的起始括号应该和控制机构关键字写在同一行。控制结构关键字后面的结束括号必须写在单独一行。
例:
/** * 错误的示例: * 这里有4个错误: * 1、if关键词后面和圆括号之前没有空格 * 2、圆括号前后有空格 * 3、后圆括号和起始括号之前没有空格 * 4、else关键词前后没有空格 **/ if( 1 == true ){ // do something }else{ // do something } /** * 正确的示例: **/ if (1 == true) { // do something } else { // do something }
psr-3:日志记录器接口
日志记录器
php-fig发布的第三个推荐规范和前两个不同,这个有点特殊,是一个接口。规定php日志记录器组件可以实现的方法。
日志记录器是对象,用于把不同重要程度的消息写入指定的输出。记录的消息用于诊断、检查和排除应用中的操作、稳定性和性能方面的问题。例如:开发的时候把调试信息写入到文本文件,把网站的流量统计信息记录到数据库等。
相信基本上所有的框架中都实现了日志功能,那么如果想要使用psr-3规范的日志记录器,该怎么做呢?首先要满足两点:
日志功能委托给第三方库实现
最终用户能选择他们喜欢的日志记录器组件
编写psr-3日志记录器
符合psr-3推荐规范的php日志记录器组件,必须包含一个实现psr\log\loggerinterface接口的php类。psr-3接口复用了rfc 5424系统日志协议,规定要实现9个方法:
下面的代码是我从php-fig的官网上拿过来的.
<?php namespace psr\log; interface loggerinterface { public function emergency($message, array $context = array()); public function alert($message, array $context = array()); public function critical($message, array $context = array()); public function error($message, array $context = array()); public function warning($message, array $context = array()); public function notice($message, array $context = array()); public function info($message, array $context = array()); public function debug($message, array $context = array()); public function log($level, $message, array $context = array()); }
这个类中的每一个方法都对应rfc 5424协议的一个日志级别,而且都接受两个参数。第一个参数必须是一个字符串,或者有一个__tostring()方法的对象。第二个参数为数组,可选参数;
如果要编写符合psr-3规范的日志记录器,那么就要创建一个实现psr\log\loggerinterface接口的php类,而且要提供这个接口中每个方法的具体实现
使用psr-3日志记录器
psr-3规范出来之后,达到这种效果的组件太多了,这里就不介绍,如何实现这个接口的类了。现在有成熟的日志记录器组件,推荐monolog/monolog。这个组件完全上线了psr-3的接口,而且可以使用自定义的消息格式化程序和处理程序扩展功能。
如果monolog满足不了日常的使用,我们可以在此基础上拓展自己的方法,也非常简单;
使用monolog示例:
<?php use monolog\logger; use monolog\handler\streamhandler; // 准备日志记录器 $logger = new logger('my_logger'); $logger->pushhandler(new streamhandler('logs/development.log', logger::debug)); $logger->pushhandler(new streamhandler('logs/production.log', logger::warning)); // 使用日志记录器 $logger->debug('this is debug message'); $logger->debug('this is warning message');
psr-4:自动加载器
php-fig发布的第四个推荐规范描述了一个标准的自动加载器策略;自动加载器的意思就是指在程序运行时按需查找php类、接口(interface)或性状(trait)并将其载入加载器。
自动加载器策略
psr-4推荐规范不要求改变代码的实现方式,只建议如何使用文件系统目录结构和php命名空间组织代码。psr-4**依赖**
php命名空间和文件系统目录结构查找并加载php类、性状和接口
为什么自动加载器很重要
举一个很常见的场景,我们引入文件通常都是采用require、include这样的方法,这样的方式简单也可靠,但是如果我们引入一两个还好说,但是当我们一个项目运行时需要引入几十个文件呢,那我们岂不是要写几十个require或者include?这样既不方便,又不美观,所以php-fig在此基础上考虑,规范了一个统一的自动加载器策略;
如何使用自动加载器
建议使用依赖管理器composer自动生成的psr-4自动加载器。
现代的php框架,laravel、yii、tp5等都使用了依赖composer的自动加载器策略,方便我们下载组件和引入合适的类。
psr-me:制定自己的php规范
- 遵循psr-1、psr-2的使用规范
- 合适、精简的变量、方法、类命名。能让人看一眼就清楚是做什么的
- 尽量编写出高内聚、低耦合的代码
- 保持代码结构整洁、美观
总结
php-fig推出的php规范,并不一定说所有的php开发者必须遵守。制定这一规范的目的就是为了,在全世界的php开发者在查看代码的时候,能更加简单和轻松。造出来的组件/*可以很容易的就被所有开发者熟知和使用,同时也减少了我们的工作投入率,得到更大的工作效率,使产出大于投入,效率更高更快。