这次的这篇文章介绍的是关于PHP规范中的psr规范,现在分享给大家,有兴趣的小伙伴可以看一看
参考:http://psr.phphub.org/
PSR 不是PHP官方标准,而是从如Zend、Symfony2等知名PHP项目中提炼出来的一系列标准,目前有越来越多的社区项目加入并遵循该标准。<br>
<br>
<br>
PSR-0 自动加载 X已废弃
PSR-1 基本代码规范
PSR-2 代码样式
PSR-3 日志接口
PSR-4 如何指定文件路径从而自动加载类定义
本篇规范制定了代码基本元素的相关标准,以确保共享的PHP代码间具有较高程度的技术互通性。
文件
· PHP代码文件 必须 以 <span style="color:#858080;background:#F9FAFA;"><?php</span>
或 <span style="color:#858080;background:#F9FAFA;"><?=</span>
标签开始;
· PHP代码文件 必须 以 <span style="color:#858080;background:#F9FAFA;">不带</span>
<span style="color:#858080;background:#F9FAFA;"> BOM </span>
<span style="color:#858080;background:#F9FAFA;">的</span>
<span style="color:#858080;background:#F9FAFA;"> UTF-8</span>
编码;
· PHP代码中 应该 只定义类、函数、常量等声明,或其他会产生 <span style="color:#FF0000;background:#F9FAFA;">副作用</span>
的操作(如:生成文件输出以及修改 .ini 配置文件等),二者只能选其一;
命名空间与类
· 类命名 必须 遵循 <span style="color:#858080;background:#F9FAFA;">StudlyCaps</span>
大写开头的驼峰命名规范;
· 每个类都独立为一个文件,且命名空间至少有一个层次:顶级的组织名称(vendorname)
类属性:小写开头驼峰 $studlyCaps
类方法:小写开头驼峰
常量
· 类中的常量所有字母都 必须 大写,单词间用下划线分隔;
方法名称 必须 符合 <span style="color:#858080;background:#F9FAFA;">camelCase</span>
式的小写开头驼峰命名规范。
缩进
· 代码 必须 使用4个空格符而不是「Tab 键」进行缩进。
行
每行的字符数 应该 软性保持在 80 个之内,一定不可 多于 120 个,但 一定不可 有硬性限制。
所有PHP文件必须以一个空白行作为结束。
每行 一定不可存在多于一条语句
每个 namespace 命名空间声明语句和 use 声明语句块后面,必须 插入一个空白行。
类的开始花括号({) 必须 写在函数声明后自成一行,结束花括号(})也 必须 写在函数主体后自成一行。
方法的开始花括号({) 必须 写在函数声明后自成一行,结束花括号(})也 必须 写在函数主体后自成一行。
控制结构的开始花括号({) 必须 写在声明的同一行,而结束花括号(}) 必须 写在主体后自成一行。
修饰符
类的属性和方法 必须 添加访问修饰符(private、protected 以及 public),abstract 以及final 必须 声明在访问修饰符之前,而 static 必须 声明在访问修饰符之后。
空格
类方法参数每个逗号后面必须要有一个空格,而逗号前面 一定不可 有空格
控制结构的开始左括号后和结束右括号前,都 一定不可 有空格符。
关键字
· 控制结构的关键字后必须要有一个空格符,而调用方法或函数时则一定不可有。
PHP所有 关键字 必须 全部小写,常量 true 、false 和 null 也 必须 全部小写。
<span style="color:#858080;background:#F9FAFA;">LoggerInterface</span>
接口对外定义了八个方法,分别用来记录 RFC 5424 中定义的八个等级的日志:debug、 info、 notice、 warning、 error、 critical、 alert 以及 emergency 。
第九个方法 —— log,其第一个参数为记录的等级。可使用一个预先定义的等级常量作为参数来调用此方法,必须 与直接调用以上八个方法具有相同的效果。如果传入的等级常量参数没有预先定义,则 必须 抛出Psr\Log\InvalidArgumentException 类型的异常。在不确定的情况下,使用者 不该 使用未支持的等级常量来调用此方法。
/**
* 日志等级常量定义
*/
class LogLevel
{
constEMERGENCY='emergency';
constALERT ='alert';
constCRITICAL ='critical';
constERROR ='error';
constWARNING ='warning';
constNOTICE ='notice';
constINFO ='info';
constDEBUG ='debug';
}
类似如下范例:
1. 完全合规类名必须有一个顶级命名空间(Vendor Name)
2. 完全合规类名可以有多个子命名空间
3. 完全合规类名应该有一个终止类名
4. 下划线在完全合规类名中是没有特殊含义的
5. 字母在完全合规类名中可以是任何大小写的组合
6. 所有类名必须以大小写敏感的方式引用
7. 终止类名对应一个以 .php 结尾的文件。文件名必须和终止类名大小写匹配
1. 不出现sql语句(sql封装到模型层然后作为方法调用)
2. sql语句、3行以上逻辑代码空行
3. 上下文关系函数或方法间不空行
4. bool使用if(true === $name)的形式
5. 使用双引号链接变量
6. 注意隐式转换
7. 使用全局变量需要注释其含义,取值范围
/**<br> * 全局变量总体说明<br> * Global STATUS_CODE<br> * 0 - SUCCESS<br> * 2 - ERROR<br> */<br>STATUS_CODE
8. 函数头部如下注释:
/*************************************************<br>Function: // 函数中文名称<br>Description: // 函数功能、性能等的描述<br>Calls: // 被本函数调用的函数清单<br>Called By: // 调用本函数的函数清单<br>Table Accessed: // 被访问的表(此项仅对于牵扯到数据库操作的程序)<br>Table Updated: // 被修改的表(此项仅对于牵扯到数据库操作的程序)<br>Input: // 输入参数说明,包括每个参数的作用、取值说明及参数间关系。<br>Output: // 对输出参数的说明。<br>Return: // 函数返回值的说明<br>Others: // 其它说明<br> *************************************************/
9. 注释间空行
// code one comments<br>program code one<br> <br>// code two comments<br>program code two
10. 文件头部注释
/************************************************************<br>Copyright (C), 1988-1999, Huawei Tech. Co., Ltd. // 版权<br>FileName: test.cpp // 文件名<br>Author: // 作者<br>Version : // 版本<br>Date: // 日期<br>Description: // 模块描述<br>Function List: // 主要函数及其功能<br>History: // 历史修改记录<br>
11. switch语句的case跳转需要注释
12. 标记变量的命名:
temp 可缩写为 tmp ;<br>flag 可缩写为 flg ;<br>statistic 可缩写为 stat ;<br>increment 可缩写为 inc ;<br>message 可缩写为 msg ;
13.接口的命名前缀
add / remove begin / end create / destroy<br>insert /delete first / last get / release<br>increment /decrement put / get<br>add /delete lock / unlock open / close<br>min /max old / new start / stop<br>next /previous source / target show / hide<br>send /receive source / destination<br>cut /paste up / down
14.状态码尽量使用常量,而不是难以理解的数字
应改为如下形式。<br>#defineTRUNK_IDLE 0<br>#define TRUNK_BUSY 1<br> <br>if (Trunk[index].trunk_state == TRUNK_IDLE)<br>{<br> Trunk[index].trunk_state = TRUNK_BUSY;<br> ... //program code<br>}
15. 类文件名使用首大写驼峰方式,普通文件名使用下划线方式
16. 配置里的变量名使用下划线方式
1. 变量自增自减写到表达式前面: --e >= $name
2. 程序顺序应该遵循:参数定义代码->判断逻辑代码->业务逻辑代码
3. 大的数据使用引用
4. 为逻辑代码里每个复杂度高/重复度高的代码添加注释
5. 尽量不为简短代码引入新的变量,减少变量污染
<br>
1、如果能将类的方法定义成static,就尽量定义成static,它的速度会提升将近4倍。
2、$row[’id’]的速度是$row[id]的7倍。
3、echo比print快,并且使用echo的多重参数(译注:指用逗号而不是句点)代替字符串连接,比如echo $str1,$str2。
4、在执行for循环之前确定最大循环数,不要每循环一次都计算最大值,最好运用foreach代替。
5、注销那些不用的变量尤其是大数组,以便释放内存。
6、尽量避免使用__get,__set,__autoload。
7、require_once()代价昂贵。
8、include文件时尽量使用绝对路径,因为它避免了PHP去include_path里查找文件的速度,解析操作系统路径所需的时间会更少。
9、如果你想知道脚本开始执行(译注:即服务器端收到客户端请求)的时刻,使用$_SERVER[‘REQUEST_TIME’]要好于time()。
10、函数代替正则表达式完成相同功能。
11、str_replace函数比preg_replace函数快,str函数的效率是str_replace函数的四倍。
12、如果一个字符串替换函数,可接受数组或字符作为参数,并且参数长度不太长,那么可以考虑额外写一段替换代码,使得每次传递参数是一个字符,而不是只写一行代码接受数组作为查询和替换的参数。
13、使用选择分支语句(译注:即switch case)好于使用多个if,else if语句。
14、用@屏蔽错误消息的做法非常低效,极其低效。
15、打开apache的mod_deflate模块,可以提高网页的浏览速度。
16、数据库连接当使用完毕时应关掉,不要用长连接。
17、错误消息代价昂贵。
18、避免递增全局变量
相关推荐:
关于php规范的PSR-4 关于雷锋的手抄报 关于春节的手抄报 关于春节的古
PHP规范之PSR-1 php语言 php手册 php开发工
以上是PHP规范之PSR规范的详细内容。更多信息请关注PHP中文网其他相关文章!