PHP规范之PSR规范

最新推荐文章于 2024-08-15 09:29:09 发布
最新推荐文章于 2024-08-15 09:29:09 发布
阅读量1.9k 收藏 13
点赞数 3
分类专栏： 后端 文章标签： PHP规范 PSR规范 PHP
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u013933858/article/details/79780179
版权

参考：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-[0-4]规范

				
			

			

				

					domorejojo
				

				

					01-18
					
					7083
					
				

			

		

		

			
				
PHP中PSR-0，PSR-1,PSR-2,PSR-3,PSR-4规范的用法以及使用。

			
		

	



                

            
              



	

		

			

				
					
PHP符合PSR编程规范的实例分享

				
			

			

				

					12-18
				

			

		

		

			
				
其中Composer的自动加载就支持PHP-FIG指定的PSR-0 和 PSR-4 规范来实现自动加载机制，并且Composer推荐使用PSR-4  PHP-FIG  这是一个自愿非正式的机构，但是就目前对我们的影响来看，可能都已经默认为一个公信组织了...

			
		

	



              


  
              

                


	

		

			

				
					
PSR : php编码规范

				
			

			

				

					weixin_33893473的博客
				

				

					10-11
					
					78
					
				

			

		

		

			
				
诸王混战关于开发标准这块，可以说一直都是风格迥异，各家都有各家的玩法，民间更是个人玩个人的。目前我们国内比较出名的几个框架（Yii,Laravel） 都已经支持Composer并且加入了PHP-FIG（php框架程序组）。其中Composer的自动加载就支持PHP-FIG指定的PSR-0 和 PSR-4 规范来实现自动加载机制，并且Composer推荐使用PSR-4PHP-F...

			
		

	





	

		

			

				
					
探索PSR-7消息实现的强大功能

					
最新发布

				
			

			

				

					gitblog_01133的博客
				

				

					08-15
					
					295
					
				

			

		

		

			
				
探索PSR-7消息实现的强大功能
 psr7PSR-7 HTTP message library项目地址:https://gitcode.com/gh_mirrors/ps/psr7 在现代Web开发中，HTTP消息的处理是不可或缺的一部分。今天，我们将深入探讨一个强大的开源项目——PSR-7消息实现，它为PHP开发者提供了一套完整的工具集，用于处理HTTP消息和流操作。
项目介绍
PSR-7消息...

			
		

	



		

			
		



	

		

			

				
					
PSR规范

				
			

			

				

					zhengwish的专栏
				

				

					06-22
					
					9365
					
				

			

		

		

			
				
摘录自：https://github.com/PizzaLiu/PHP-FIG


目前包括以下几个规范：
PSR-0（弃用）
PSR-1
PSR-2
PSR-3
PSR-4


1.PSR-0
自动加载规范，此规范已被启用-本规范已于2014年10月21日被标记为弃用，目前新的替代规范为【PSR-4】
本文是为自动加载器实现通用自动加载所需要遵循的编码规范


一

			
		

	





	

		

			

				
					
PHP编码规范

				
			

			

				

					weixin_34365417的博客
				

				

					02-10
					
					90
					
				

			

		

		

			
				
为什么需要编码规范？


为了提高工作效率，保证开发的有效性和合理性。

为了提高代码可读性和可重复利用性，从而节约沟通成本。


本文主要参考了 PEAR 规范，并进行适当的简化和调整。
主要介绍，命名规范、注释规范、代码风格。

文件标记

所有PHP文件，代码标记均使用完整的PHP标签，不建议使用短标签。
&lt;?php
  echo 'Hello world';
?&gt;

&lt;...

			
		

	





	

		

			

				
					
PHP编码规范之PSR-4

				
			

			

				

					大愚Talk
				

				

					05-09
					
					1885
					
				

			

		

		

			
				
