首页 / PHP / PHP规范之PSR规范

PHP规范之PSR规范

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了PHP规范之PSR规范，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含7338字，纯文字阅读大概需要11分钟。

内容图文

这次的这篇文章介绍的是关于PHP规范中的psr规范，现在分享给大家，有兴趣的小伙伴可以看一看

参考：http://psr.phphub.org/

PSR 不是PHP官方标准，而是从如Zend、Symfony2等知名PHP项目中提炼出来的一系列标准，目前有越来越多的社区项目加入并遵循该标准。

PSR-0 自动加载 X已废弃
PSR-1 基本代码规范
PSR-2 代码样式
PSR-3 日志接口
PSR-4 如何指定文件路径从而自动加载类定义

PSR-1基本代码规范

本篇规范制定了代码基本元素的相关标准，以确保共享的PHP代码间具有较高程度的技术互通性。

文件

· PHP代码文件必须以 <?php 或 <?= 标签开始；

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

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

命名空间与类

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

· 每个类都独立为一个文件，且命名空间至少有一个层次：顶级的组织名称（vendorname）

类属性：小写开头驼峰 $studlyCaps
类方法：小写开头驼峰

常量

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

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

PSR-2编码风格规范

缩进

· 代码必须使用4个空格符而不是「Tab 键」进行缩进。

行

每行的字符数应该软性保持在 80 个之内，一定不可多于 120 个，但一定不可有硬性限制。
所有PHP文件必须以一个空白行作为结束。
每行一定不可存在多于一条语句
每个 namespace 命名空间声明语句和 use 声明语句块后面，必须插入一个空白行。
类的开始花括号（{）必须写在函数声明后自成一行，结束花括号（}）也必须写在函数主体后自成一行。
方法的开始花括号（{）必须写在函数声明后自成一行，结束花括号（}）也必须写在函数主体后自成一行。
控制结构的开始花括号（{）必须写在声明的同一行，而结束花括号（}）必须写在主体后自成一行。

修饰符

类的属性和方法必须添加访问修饰符（private、protected 以及 public），abstract 以及final 必须声明在访问修饰符之前，而 static 必须声明在访问修饰符之后。

空格

类方法参数每个逗号后面必须要有一个空格，而逗号前面一定不可有空格
控制结构的开始左括号后和结束右括号前，都 一定不可 有空格符。

关键字

· 控制结构的关键字后必须要有一个空格符，而调用方法或函数时则一定不可有。

PHP所有关键字必须全部小写，常量 true 、false 和 null 也必须全部小写。

PSR-3日志接口规范

LoggerInterface 接口对外定义了八个方法，分别用来记录 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';

}

PSR-4自动加载规范

类似如下范例：<NamespaceName>(<SubNamespaceNames>)*<ClassName>

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. 使用全局变量需要注释其含义，取值范围

/**
* 全局变量总体说明
* Global STATUS_CODE
* 0 － SUCCESS
* 2 － ERROR
*/
STATUS_CODE

8. 函数头部如下注释：

/*************************************************
Function: // 函数中文名称
Description: // 函数功能、性能等的描述
Calls: // 被本函数调用的函数清单
Called By: // 调用本函数的函数清单
Table Accessed: // 被访问的表（此项仅对于牵扯到数据库操作的程序）
Table Updated: // 被修改的表（此项仅对于牵扯到数据库操作的程序）
Input: // 输入参数说明，包括每个参数的作用、取值说明及参数间关系。
Output: // 对输出参数的说明。
Return: // 函数返回值的说明
Others: // 其它说明
*************************************************/

9. 注释间空行

// code one comments
program code one

// code two comments
program code two

10. 文件头部注释

/************************************************************
Copyright (C), 1988-1999, Huawei Tech. Co., Ltd. // 版权
FileName: test.cpp // 文件名
Author: // 作者
Version : // 版本
Date: // 日期
Description: // 模块描述
Function List: // 主要函数及其功能
History: // 历史修改记录
<author> <time> <version > <desc>
Lizhijian 17/10/11 1.0 init
***********************************************************/

11. switch语句的case跳转需要注释

12. 标记变量的命名：

temp 可缩写为 tmp ;
flag 可缩写为 flg ;
statistic 可缩写为 stat ;
increment 可缩写为 inc ;
message 可缩写为 msg ;

13.接口的命名前缀

add / remove begin / end create / destroy
insert /delete first / last get / release
increment /decrement put / get
add /delete lock / unlock open / close
min /max old / new start / stop
next /previous source / target show / hide
send /receive source / destination
cut /paste up / down

14.状态码尽量使用常量，而不是难以理解的数字

应改为如下形式。
#defineTRUNK_IDLE 0
#define TRUNK_BUSY 1

if (Trunk[index].trunk_state == TRUNK_IDLE)
{
Trunk[index].trunk_state = TRUNK_BUSY;
... //program code
}

15. 类文件名使用首大写驼峰方式，普通文件名使用下划线方式

16. 配置里的变量名使用下划线方式

1. 变量自增自减写到表达式前面： --e >= $name

