PHP 标准建议psr

2024-06-20 07:52
文章标签 php 建议 标准 psr

本文主要是介绍PHP 标准建议psr,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

PSR-1: Basic Coding Standard(基础编码标准)

PSR-1 定义了PHP代码文件的基本编写规范,它关注的是代码文件的结构和一些通用的编程约定,主要包括:

  • 文件命名:PHP文件必须以.php为后缀。
  • PHP标签:所有PHP代码文件必须以<?php开头,不鼓励使用短标签 <?
  • 命名空间和类名:每个文件应只包含一个顶级命名空间声明,并且类的命名必须与文件名(不包括.php后缀)相匹配。
  • 类的声明:类的开放和关闭标签必须各自独占一行。
  • 代码行结束:文件必须以一个空白行结束。
  • 注释:文档块注释(如类和方法的注释)必须遵循PHPDoc标准。

PSR-2: Coding Style Guide(编码风格指南)

PSR-2 则更加详细,它建立在PSR-1的基础之上,提供了一套详细的代码格式化和布局规则,目的是提高代码的可读性和一致性。PSR-2涵盖的规范包括但不限于:

  • 缩进:必须使用4个空格进行缩进,禁止使用制表符。
  • 控制结构:如if、for、foreach、switch等语句的关键字后必须有空格,而其后的大括号必须另起一行,且与其对应的语句在同一列开始。
  • 函数和方法的调用:函数和方法的调用时,其后的开括号必须与函数名在同一行,而闭括号必须在参数列表结束后的新行。
  • 控制结构的括号:即使只有一个控制表达式,也必须使用括号包围。
  • 属性和方法的声明:类的属性和方法之间需要有空行分隔,方法的参数列表中的逗号后面应加空格。

PSR-3: Logger Interface(日志接口)

PSR-3 定义了一个通用的日志记录接口(Logger Interface),它提供了一套标准化的方法来记录不同级别的日志信息(例如DEBUG、INFO、WARNING、ERROR、CRITICAL、ALERT、EMERGENCY)。这个接口的目的是为了让开发者能够在不同的日志处理组件之间轻松切换,而不必修改日志记录的代码逻辑。通过实现这一接口,日志库可以确保兼容性,使得应用程序能够更容易地整合不同的日志处理解决方案。

PSR-4: Autoloading Standard(自动加载标准)

PSR-4 是关于类的自动加载机制的规范,它是对早先PSR-0的改进。PSR-4主要关注如何根据类的命名空间和类名来定位类文件的实际路径。这个标准建议类文件的位置应该与其命名空间和类名的结构相对应,从而使得自动加载器可以根据类名直接推断出文件的路径,而无需维护复杂的类映射表。具体来说:

  • 命名空间的命名应与目录结构相匹配。
  • 类文件的命名必须是其类名加上.php后缀。
  • 自动加载器只需查找与命名空间前缀对应的目录,然后在该目录下寻找与类名匹配的文件。

遵循PSR-4可以极大地简化大型项目中类文件的管理和自动加载过程,提高开发效率并减少错误。

其他psr

PSR-0(已废弃,被PSR-4替代)

  • 标题:Autoloading Standard(自动加载标准)
  • 状态:废弃,由PSR-4取代。
  • 内容:曾定义了基于命名空间和类名的类文件自动加载规则,但已被更灵活的PSR-4所替代。

PSR-6:Caching Interface(缓存接口)

  • 内容:定义了一套缓存接口,使得开发者可以创建和使用遵循统一接口的缓存存储和缓存项。

PSR-7:HTTP Message Interface(HTTP消息接口)

  • 内容:为HTTP请求和响应消息定义了一套接口,促进了HTTP中间件和库之间的互操作性。

PSR-11:Container Interface(容器接口)

  • 内容:定义了一个服务容器(Dependency Injection Container,依赖注入容器)的通用接口。

PSR-12:Extended Coding Style(扩展编码风格)

  • 内容:在PSR-2的基础上进行了细化和扩展,提供了更严格的代码样式规则。

PSR-15:HTTP Server Request Handlers(HTTP服务器请求处理器)

  • 内容:定义了HTTP请求处理器的接口,使得中间件和应用能够以标准化的方式处理HTTP请求。

PSR-16:Simple Cache(简单缓存)

  • 内容:提供了一个简单的缓存接口,适用于轻量级缓存需求,比PSR-6更基础。

