如果您使用 PHP 進(jìn)行開發(fā)已有一段時(shí)間，您可能遇到過術(shù)語 PSR-12。它是 PHP 社區(qū)中最廣泛接受的編碼標(biāo)準(zhǔn)之一，旨在確保不同項(xiàng)目之間 PHP 代碼庫的一致性。無論您是單獨(dú)工作還是作為團(tuán)隊(duì)的一員，遵循 PSR-12 都可以使您的代碼更干凈、更具可讀性并且更易于維護(hù)。在本博客中，我們將詳細(xì)介紹 PSR-12 是什么、它為何重要以及如何將其應(yīng)用到您的項(xiàng)目中。

目錄

1. 什么是 PSR-12？
2. 為什么 PSR-12 很重要？
3. PSR-12 的主要規(guī)則
   • 文件結(jié)構(gòu)
   • 命名空間和使用聲明
   • 類和方法
   • 控制結(jié)構(gòu)
   • 評(píng)論和文檔
4. 如何在 PHP 項(xiàng)目中應(yīng)用 PSR-12
5. 幫助您遵循 PSR-12 的工具
6. 最后的想法

什么是 PSR-12？

PSR-12 是 PHP 編碼風(fēng)格指南，由 PHP-FIG（框架互操作性小組）開發(fā)。它建立在之前的 PSR-2 標(biāo)準(zhǔn)的基礎(chǔ)上，提供了一組更新的規(guī)則，反映了現(xiàn)代 PHP 實(shí)踐并提高了代碼庫之間的一致性。

將 PSR-12 視為編寫干凈、可讀且可維護(hù)的 PHP 代碼的藍(lán)圖。通過遵循 PSR-12，開發(fā)人員可以確保他們的代碼遵循標(biāo)準(zhǔn)化結(jié)構(gòu)，從而更輕松地與他人協(xié)作并開展開源項(xiàng)目。

為什么 PSR-12 很重要？

像 PSR-12 這樣的編碼標(biāo)準(zhǔn)不僅僅是對(duì)空格和制表符吹毛求疵。這就是它們重要的原因：

• 可讀性：遵循標(biāo)準(zhǔn)樣式的代碼更容易閱讀，特別是對(duì)于剛接觸項(xiàng)目的開發(fā)人員。
• 協(xié)作：如果每個(gè)人都遵循相同的規(guī)則，那么合作就會(huì)變得更加順利和高效。
• 可維護(hù)性：干凈、一致的代碼更容易調(diào)試、測(cè)試和隨著時(shí)間的推移進(jìn)行擴(kuò)展。
• 互操作性：在開源項(xiàng)目或集成第三方庫時(shí)，遵循通用標(biāo)準(zhǔn)可確保不同代碼庫之間的兼容性。

PSR-12 的主要規(guī)則

讓我們深入了解 PSR-12 規(guī)定的一些關(guān)鍵規(guī)則。雖然有許多較小的指南，但以下是最引人注目的指南。

1. 文件結(jié)構(gòu)

• 開始標(biāo)簽：PHP 文件必須使用
• 編碼：文件必須以 UTF-8 編碼，不帶 BOM（字節(jié)順序標(biāo)記）。
• 行長(zhǎng)度：行不應(yīng)超過 120 個(gè)字符，但最好不超過 80 個(gè)字符。
• 空行：PHP 開始標(biāo)簽之后或結(jié)束標(biāo)簽之前不應(yīng)有空行。此外，return 語句之前以及方法定義之間必須有一個(gè)空行。

2. 命名空間和使用聲明

PSR-12 要求命名空間和使用聲明遵循特定的順序以提高清晰度：

• 命名空間聲明：命名空間聲明必須是 PHP 開始標(biāo)記之后的第一行。命名空間后必須有一個(gè)空行。
• Use 聲明：所有 use 聲明必須在命名空間聲明之后組合在一起，并用空行分隔。此外，最后一個(gè) use 語句后必須有一個(gè)空行。

示例：

<?php

namespace App\Controllers;

use App\Models\User;
use App\Repositories\UserRepository;

class UserController {
    // Class implementation
}

3. 類和方法

PSR-12 對(duì)如何聲明類、屬性和方法強(qiáng)制執(zhí)行一些嚴(yán)格的規(guī)則：

