PHP 升級：使用 PHPStan 阻止回歸

照片由 Ron McClenny 在 Unsplash 上拍攝

通常，當人們想到 PHPStan 時，他們通常會想到改善類型覆蓋率。這其實只是 PHPStan 能力的一小部分。在本文中，我們將學習如何使用它來停止升級迴歸。

什麼是升級迴歸？

升級迴歸是指您希望刪除應用程式中的某些功能。這可能是您的應用程式中的程式碼或您已安裝的依賴項中的程式碼。

在嘗試執行升級時，我們通常無法一次完成所有操作。相反，我們必須進行一些小的增量改變。同樣，當我們這樣做時，我們也不希望其他開發人員繼續使用已棄用的方法和屬性。在這種情況下，那些新方法呼叫等是您升級應用程式進度的倒退。

安裝 PHPStan 和棄用規則擴展

要開始解決升級迴歸問題，第一步是安裝 PHPStan（如果尚未安裝）。您可以透過 Composer 安裝它：

composer require --dev phpstan/phpstan

接下來，您需要添加棄用規則擴展，該擴展專門幫助追蹤程式碼庫中已棄用的方法、屬性和類別的使用情況：

composer require --dev phpstan/phpstan-deprecation-rules

安裝後，您可以將 PHPStan 設定為使用棄用規則，方法是將其新增至 phpstan.neon 設定檔：

includes:
    - vendor/phpstan/phpstan-deprecation-rules/rules.neon

使用此設定運行 PHPStan 現在將標記程式碼庫中任何已棄用的方法、屬性或類別。這是防止升級迴歸的重要步驟，因為在使用已棄用的程式碼時您會收到通知。然後，您可以重構這些實例，以確保您的應用程式轉向更新的、受支援的功能。

使用「不允許的呼叫」擴充功能更進一步

雖然棄用規則擴展可捕獲已棄用的程式碼，但Disallowed Calls 擴充功能提供了一種方法來阻止特定函數調用、方法調用，甚至您不再希望在程式碼庫中允許的整個類別。這對於對程式碼進行更細粒度的控制特別有用，例如沒有棄用警告的程式碼。

composer require --dev spaze/phpstan-disallowed-calls

安裝後，您需要在 phpstan.neon 檔案中進行設定。以下是如何禁止某些方法呼叫或函數的範例：

includes:
    - vendor/phpstan/phpstan-deprecation-rules/rules.neon
    # add the extension
    - vendor/spaze/phpstan-disallowed-calls/extension.neon

parameters:
    # You can see more example at https://github.com/spaze/phpstan-disallowed-calls/blob/main/docs/custom-rules.md
    disallowedMethodCalls:
        -
            method: 'PotentiallyDangerous\Logger::log()' # `function` is an alias of `method`
            message: 'use our own logger instead'
            errorTip: 'see https://our-docs.example/logging on how logging should be used'Begin writing your own rules
    disallowedFunctionCalls:
        -
            function: 'var_dump()' # `method` is an alias of `function`
            message: 'use logger instead'

這個擴充功能非常全面，這意味著您將能夠涵蓋大多數場景。當然，可能在某些情況下不起作用，為此最好的方法就是開始學習編寫自己的規則。

這是我們將在另一篇文章中討論的內容。

結論

使用 PHPStan 捕獲升級回歸是一種使升級過程變得更容易的明智方法，尤其是在大型開發團隊中。將 PHPStan 應用於您的持續整合設定

以上是PHP 升級：使用 PHPStan 阻止回歸的詳細內容。更多資訊請關注PHP中文網其他相關文章！