php中PSR-[0-4]代码规范学习记录

于 2021-06-27 19:04:13 发布
阅读量289 收藏 2
点赞数
分类专栏： 服务器 php 文章标签： php psr-0 psr-4 自动加载 psr-1
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/qq_34627459/article/details/118278279
版权
本文详细介绍了PHP中的PSR-0到PSR-4编码规范，包括命名空间、自动加载、代码风格等方面的规定，旨在统一和提高代码的可读性和互操作性。PSR-0已被PSR-4取代，PSR-1和PSR-2关注代码风格，而PSR-3涉及日志库接口。遵循这些规范，能提升代码质量，便于团队合作。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

php中PSR-[0-4]代码规范学习记录

1. PSR是什么？

PSR是一套代码编写规范，用于约束代码风格。以前没有规范的时候大家都是按照自己的习惯来书写代码，但每个人风格不一样，你的代码在别人看来就是很不爽。而且会导致许多问题：
function 函数名是否驼峰命名，
花括号{}是否换行写，
是该写注释呢还是不写
变量名是大写还是小写，
一个php文件中是一个类好还是允许有多个
所以PSR-[0-4]规范就应运而生，大家都共同遵守，就没有风格差异了。
PSR是由PHP-FIG这个组织发明的，FIG 是 Framework Interoperability Group（框架可互用性小组）的缩写。PSR是Proposing a Standards Recommendation（提出标准建议）的缩写。截止到目前为止，总共有5套PSR规范，分别是：

PSR-0 (Autoloading Standard) 自动加载标准
PSR-1 (Basic Coding Standard) 基础编码标准
PSR-2 (Coding Style Guide) 编码风格向导
PSR-3 (Logger Interface) 日志接口
PSR-4 (Improved Autoloading) 自动加载的增强版，可以替换掉PSR-0了。

2. 规范的使用和定义

1. PSR-0规范

PSR-0是第一套规范，主要用于规范自动加载，不过现在已经过时了，被PSR-4规范替代了。
PSR-0强制性要求几点：

1. 一个完全合格的namespace和class必须符合这样的结构：“\< Vendor Name>(< Namespace>)*< Class Name>”
2. 每个namespace必须有一个顶层的namespace（"Vendor Name"提供者名字）
3. 每个namespace可以有多个子namespace
4. 当从文件系统中加载时，每个namespace的分隔符(\)要转换成 DIRECTORY_SEPARATOR(操作系统路径分隔符)
5. 在类名中，每个下划线(_)符号要转换成DIRECTORY_SEPARATOR(操作系统路径分隔符)。在namespace中，下划线(_)符号是没有（特殊）意义的。
6. 当从文件系统中载入时，合格的namespace和class一定是以 .php 结尾的
7. verdor name,namespaces,class名可以由大小写字母组合而成（大小写敏感的）
第一条： 一个完全合格的namespace和class必须符合这样的结构：“< Vendor Name>(< Namespace>)*< Class Name>”

假如我的文件路径为Lib/Driver/Config.php,那么我的namespace的申明和使用为：

申明：namespace \Lib\Driver;
使用：use \Lib\Driver\Config;
第二三条：每个namespace必须有一个顶层的namespace（"Vendor Name"提供者名字），每个namespace可以有多个子namespace
namespace \Lib\Driver\Config->/path/to/vender/Lib/Driver/Config.php

Lib就是顶层namespace，Driver就是子namespace/

第四条：当从文件系统中加载时，每个namespace的分隔符()要转换成 DIRECTORY_SEPARATOR(操作系统路径分隔符)
new \Lib\Driver\Config->转换的目录为/Lib/Driver/Config.php,替换反斜杠为目录分隔符
第五条：在类名中，每个下划线(_)符号要转换成DIRECTORY_SEPARATOR(操作系统路径分隔符)。在namespace中，下划线(_)符号是没有（特殊）意义的
\Lib\Driver\Class_Name->转换为目录为/Lib/Driver/Class/Name.php
\Lib\Package_Name\Class_Name->转换为目录为/Lib/Package_Name/Class/Name.php