• 類聲明：class關(guān)鍵字后面必須跟一個(gè)空格，然后是類名。左大括號(hào) { 必須與類聲明放在同一行，右大括號(hào) } 放在自己的行上。
• 屬性：所有屬性都必須聲明可見性（公共、受保護(hù)、私有）。
• 方法：與類聲明類似，function 關(guān)鍵字后面必須跟一個(gè)空格，然后是方法名稱。必須為所有方法聲明可見性。

class UserController {
    private $userRepository;

    public function __construct(UserRepository $userRepository) {
        $this->userRepository = $userRepository;
    }
}

4. 控制結(jié)構(gòu)

if、for、switch 等控制結(jié)構(gòu)必須遵循一定的規(guī)則：

• 結(jié)構(gòu)：控制關(guān)鍵字和左括號(hào)之間必須有一個(gè)空格。必須始終使用大括號(hào) {}，即使對(duì)于單行語句也是如此。
• 縮進(jìn)：控制結(jié)構(gòu)內(nèi)的所有塊都必須縮進(jìn)一級(jí)（通常為四個(gè)空格）。

if ($user->isAdmin()) {
    echo "User is an admin";
} else {
    echo "User is not an admin";
}

5. 評(píng)論和文檔

注釋對(duì)于解釋為什么代碼的某些部分存在至關(guān)重要。 PSR-12 強(qiáng)調(diào)需要正確、清晰的評(píng)論。

• 塊注釋：使用 /* */ 進(jìn)行多行注釋，并在注釋前放置一個(gè)空行。
• 單行注釋：使用//進(jìn)行內(nèi)聯(lián)注釋，并確保注釋有意義。

<?php

namespace App\Controllers;

use App\Models\User;
use App\Repositories\UserRepository;

class UserController {
    // Class implementation
}

如何在 PHP 項(xiàng)目中應(yīng)用 PSR-12

要在項(xiàng)目中遵循 PSR-12，您可以在編寫代碼時(shí)手動(dòng)遵守指南，但確保合規(guī)性的最佳方法是使用自動(dòng)化工具。

首先，熟悉這些一般做法：

• 使用一致的縮進(jìn)：縮進(jìn)需要四個(gè)空格。
• 限制行長(zhǎng)度：盡量將行長(zhǎng)度控制在 120 個(gè)字符以下，但為了更好的可讀性，最好使用 80 個(gè)字符。
• 組織代碼結(jié)構(gòu)：遵循類聲明、可見性和控制結(jié)構(gòu)的規(guī)則。

幫助您遵循 PSR-12 的工具

手動(dòng)確保您的代碼遵循 PSR-12 可能非常耗時(shí)，但有一些工具可以幫助您自動(dòng)化此過程。

1. PHP_CodeSniffer

確保 PHP 代碼遵循 PSR-12 的最流行工具之一是 PHP_CodeSniffer。它會(huì)分析您的代碼并指出您偏離標(biāo)準(zhǔn)的地方。

安裝和使用它：

class UserController {
    private $userRepository;

    public function __construct(UserRepository $userRepository) {
        $this->userRepository = $userRepository;
    }
}

然后，針對(duì)您的代碼運(yùn)行它：

if ($user->isAdmin()) {
    echo "User is an admin";
} else {
    echo "User is not an admin";
}

2. PHP CS 修復(fù)程序

另一個(gè)有用的工具是 PHP CS Fixer。它不僅可以檢測(cè)問題，還可以自動(dòng)修復(fù)您的代碼以符合 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();
}

使用以下命令運(yùn)行修復(fù)程序：

composer require "squizlabs/php_codesniffer=*"

3. PHPStorm

如果您使用 PHPStorm，您可以將其配置為遵循 PSR-12。前往設(shè)置 -> 編輯器 -> 代碼風(fēng)格 -> PHP 并將標(biāo)準(zhǔn)設(shè)置為 PSR-12。

最后的想法

在 PHP 項(xiàng)目中遵循 PSR-12 不僅僅是遵守任意規(guī)則。它是為了讓你的代碼更干凈、更易讀、更容易維護(hù)——無論你是單獨(dú)工作還是與團(tuán)隊(duì)一起工作。通過遵循 PSR-12，您不僅為自己編寫代碼，而且為整個(gè) PHP 社區(qū)編寫代碼。

采用此標(biāo)準(zhǔn)是朝著編寫專業(yè)、一致且可維護(hù)的 PHP 代碼邁出的一步。使用提到的工具使過程變得更容易，并觀察您的項(xiàng)目變得多么干凈和有組織！

編碼愉快！

以上是了解 PSR - PHP 編碼風(fēng)格指南的詳細(xì)內(nèi)容。更多信息請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！