PHP 混乱检测器

最后修改时间：2021 年 11 月 22 日

除了内置的编码辅助之外，PhpStorm 还通过与PHP Mess Detector工具的集成来提供源代码检查，该工具可以检测与代码大小、不一致、未使用的代码、违反命名约定、糟糕的设计等相关的潜在问题。

要从 PhpStorm 而不是命令行使用 PHP Mess Detector，您需要在 PhpStorm 中注册它并将其配置为 PhpStorm代码检查。一旦在 PhpStorm 中安装并启用，该工具就可以在任何打开的 PHP 文件中使用，并且不需要额外的步骤来启动它。文件中的每次更新都会激活动态代码检查，因此可以轻松摆脱发现的问题。

PHP Mess Detector 即时报告的错误和警告显示为弹出消息。当该工具以批处理模式运行时，错误和警告会显示在“问题”工具窗口中。每条消息都有phpmd前缀以将其与 PhpStorm 内部检查区分开来。

您可以应用预定义规则或定义您自己的自定义规则集。

先决条件

在将 PHP Mess Detector 集成到 PhpStorm 之前，请确保满足以下先决条件：

  • 必须将包含 PHP 引擎可执行文件的目录添加到系统中path。这允许代码质量工具脚本执行对系统范围的 PHP 引擎的调用。

  • 对于基于 Docker Compose 的远程解释器，请确保使用execmode 以避免产生额外的容器。

    1. 在设置/首选项对话框 ( Ctrl+Alt+S) 中，转到PHP。

    2. 在打开的PHP页面上，单击CLI 解释器列表浏览按钮旁边的。

    3. 在打开的CLI 解释器对话框中，将所选解释器的生命周期模式设置为连接到现有容器 ('docker-compose exec')。

      docker-compose exec 用于 PHP 解释器

安装和配置 PHP Mess Detector

PHP Mess Detector 脚本可以用作本地脚本、与 PHP 解释器关联的脚本，或者声明为项目依赖项并通过Composer安装的脚本，这是首选和推荐的方式。

使用 Composer 安装 PHP Mess Detector

在开始之前，请确保 Composer 已安装在您的计算机上并在当前项目中初始化，如Composer 依赖项管理器中所述。

重置 PHP Mess Detector 配置

初始配置 PHP Mess Detector 后，composer.json中的进一步修改不会影响检查配置。要应用更新的更改，请重置 PHP Mess Detector 配置。

  1. 在设置/首选项对话框 ( Ctrl+Alt+S) 中，导航到PHP | 质量工具。

  2. 在打开的Quality Tools页面上，展开Mess Detector区域并单击Configuration列表浏览按钮旁边的。

  3. 在打开的PHP Mess Detector对话框中，清空PHP Mess Detector 路径字段。

    空 PHP Mess Detector 路径字段

  4. 通过单击composer.json编辑器面板顶部的更新来更新项目 Composer 依赖项。有关详细信息，请参阅更新依赖项。

PhpStorm 将重新执行 PHP Mess Detector 配置，从而应用composer.json中的更改。

手动配置 PHP Mess Detector

您可以使用手动下载的本地 PHP 代码质量工具脚本或与 PHP 解释器关联的脚本。可以有许多本地和远程 PHP 解释器，在Settings/Preferences对话框的PHP页面上指定的解释器被认为是Project Default。在配置远程 PHP 解释器或配置本地 PHP 解释器中了解有关配置 PHP 解释器的更多信息。

选择要使用的 PHP Mess Detector 脚本

  1. 在设置/首选项对话框 ( Ctrl+Alt+S) 中，导航到PHP | 质量工具。

  2. 在打开的Quality Tools页面上，展开Mess Detector区域。从配置列表中，选择 PHP Mess Detector 脚本：

    • 要使用与特定远程 PHP 解释器关联的脚本，请选择该解释器的名称。

    • 要使用本地脚本，请选择Local。在这种情况下，无论项目中使用的是本地还是远程的 PHP 解释器，都会执行本地 PHP Mess Detector。请注意，PHP Mess Detector 只能有一个本地配置，因为 PhpStorm 运行包含 PHP 引擎路径的脚本（ Windows 为phpmd.bat ，Linux 和 macOS 为phpmd ）。

    • 要使用与默认项目解释器关联的脚本，即在设置/首选项对话框的PHP页面上选择的脚本，请选择默认项目解释器。

配置本地 PHP Mess Detector 脚本

  1. 下载并安装PHP Mess Detector脚本。

    要检查 PHP Mess Detector 安装，请切换到安装目录并运行以下命令：

    phpmd --版本

    如果该工具可用，您将收到以下格式的消息：

    PHPMD 版本 <版本>

    要根据您自己的自定义编码标准检查代码，请创建它。将规则和指向它们的规则集.xml 文件存储在规则集根目录中。

  2. 在 PhpStorm 中注册本地 PHP Mess Detector 脚本：

    • 在设置/首选项对话框 ( Ctrl+Alt+S) 中，导航到PHP | 质量工具。

    • 在打开的Quality Tools页面上，展开Mess Detector区域并单击Configuration列表浏览按钮旁边的。

    • 在打开的PHP Mess Detector对话框中，在PHP Mess Detector 路径字段中指定phpmd.bat或phpmd PHP Mess Detector 可执行文件的位置。手动键入路径或单击并在打开的对话框中选择相关文件夹。浏览按钮

      要检查phpmd.bat或phpmd的指定路径确保 PhpStorm 和 PHP Mess Detector 之间的交互，即可以从 PhpStorm 启动该工具并且 PhpStorm 将从它接收问题报告，请单击“验证”按钮。此验证等同于运行phpmd --version命令。如果验证成功通过，PhpStorm 会显示检测到的 PHP Mess Detector 版本信息。

  3. 如有必要，在Tool process timeout字段中，指定您希望 PhpStorm 等待 PHP Mess Detector 的结果多长时间，然后终止进程以防止 CPU 和内存使用过多。