所有正式的PSR文档都可以在PHP FIG的官方网站上找到:https://www.php-fig.org/psr/。

这里提供了每份PSR的详细说明、状态(是否活跃或已废弃)以及如何遵循这些标准的具体指导。

这篇关于PHP 标准建议psr的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1077538

相关文章

数据治理框架-ISO数据治理标准

引言 "数据治理"并不是一个新的概念,国内外有很多组织专注于数据治理理论和实践的研究。目前国际上,主要的数据治理框架有ISO数据治理标准、GDI数据治理框架、DAMA数据治理管理框架等。 ISO数据治理标准 改标准阐述了数据治理的标准、基本原则和数据治理模型,是一套完整的数据治理方法论。 ISO/IEC 38505标准的数据治理方法论的核心内容如下: 数据治理的目标:促进组织高效、合理地

C 标准库 - `<float.h>`

C 标准库 - <float.h> 概述 <float.h> 是 C 标准库中的一个头文件,它定义了与浮点数类型相关的宏。这些宏提供了关于浮点数的属性信息,如精度、最小和最大值、以及舍入误差等。这个头文件对于需要精确控制浮点数行为的程序非常有用,尤其是在数值计算和科学计算领域。 主要宏 <float.h> 中定义了许多宏,下面列举了一些主要的宏: FLT_RADIX:定义了浮点数的基数。

PHP原理之内存管理中难懂的几个点

PHP的内存管理, 分为俩大部分, 第一部分是PHP自身的内存管理, 这部分主要的内容就是引用计数, 写时复制, 等等面向应用的层面的管理. 而第二部分就是今天我要介绍的, zend_alloc中描写的关于PHP自身的内存管理, 包括它是如何管理可用内存, 如何分配内存等. 另外, 为什么要写这个呢, 因为之前并没有任何资料来介绍PHP内存管理中使用的策略, 数据结构, 或者算法. 而在我们

php中json_decode()和json_encode()

1.json_decode() json_decode (PHP 5 >= 5.2.0, PECL json >= 1.2.0) json_decode — 对 JSON 格式的字符串进行编码 说明 mixed json_decode ( string $json [, bool $assoc ] ) 接受一个 JSON 格式的字符串并且把它转换为 PHP 变量 参数 json

如何将文件夹里的PHP代码放到一个文件里

find ./dir -name "*.php" -exec 'cat' {} \; > dir.out

PHP抓取网站图片脚本

方法一: <?phpheader("Content-type:image/jpeg"); class download_image{function read_url($str) { $file=fopen($str,"r");$result = ''; while(!feof($file)) { $result.=fgets($file,9999); } fclose($file); re

PHP防止SQL注入详解及防范

SQL 注入是PHP应用中最常见的漏洞之一。事实上令人惊奇的是,开发者要同时犯两个错误才会引发一个SQL注入漏洞。 一个是没有对输入的数据进行过滤(过滤输入),还有一个是没有对发送到数据库的数据进行转义(转义输出)。这两个重要的步骤缺一不可,需要同时加以特别关注以减少程序错误。 对于攻击者来说,进行SQL注入攻击需要思考和试验,对数据库方案进行有根有据的推理非常有必要(当然假设攻击者看不到你的

PHP防止SQL注入的方法(2)

如果用户输入的是直接插入到一个SQL语句中的查询,应用程序会很容易受到SQL注入,例如下面的例子: $unsafe_variable = $_POST['user_input'];mysql_query("INSERT INTO table (column) VALUES ('" . $unsafe_variable . "')"); 这是因为用户可以输入类似VALUE”); DROP TA

PHP防止SQL注入的方法(1)

(1)mysql_real_escape_string – 转义 SQL 语句中使用的字符串中的特殊字符,并考虑到连接的当前字符集 使用方法如下: $sql = "select count(*) as ctr from users where username ='".mysql_real_escape_string($username)."' and password='". mysql_r

为何我建议你学会抄代码?

文章目录 为何我建议你学会抄代码?一、引言二、抄代码的艺术1、理解抄代码的真正含义1.1、抄代码的好处 2、如何有效地抄代码2.1、发现问题2.2、整理需求2.3、造轮子标准流程 三、抄代码的实践案例1、发现问题2、整理需求3、设计重试机制4、实现重试工具类5、使用重试工具类6、优化和扩展 四、总结 为何我建议你学会抄代码? 一、引言 在编程的世界中,“抄代码” 常被视为一