目录中的_就是下划线，classname中的下划线实际上会转为成路径分隔符。

但这个规定在PSR-4中已经取消了，不再需要转换了。
第六条：当从文件系统中载入时，合格的namespace和class一定是以 .php 结尾的

加载的文件必须是.php结尾，既然使用php当然是.php结尾了。不再像以前那样有什么php3,php5

第七条：verdor name,namespaces,class名可以由大小写字母组合而成（大小写敏感的）

由于Liunx是区分大小写的，而windows是不区分大小写的，所以如果不注意大小写在win下正常开发，但是到了服务器上可能就无法正常执行了。

2. PSR-1规范

要求：

1. PHP源文件必须只使用 <?php 和 <?= 这两种标签。
2. 源文件中php代码的编码格式必须是不带字节顺序标记(BOM)的UTF-8。
3. 一个源文件建议只用来做声明（类(class)，函数(function)，常量(constant)等）或者只用来做一些引起副作用的操作（例如：输出信息，修改.ini配置等）,但不建议同时做这两件事。
4. 命名空间(namespace)和类(class) 必须遵守PSR-0标准。
5. 类名(class name) 必须使用骆驼式(StudlyCaps)写法 (注：驼峰式(cameCase)的一种变种，后文将直接用StudlyCaps表示)。
6. 类(class)中的常量必须只由大写字母和下划线(_)组成。
7. 方法名(method name) 必须使用驼峰式(cameCase)写法。
第一条： PHP源文件必须只使用 <?php 和 <?= 这两种标签

因为php有4种标签形式，所以这里规定了使用哪一种，统一规范。

第二条：源文件中php代码的编码格式必须是不带字节顺序标记(BOM)的UTF-8

windows笔记本默认是会在文件头部加入BOM头的，会导致在服务器上输出的很奇怪。
国内的中文编码是GBK，UTF-8是国际通用编码，不统一的话也会导致乱码。

第三条：一个源文件建议只用来做声明（类(class)，函数(function)，常量(constant)等）或者只用来做一些引起副作用的操作（例如：输出信息，修改.ini配置等）,但不建议同时做这两件事。

不要在一个文件中又是定义函数又是修改系统配置的，一个文件只做一件事。

// 副作用：修改了ini配置
ini_set('error_reporting', E_ALL);
// 副作用：载入了文件
include "file.php";
// 副作用：产生了输出
echo "<html>\n";
// 声明 function
function foo()
{
    // 函数体
}

分开写

// 声明 function
function foo()
{
    // 函数体
}

// 副作用：修改了ini配置
ini_set('error_reporting', E_ALL);

// 副作用：载入了文件
include "file.php";

这样就很整齐。

第四条：命名空间(namespace)和类(class) 必须遵守PSR-0标准

参见PSR-0标准

第五条：类名(class name) 必须使用骆驼式(StudlyCaps)写法 (注：驼峰式(cameCase)的一种变种，后文将直接用StudlyCaps表示)。

类名必须使用驼峰命名，大驼峰小驼峰都可以。

<?php
class BigHouse{
}
第六条：类(class)中的常量必须只由大写字母和下划线(_)组成。
<?php
class Test{
	const USER_INFO = 'xx';
	const NAME = 'xx';
}
第七条：方法名(method name) 必须使用驼峰式(cameCase)写法。
<?php
class Test{
	public function getUserInfo(){}
}

总结：虽然规范里没有规定使用大驼峰还是小驼峰，不过我的开发习惯是class name大驼峰，method name小驼峰

3. PSR-2 规范

PSR-2用于约束代码风格,代码必须遵循PSR-1 中列出的所有规则。

1. 源文件
  1. 文件末尾必须空一行。
  2. 必须使用Unix LF(换行)作为行结束符。
  3. 纯PHP代码源文件的关闭标签?>必须省略。