Autoloader关键词 “必须”(“MUST”)、“一定不可/一定不能”(“MUST NOT”)、“需要”(“REQUIRED”)、 “将会”(“SHALL”)、“不会”(“SHALL NOT”)、“应该”(“SHOULD”)、“不该”(“SHOULD NOT”)、 “推荐”(“RECOMMENDED”)、“可以”(“MAY”)和”可选“(“OPTIONAL”)的详细描述可参见 [RFC 211

			
		

	





	

		

			

				
					
PHP编码规范PSR（中文版）

				
			

			

				

					08-08
				

			

		

		

			
				
PHP编码规范PSR（中文版）

			
		

	





	

		

			

				
					
php psr2 注释规范

				
			

			

				

					qq_24038207的博客
				

				

					03-09
					
					637
					
				

			

		

		

			
				
1. 文档头部注释

设置 &gt; Editor &gt; File and Code Templates &gt; Includes选项卡 &gt; PHP File Header

/**
* Created by ${PRODUCT_NAME}.
* User: *****
* Date: ${DATE}
* Time: ${TIME}
* PHP version 7

* ...

			
		

	





	

		

			

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

				
			

			

				

					10-29
				

			

		

		

			
				
理解学习PHP编码规范之注释和文件结构，编写规则的代码与目录结构让大家能快速的熟悉。提高协同工作效率。

			
		

	





	

		

			

				
					
vim php psr,PHP开发 之 注解

				
			

			

				

					weixin_29009881的博客
				

				

					03-09
					
					113
					
				

			

		

		

			
				
目录开始mkdir annotation && cd annotationmkdir -p module/Basevim module/Base/Description.phpnamespace Base;class Description{public $desc = 'default';}vim composer.json{"autoload": {"psr-4": {"Bas...

			
		

	





	

		

			

				
					
psr 规范

				
			

			

				

					Mr Qiang
				

				

					11-18
					
					215
					
				

			

		

		

			
				
不知不觉，psr 已经更新了这么多的版本了，加油，学习起来
中文网址：http://phpfig.p2hp.com/
英文网址：https://www.php-fig.org/



			
		

	





	

		

			

				
					
php psr编码规范

				
			

			

				

					雪锋的笔记
				

				

					07-05
					
					385
					
				

			

		

		

			
				
psr1psr2psr3psr4

			
		

	





	

		

			

				
					
php中的psr规范详情,PSR规范

				
			

			

				

					weixin_34354231的博客
				

				

					03-19
					
					225
					
				

			

		

		

			
				
PSR是 PHP Standard Recommendation的缩写，即PHP推荐标准。### **PSR-0(自动加载规范)已作废**1.一个完全合格的命名空间和类名必须遵循以下结构 "\VendorName\Namespace\ClassName"2.每个命名空间必须有顶级的命名空间 "VendorName"3.每个命名空间可以有任意多个子命名空间4.每个命名空间在被文件系统加载时必须被转换...

			
		

	





	

		

			

				
					
PHP的PSR规范

				
			

			

				

					懵懂听风雨
				

				

					09-16
					
					423
					
				

			

		

		

			
				
PSR规范
PSR官网：https://www.php-fig.org/psr/
github中文PSR解释：https://github.com/PizzaLiu/PHP-FIG



			
		

	





	

		

			

				
					
PSR-PHP标准规范

				
			

			

				

					技术的搬运工
				

				

					02-28
					
					283
					
				

			

		

		

			
				
简介


PSR 是 PHP Standard Recommendations 的简写，由 PHP FIG 组织制定的 PHP 规范，是 PHP 开发的实践标准。
PHP FIG，FIG 是 Framework Interoperability Group（框架可互用性小组）的缩写，由几位开源框架的开发者成立于 2009 年，从那开始也选取了很多其他成员进来（包括但不限于 Laravel, Joo...

			
		

	





	

		

			

				
					
PHP开发者的必读：PSR规范中文解读

				
			

			

				

					
				

			

		

		

			
				
"PHP的PSR规范中文版是由FIG组织制定的PHP相关代码规范，包括PSR-0自动加载、PSR-1基本代码规范、PSR-2代码样式和PSR-3日志接口。这些规范旨在促进PHP项目的协作编程，提高代码可读性和维护性。建议PHP开发者关注并...

			
		

	



              




          




        



    





    



      

      

        
      

      





	

		评论	
	

	
	




  

    

      添加红包
      
    

    

      

        
        

          
          
        

        
请填写红包祝福语或标题

      

      

        
        

          
          个
        

        
红包个数最小为10个

      

      

        
        

          
          元
        

        
红包金额最低5元

      

      

        
        

          当前余额3.43元
          前往充值 >
        

      

      

        

          需支付：10.00元
        

        
        
      

    

  





  

    
    
  

  

    
    
  








  

    

      

        

          

            
            
成就一亿技术人!

          

          

        

        

          

          

            领取后你会自动成为博主和红包主的粉丝
            规则
          

        

      

      

        

          

            
              
            
            

              
hope_wisdom
 发出的红包
            

          

        

        

          

          

          

        

      

    

    

  



      
      

      
实付元

      
使用余额支付

      

        

          

            
            点击重新获取
          

        

        
扫码支付

      

      

        
          
            
          
          
        
      

      

        
        钱包余额
          0
          

            
            

              

                
抵扣说明：

                
 1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
 2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

              

            

          

      

      余额充值