2. 程序顺序应该遵循：参数定义代码->判断逻辑代码->业务逻辑代码

3. 大的数据使用引用

4. 为逻辑代码里每个复杂度高/重复度高的代码添加注释

5. 尽量不为简短代码引入新的变量，减少变量污染

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规范全部内容，希望文章能够帮你解决PHP规范之PSR规范所遇到的程序开发问题。如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容，请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端

扫描二维码推送至手机访问。

本文链接：https://qyyshop.com/info/138221.html

来源：【匿名】

【上一篇】SpringMVC代码实践之网站架构及演变【下一篇】PHP 5 数据对象 (PDO) 抽象层与 Oracle

更多 ►

【PHP规范之PSR规范】教程文章相关的互联网学习教程文章

php注释规范

php常用注释有三种：1、以‘‘#‘‘开始的单行注释符；2、以‘‘//‘‘开始的单行注释符；3、以‘‘/*‘‘和‘‘*/‘‘闭合的多行注释符。常用的php注释规范小结如下：/*** @name 名字* @abstract 申明变量/类/方法* @access 指明这个变量、类、函数/方法的存取权限* @author 函数作者的名字和邮箱地址* @category 组织packages* @copyright 指明版权信息* @const 指明常量* @deprecate 指明不推荐或者是废弃的信息MyEclipse编码设...

如何写PHP规范注释

所有的文档标记都是在每一行的 * 后面以@开头。如果在一段话的中间出来@的标记，这个标记将会被当做普通内容而被忽略掉。 @access 该标记用于指明关键字的存取权限：private、public或proteced 使用范围：class,function,var,define,module @author 指明作者 @copyright 指明版权信息 @const 使用范围：define 用来指明php中define的常量 @final 使用范围：class,function,var 指明关键字...

php的命名规范【图】

PHP书写规范匈牙利命名法+驼峰法命名感谢：http://my.oschina.net/u/2403409/blog/478191?fromerr=zaoJMSTo发表于10个月前(2015-07-14 08:56) 阅读（358） | 评论（0） 10人收藏此文章, 我要收藏赞0目录[-]PHP书写规范 PHP Coding StandardPHP书写规范 PHP Coding Standard变量命名规范这里感觉打算采用匈牙利命名法+驼峰法命名，因为 PHP是弱类型语言，很多时间因为忽略了变量类型而导致犯一些低级错误。所以在前面加上类型名...

PHP编码规范

1.文件格式所有php文件使用完整的php标签，如<?php ？>纯php代码文件，末尾不需要写 ?>2.文件和目录命名程序文件名和目录名均采用有意义的英文命名类统一采用：DemoTest.class.php接口统一采用：DemoTest.interface.php其他按照各自的方式：demoTest.{style}.php其他一些文件按照：demoTest.inc.php zend/demo.lib.php3.文件目录结构app　　独立的应用class 单个的类文件，...

PHP 权威代码风格规范

1、常规尽量统一ide 比如phpstream 配置文件(Settings → Code Style → PHP → Set from... → Predefined Style → PSR1/PSR2) 看标准操作缩进一定要用4个空格代替tab键文件名 StudlyCaps类名 StudlyCaps常量大写字母单词 _ 分隔单词方法变量属性 camelCase私有属性 __开头代码列最好不要超过 120单个函数不要超过 100 行2、文件文件命名 StudlyCaps文件最好统一utf-8 不带BOM纯php 文件不要加 ?>结束3、关于换行和空格名...

php设计模式一之命名空间、自动加载类、PSR-0编码规范

本篇文章介绍的内容是php设计模式一之命名空间、自动加载类、PSR-0编码规范，现在分享给大家，有需要的朋友可以参考一下一、命名空间：解决在生产环境中多人协同开发时出现类名或函数名冲突的问题；test1.php<?php namespace Test1; function test(){echo "Test1命名空间下的test()方法"; } ?>test2.php<?php namespace Test2; function test(){echo "Test2命名空间下的test()方法"; } ?>test.php<?php require_once(test1.php); ...

PHPPSR-3日志接口规范

