PSR 规范:让代码看起来像一个人写的
PSR-1/4/12 的核心要求、命名约定、目录结构、用 PHP-CS-Fixer 自动格式化,以及规范背后的理由。
PSR 是 PHP 社区的标准建议。它不是语法要求,但遵循它能让你的代码被任何 PHP 开发者快速读懂,也能直接接入现成的工具链。
最常用的三条
PSR-1 基础规范:文件只用 <?php 或 <?=;类名用大驼峰;方法名用小驼峰;常量全大写。
PSR-4 自动加载:命名空间与目录一一对应。这一条决定你的项目能不能被 Composer 加载。
PSR-12 代码风格:4 个空格缩进;左大括号跟在声明同一行(类和方法);控制结构左大括号不换行;文件末尾留一个空行;行尾不留空格。
<?php
declare(strict_types=1);
namespace App\Service;
class OrderService
{
public function create(array $data): int
{
if (!isset($data['amount'])) {
throw new \InvalidArgumentException('缺少金额');
}
return 0;
}
}用工具,不靠记
规范这种东西靠人肉记必然走样。装 PHP-CS-Fixer,配置好规则,提交前自动跑一遍。
composer require --dev friendsofphp/php-cs-fixer
vendor/bin/php-cs-fixer fix src --rules=@PSR12再接一个 Git 钩子(pre-commit),不合规的代码根本提交不上去。团队里只要一个人不遵守,规范就废了,所以要用工具卡住。
命名比格式更重要
格式问题工具能改,命名不行。几个实用约定:类名用名词(OrderService),方法名用动词(create、cancel),布尔返回用 is/has/can 开头,变量名不要用 $data、$arr、$tmp 这种。
缩写词保持大小写一致:HTMLParser 而不是 HtmlParser(虽然 PSR 允许后者,但团队内要统一)。
一条判断标准:半年后你自己回来看这段代码,能不能在三分钟内说清它做什么。不能,就是命名或结构有问题。