配置与 PHP 解释器关联的 PHP Mess Detector 脚本

  1. 在设置/首选项对话框 ( Ctrl+Alt+S) 中，导航到PHP | 质量工具。

  2. 在打开的Quality Tools页面上，展开Mess Detector区域并单击Configuration列表浏览按钮旁边的。PHP Mess Detector对话框打开，在左侧窗格中显示所有已配置 PHP Mess Detector 脚本的列表，其中一个是Local类型，其他以与脚本关联的 PHP 解释器命名。

  3. 单击添加按钮工具栏上的 。在打开的远程解释器的 PHP Mess Detector对话框中，选择远程 PHP 解释器以使用关联的脚本。如果列表不包含相关解释器，请单击浏览按钮并在CLI 解释器对话框中配置远程解释器，如配置远程 PHP 解释器中所述。

    当您单击OK时，PhpStorm 会将您带回PHP Mess Detector对话框，其中新的PHP Mess Detector配置已添加到列表中，右侧窗格显示选择的远程 PHP 解释器，以及与之关联的 PHP Mess Detector 的路径，以及高级的 PHP Mess Detector 选项。

  4. 如有必要，在Tool process timeout字段中，指定您希望 PhpStorm 等待 PHP Mess Detector 的结果多长时间，然后终止进程以防止 CPU 和内存使用过多。

将 PHP Mess Detector 配置为 PhpStorm 检查

使用 Composer 配置 PHP Mess Detector 检查

您可以在composer.json的脚本部分中包含有关默认和自定义 PHP Mess Detector 规则集的信息。当您安装或更新项目依赖项时，将检测指定的规则集并自动启用PHP Mess Detector 验证检查。

如果composer.jsonscripts部分没有指定规则集，PhpStorm 将额外检查项目根目录以找到具有 phpmd.xml默认名称的规则集。如果文件存在，它将被自动选择为检查的自定义规则集。

  • 在composer.jsonscripts部分中，将PHP Mess Detector 启动命令添加到叶元素之一中。phpmd

    提供内置标准的名称或自定义规则集的路径作为参数来表示使用的编码标准。

    例如，添加以下记录将选择Codesize和Controversial内置规则集，以及/my/src/custom_ruleset.xml文件中定义的自定义规则集：

    “脚本”：{“phpmd”：“phpmd 代码大小，有争议，/my/src/custom_ruleset.xml”}

note

初始配置 PHP Mess Detector 后，composer.json中的进一步修改不会影响检查配置。要应用较新的更改，请在“设置/首选项”对话框 ( )的PHP |Quality Tools页面上重置 PHP Mess Detector 配置并更新项目依赖项。Ctrl+Alt+S

手动配置 PHP Mess Detector 检查

  1. 在Settings/Preferences对话框 ( Ctrl+Alt+S) 中，单击Editor下的Inspections。

  2. 在打开的检查页面上，展开PHP | Quality Tools节点并选中PHP Mess Detector validation旁边的复选框。

    tip

    如果您已经使用 Composer 安装了 PHP Mess Detector，但当前禁用了相应的检查，PhpStorm 会在composer.json中突出显示其记录。按下Alt+Enter并使用提供的启用检查快速修复来启用检查并打开检查页面。

    启用 PHP Mess Detector 检查

  3. 在右侧窗格中，使用选项区域中的控件配置 PHP Mess Detector 工具：

    • 从Severity列表中，选择PHP Mess Detector 检查的严重程度。选定的值决定了 PhpStorm 处理检测到的差异的严重程度并显示在检查结果中。

    • 从范围列表中，选择将检查应用程序限制到的范围。

    • 指定要应用的规则。

      • 要使用预定义规则，请在选项区域中，选中要执行的验证旁边的复选框。

      • 要使用自定义规则集：

        1. 创建并保存一个或多个规则集文件。有效的规则集文件是一个.xml文件，其中包含具有属性的<ruleset>根元素。name有关自定义规则集的更多详细信息，请参阅http://phpmd.org/documentation/creating-a-ruleset.html。

        2. 在自定义规则集区域中，单击添加按钮并在打开的对话框中选择相关的规则定义文件。当您单击OK时，将向自定义规则集列表添加一个新项目，其中Name字段显示从标记name内的属性检索到的规则集名称，而File字段显示所选规则集文件的位置。<ruleset>

与团队共享自定义编码风格

以批处理模式运行 PHP Mess Detector

从 PHP Mess Detector Validation 检查中排除文件

当等待 Mess Detector 响应超过Mess Detector对话框中Tool process timeout字段中指定的限制时，PhpStorm 建议将文件添加到忽略列表中。