揪出代碼中的“幽靈”：如何使用tomasvotruba/class-leak優化PHP項目

在開發大型 php 項目的過程中，我們經常會引入各種各樣的類。但隨著項目的迭代和功能的演進，一些類可能會逐漸被廢棄，不再被使用。這些“幽靈”類不僅會增加代碼庫的體積，還會降低代碼的可讀性和可維護性。手動查找這些無用的類非常耗時且容易出錯。那么，有沒有一種方法能夠自動檢測并移除這些“幽靈”類呢？ composer在線學習地址：學習地址tomasvotruba/class-leak 就是這樣一款工具。它能夠掃描指定的目錄，找出項目中未被使用的類，幫助開發者清理代碼庫，提升項目質量。

安裝

使用 Composer 安裝 tomasvotruba/class-leak 非常簡單：

composer require tomasvotruba/class-leak --dev

使用

安裝完成后，就可以使用 class-leak 命令來檢查代碼了。例如，要檢查 src 目錄下的代碼，可以執行以下命令：

vendor/bin/class-leak check src

class-leak 會掃描 src 目錄下的所有 PHP 文件，并分析類之間的依賴關系，找出未被使用的類。

立即學習“PHP免費學習筆記（深入）”；

排除特定類型

在實際項目中，可能存在一些類，雖然沒有被直接使用，但會被框架或其他工具自動加載，例如控制臺命令類。為了避免誤報，可以使用 –skip-type 參數來排除特定類型的類。

vendor/bin/class-leak check src --skip-type="AppContractSomeInterface"

排除特定后綴

如果你的類沒有實現任何接口或繼承任何類，但仍然需要排除，可以使用 –skip-suffix 參數來排除具有特定后綴的類。

vendor/bin/class-leak check src --skip-suffix="Controller"

排除特定注解

有些類可能使用了特定的注解，表明它們會被框架以某種方式使用。可以使用 –skip-Attribute 參數來排除使用了特定注解的類。

vendor/bin/class-leak check src --skip-attribute="AppAttributeAsController"

優勢和實際應用效果

• 自動化檢測： 自動掃描代碼庫，找出未被使用的類，節省人工查找的時間和精力。
• 提高代碼質量： 移除無用的類，減少代碼庫的體積，提高代碼的可讀性和可維護性。
• 減少錯誤風險： 避免因誤刪重要類而導致程序出錯。
• 靈活配置： 可以通過參數排除特定類型、后綴或注解的類，滿足不同項目的需求。

通過使用 tomasvotruba/class-leak，可以輕松地找出項目中的“幽靈”類，并將其移除，從而優化代碼庫，提高項目質量，降低維護成本。