日志接口规范本文制定了日志类库的通用接口规范。本规范的主要目的，是为了让日志类库以简单通用的方式，通过接收一个 Psr\Log\LoggerInterface 对象，来记录日志信息。框架以及CMS内容管理系统如有需要，可以对此接口进行扩展，但需遵循本规范，这才能保证在使用第三方的类库文件时，日志接口仍能正常对接。关键词 “必须”("MUST")、“一定不可/一定不能”("MUST NOT")、“需要”("REQUIRED")、“将会”("SHALL")、“不会”("...

PDP Document 代码注释规范第1/2页

1. 什么是phpDocumentor ? PHPDocumentor是一个用PHP写的工具，对于有规范注释的php程序，它能够快速生成具有相互参照,索引等功能的API文档。老的版本是 phpdoc，从1.3.0开始，更名为phpDocumentor，新的版本加上了对php5语法的支持，同时，可以通过在客户端浏览器上操作生成文档，文档可以转换为PDF,HTML,CHM几种形式，非常的方便。 PHPDocumentor工作时，会扫描指定目录下面的php源代码，扫描其中的关键字，截取需要分析的注释，...

PHP编码规范之注释和文件结构说明

PHP文件注释标记及规范小结

PHP 注释标记 @access 使用范围：class,function,var,define,module 该标记用于指明关键字的存取权限：private、public或proteced @author 指明作者 @copyright 使用范围：class，function，var，define，module，use 指明版权信息 @deprecated 使用范围：class，function，var，define，module，constent，global，include 指明不用或者废弃的关键字 @example 该标记用于解析一段文件内容，并将他们高亮显示。Phpdoc会试图从该标记...

PHP 代码规范小结

命名规范 Θ 类文件都以.class.php为后缀，使用驼峰法命名，并且首字母大写，例如 Pay.class.php; Θ 类名和目录_文件名一致。例如:类名Zend_Autoloader的目录是Zend/Autoloader.class.php; Θ 函数的命名使用小写字母和下划线的方式。例如:get_client_ip; Θ 方法的命名使用驼峰法，首字母小写或者使用下划线"_"，例如listComment(),_getResource(),通常下划线开头的方法属于私有方法; Θ 属性的命名使用驼峰法，首字母小写或者使...

php 注释规范【代码】

用过IDE或看过其他源码的小伙伴们应该都见过类似下面这样的注释 /*** 递归获取所有游戏分类* @param int $id* @return array*/看得多了就大概知道了一些规律。为了使自己的代码更加规zhuang范bi，也开始有样学样地写着这些注释其实这种注释格式是有自己的名字的，它就叫—— PHPDOCPHPDoc 是一个 PHP 版的 Javadoc。它是一种注释 PHP 代码的正式标准。它支持通过类似 phpDocumentor 这样的外部文档生成器生成 API 文档，也可以帮助...

PHP - 技术教程分类

PHP 教程 PHP 简介 PHP 安装 PHP 语法 PHP 变量 PHP echo/print PHP EOF(heredoc) PHP 数据类型 PHP 类型比较 PHP 常量 PHP 字符串 PHP 运算符 PHP If...Else PHP Switch PHP 数组 PHP 数组排序 PHP 超级全局变量 PHP While 循环 PHP For 循环 PHP 函数 PHP 魔术常量 PHP 命名空间 PHP 面向对象 PHP 测验 PHP 表单 PHP 表单验证 PHP 表单 - 必需字段 PHP 完整表单实例 PHP $_GET 变量 PHP $_POST 变量 PHP 多维数组 PHP 日期 PHP 包含 PHP 文件 PHP 文件上传 PHP Cookie PHP Session PHP E-mail PHP Error PHP Exception PHP 过滤器 PHP 7 新特性 PHP MySQL 简介 PHP MySQL 连接 PHP MySQL 创建数据库 PHP MySQL 创建数据表 PHP MySQL 插入数据 PHP MySQL 插入多条数据 PHP MySQL 预处理语句 PHP MySQL 读取数据 PHP MySQL Where PHP MySQL Order By PHP MySQL Update PHP MySQL Delete PHP ODBC AJAX 简介 AJAX PHP AJAX 数据库 AJAX 实时搜索 AJAX 投票 PHP Array PHP Calendar PHP cURL PHP Date PHP Directory PHP Error PHP Filesystem PHP Filter PHP FTP PHP HTTP PHP Mail PHP Math PHP Misc PHP MySQLi PHP PDO PHP String PHP Zip PHP Timezones PHP 图像处理 PHP RESTful PHP PCRE PHP 可用的函数 PHP Composer php 全部

PHP - 最热教程

php如何取出数组的前几个元素 PHP变量什么时候释放 PHP如何实现在数据库随机获取几条记录如何解决php base64解码乱码 php主要用于哪些领域 Laravel 批量插入(insert)数据六款国内优秀免费wordpress主题推荐 React如何从后端获取数据并渲染到前端？纯PHP实现定时器任务（Timer），php实现...php该如何安装pdo_mysql扩展

首页 / PHP / PHP规范之PSR规范

PHP规范之PSR规范

内容导读

内容图文

PSR-1基本代码规范

PSR-2编码风格规范

PSR-3日志接口规范

PSR-4自动加载规范

一些常用的自定义规范

控制层

内容总结

内容备注

内容手机端

【PHP规范之PSR规范】教程文章相关的互联网学习教程文章

php注释规范

如何写PHP规范注释

php的命名规范【图】

PHP编码规范

PHP 权威代码风格规范

php设计模式一之命名空间、自动加载类、PSR-0编码规范

PHPPSR-3日志接口规范

PDP Document 代码注释规范第1/2页

PHP编码规范之注释和文件结构说明

PHP文件注释标记及规范小结

PHP 代码规范小结

php 注释规范【代码】

PHP编程风格规范分享

PHP的PSR规范中文版

PHP注释语法规范与命名规范详解篇

PHP - 相关标签

PHP - 技术教程分类

PHP - 最新教程

PHP - 最热教程