2. 行
  1. 行长不得有硬性限制。
  2. 行长度的软限制必须是 120 个字符；自动样式检查器必须警告但不能在软限制处出错。
  3. 行不应超过 80 个字符；超过此长度的行应拆分为多行，每行不超过 80 个字符。
  4. 非空行的末尾不得有尾随空格。
  5. 可以添加空行以提高可读性并指示相关的代码块。
  6. 每行不得超过一个语句。
3. 缩进

代码必须使用 4 个空格的缩进，并且不得使用制表符进行缩进。现代编辑器都可以设置。

注意：仅使用空格，而不是将空格与制表符混合使用，有助于避免差异、补丁、历史记录和注释方面的问题。空格的使用还可以轻松插入细粒度的子缩进以进行行间对齐。

4. 关键字和 True/False/Null
  1. PHP关键字必须小写。
  2. PHP 常量true、false和null必须小写。
5. 命名空间的使用和声明
  1. 命名空间(namespace)的声明后面必须有一行空行。
  2. 所有的导入(use)声明必须放在命名空间(namespace)声明的下面。
  3. 一句声明中，必须只有一个导入(use)关键字。
  4. 在导入(use)声明代码块后面必须有一行空行。
<?php
namespace Vendor\Package;//下面必须空一行

use FooClass;//use放在namespace下面
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;//use下面也要空一行

// ... additional PHP code ...
6. 类、属性和方法
  1. 继承(extends) 和实现(implement) 必须和 class name 写在一行，切花括号要换行写。
<?php
namespace Vendor\Package;

use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;

//写在一行
class ClassName extends ParentClass implements \ArrayAccess, \Countable
{//花括号换行写
    // constants, properties, methods
}

implements有多个时可以写成多行，但要保证第一个必须在下一行。每行只能写一个接口，每行都要缩进。

<?php
namespace Vendor\Package;

use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;

class ClassName extends ParentClass implements
    \ArrayAccess,//第一个接口就要写在下一行，注意缩进
    \Countable,
    \Serializable
{
    // constants, properties, methods
}
  1. 属性必须声明可见性，public还是private还是protected，不能省略。也不能使用var, var是php老版本中的什么方式，等用于public。属性名称不应以单个下划线为前缀来表示受保护或私有可见性。每个语句不能声明多个属性。
<?php
namespace Vendor\Package;

