揪出代码中的“幽灵”：如何使用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，可以轻松地找出项目中的“幽灵”类，并将其移除，从而优化代码库，提高项目质量，降低维护成本。