如果您使用 PHP 进行开发已有一段时间，您可能遇到过术语 PSR-12。它是 PHP 社区中最广泛接受的编码标准之一，旨在确保不同项目之间 PHP 代码库的一致性。无论您是单独工作还是作为团队的一员，遵循 PSR-12 都可以使您的代码更干净、更具可读性并且更易于维护。在本博客中，我们将详细介绍 PSR-12 是什么、它为何重要以及如何将其应用到您的项目中。
PSR-12 是 PHP 编码风格指南，由 PHP-FIG（框架互操作性小组）开发。它建立在之前的 PSR-2 标准的基础上，提供了一组更新的规则，反映了现代 PHP 实践并提高了代码库之间的一致性。
将 PSR-12 视为编写干净、可读且可维护的 PHP 代码的蓝图。通过遵循 PSR-12，开发人员可以确保他们的代码遵循标准化结构，从而更轻松地与他人协作并开展开源项目。
像 PSR-12 这样的编码标准不仅仅是对空格和制表符吹毛求疵。这就是它们重要的原因：
让我们深入了解 PSR-12 规定的一些关键规则。虽然有许多较小的指南，但以下是最引人注目的指南。
PSR-12 要求命名空间和使用声明遵循特定的顺序以提高清晰度：
示例：
<?php
namespace App\Controllers;
use App\Models\User;
use App\Repositories\UserRepository;
class UserController {
// Class implementation
}
PSR-12 对如何声明类、属性和方法强制执行一些严格的规则：
class UserController {
private $userRepository;
public function __construct(UserRepository $userRepository) {
$this->userRepository = $userRepository;
}
}
if、for、switch 等控制结构必须遵循一定的规则：
if ($user->isAdmin()) {
echo "User is an admin";
} else {
echo "User is not an admin";
}
注释对于解释为什么代码的某些部分存在至关重要。 PSR-12 强调需要正确、清晰的评论。
<?php
namespace App\Controllers;
use App\Models\User;
use App\Repositories\UserRepository;
class UserController {
// Class implementation
}
要在项目中遵循 PSR-12，您可以在编写代码时手动遵守指南，但确保合规性的最佳方法是使用自动化工具。
首先，熟悉这些一般做法：
手动确保您的代码遵循 PSR-12 可能非常耗时，但有一些工具可以帮助您自动化此过程。
确保 PHP 代码遵循 PSR-12 的最流行工具之一是 PHP_CodeSniffer。它会分析您的代码并指出您偏离标准的地方。
安装和使用它：
class UserController {
private $userRepository;
public function __construct(UserRepository $userRepository) {
$this->userRepository = $userRepository;
}
}
然后，针对您的代码运行它：
if ($user->isAdmin()) {
echo "User is an admin";
} else {
echo "User is not an admin";
}
另一个有用的工具是 PHP CS Fixer。它不仅可以检测问题，还可以自动修复您的代码以符合 PSR-12。
// Fetch user from the repository
$user = $userRepository->find($id);
/*
* If user is not found, throw an exception.
* This helps in handling invalid user IDs.
*/
if (!$user) {
throw new NotFoundException();
}
使用以下命令运行修复程序：
composer require "squizlabs/php_codesniffer=*"
如果您使用 PHPStorm，您可以将其配置为遵循 PSR-12。前往设置 -> 编辑器 -> 代码风格 -> PHP 并将标准设置为 PSR-12。
在 PHP 项目中遵循 PSR-12 不仅仅是遵守任意规则。它是为了让你的代码更干净、更易读、更容易维护——无论你是单独工作还是与团队一起工作。通过遵循 PSR-12，您不仅为自己编写代码，而且为整个 PHP 社区编写代码。
采用此标准是朝着编写专业、一致且可维护的 PHP 代码迈出的一步。使用提到的工具使过程变得更容易，并观察您的项目变得多么干净和有组织！
编码愉快！
以上是了解 PSR - PHP 编码风格指南的详细内容。更多信息请关注PHP中文网其他相关文章！