class ClassName
{
    public $foo = null;
}
  1. 方法(method) ,必须 声明其可见性，到底是 public 还是protected还是 private，不能省略。并且，花括号{必须换行写。如果有多个参数，第一个参数后紧接, 再加个空格，如果参数有默认值，也要用左右空格分开。
<?php
namespace Vendor\Package;

class ClassName
{
    public function fooBarBaz($arg1, &$arg2, $arg3 = [])
    {
        // method body
    }
}

参数列表可以分成多行，和接口多行一样需要缩进。参数多行时做花括号不用换行写，但是要在右括号后空一格。如下：

<?php
namespace Vendor\Package;

class ClassName
{
    public function aVeryLongMethodName(
        ClassTypeHint $arg1,
        &$arg2,
        array $arg3 = []
    ) {
        // method body
    }
}
  1. 当用到抽象(abstract)和终结(final)来做类声明时，它们必须放在可见性声明 （public 还是protected还是 private）的前面。而当用到静态(static)来做类声明时，则必须放在可见性声明的后面。
<?php
namespace Vendor\Package;

abstract class ClassName
{
    protected static $foo; //static修饰符放到可见性声明后面

    abstract protected function zim();//abstract 放到前面

    final public static function bar()//final放到前面
    {
        // method body
    }
}
  1. 函数调用时，函数名称与左括号之间不得有空格，左括号后不得有空格，右括号前不得有空格。在参数列表中，每个逗号前不得有空格，每个逗号后必须有一个空格。参数列表可以分成多行，其中每个后续行缩进一次。这样做时，列表中的第一项必须在下一行，并且每行必须只有一个参数。
<?php
bar();
$foo->bar($arg1);
Foo::bar($arg2, $arg3);
$foo->bar(
    $longArgument,
    $longerArgument,
    $muchLongerArgument
);
7. 控制结构
  1. 控制结构就是if,switch这种流程控制。一般规则如下：
  2. 控制结构关键字后必须有一个空格
  3. 左括号后不能有空格
  4. 右括号前不能有空格
  5. 右括号和左大括号之间必须有一个空格
  6. 结构体必须缩进一次
  7. 右大括号必须在正文之后的下一行
1. if，elseif，else写法：
<?php
if ($expr1) {
    // if body
} elseif ($expr2) {
    // elseif body
} else {
    // else body;
}

elseif应该连着写 不要写成else if,要看着像一个单词。

2. switch,case写法：
<?php
switch ($expr) {//括号前后都要有空格
    case 0:
        echo 'First case, with a break';
        break;//break要和上一行对齐
    case 1:
        echo 'Second case, which falls through';
        //没有break语句的要写注释no break
        // no break
    case 2:
    case 3:
    case 4:
        echo 'Third case, return instead of break';
        return;
    default:
        echo 'Default case';
        break;
}
3. while,do while
<?php
while ($expr) {
    // structure body
}

do {
    // structure body;
} while ($expr);
4. for,foreach
<?php
for ($i = 0; $i < 10; $i++) {
    // for body
}

foreach ($iterable as $key => $value) {
    // foreach body
}
5. try,catch
<?php
try {
    // try body
} catch (FirstExceptionType $e) {
    // catch body
} catch (OtherExceptionType $e) {
    // catch body
}
8.闭包
  1. 闭包必须在function关键字后用空格声明，关键字前后用空格声明use
  2. 左大括号必须在同一行上，右大括号必须在正文之后的下一行。
  3. 参数列表或变量列表的左括号后不得有空格，参数列表或变量列表的右括号前不得有空格。
  4. 在参数列表和变量列表中，每个逗号前不能有一个空格，每个逗号后必须有一个空格。
  5. 具有默认值的闭包参数必须放在参数列表的末尾。
  6. 参数列表和变量列表可以分成多行，其中每个后续行缩进一次。这样做时，列表中的第一项必须在下一行，并且每行必须只有一个参数或变量
  7. 当输入的参数列表（无论是参数还是use的变量）被分成多行时，右括号和左括号必须放在它们自己的一行上，它们之间有一个空格。
  8. 请注意，当在函数或方法直接将闭包用作参数时，格式化规则也适用。
<?php
$closureWithArgs = function ($arg1, $arg2) {
    // body
};

$closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) {
    // body
};


//参数列表格式化
$longArgs_noVars = function (
    $longArgument,
    $longerArgument,
    $muchLongerArgument
) {
    // body
};

$noArgs_longVars = function () use (
    $longVar1,
    $longerVar2,
    $muchLongerVar3
) {
    // body
};

$longArgs_longVars = function (
    $longArgument,
    $longerArgument,
    $muchLongerArgument
) use (
    $longVar1,
    $longerVar2,
    $muchLongerVar3
) {
    // body
};

$longArgs_shortVars = function (
    $longArgument,
    $longerArgument,
    $muchLongerArgument
) use ($var1) {
    // body
};

$shortArgs_longVars = function ($arg) use (
    $longVar1,
    $longerVar2,
    $muchLongerVar3
) {
    // body
};

//闭包作为参数传入
$foo->bar(
    $arg1,
    function ($arg2) use ($var1) {
        // body
    },
    $arg3
);
4. PSR-3规范

PSR-3规范是日志库的通用接口，一般框架都帮我们做好了，了解即可。官网文档

5. PSR-4规范

PSR-4也是自动加载规范，用来取代PSR-0的。

  1. 废除了PSR-0中_就是目录分割符的写法，_下划线在完全限定类名中是没有特殊含义了。
  2. 类文件名要以 .php 结尾。
  3. 类名必须要和对应的文件名要一模一样，大小写也要一模一样。

总结：

psr-0,psr-4是自动加载规范，psr-1,psr-2是代码风格规范，psr-3是日志库接口。
平常工作中尽量使用psr-1,psr-2规范来规范我们的代码风格。

评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值