如何使用Composer和ekino/phpstan-banned-code解决PHP项目中的调试代码问题？-composer-PHP中文网

如何使用Composer和ekino/phpstan-banned-code解决PHP项目中的调试代码问题？

WBOY

发布： 2025-04-25 19:18:20

原创

772人浏览过

可以通过以下地址学习 composer：学习地址

在开发过程中，我遇到了一个棘手的问题：项目中残留了大量的调试代码，如 var_dump、exit 等。这些代码在开发阶段非常有用，但在生产环境中却成了隐患。它们不仅会导致性能问题，还可能泄露敏感信息。为了解决这个问题，我决定使用 ekino/phpstan-banned-code 库，通过 Composer 来检测和禁止这些调试代码。

首先，通过 Composer 安装 ekino/phpstan-banned-code 库非常简单，只需运行以下命令：

composer require --dev ekino/phpstan-banned-code

登录后复制

如果使用了 PHPStan 的扩展安装器，安装后就已经完成了配置。如果没有使用扩展安装器，则需要在你的 PHPStan 配置文件中包含 extension.neon 文件：

includes:
    - vendor/ekino/phpstan-banned-code/extension.neon

登录后复制

接下来，可以通过配置文件来定制你想要检测的代码类型。例如，禁止 echo、eval、die/exit 以及一系列调试函数：

立即学习“PHP免费学习笔记（深入）”；

parameters:
    banned_code:
        nodes:
            # 检测 echo
            -
                type: Stmt_Echo
                functions: null

            # 检测 eval
            -
                type: Expr_Eval
                functions: null

            # 检测 die/exit
            -
                type: Expr_Exit
                functions: null

            # 检测一系列函数
            -
                type: Expr_FuncCall
                functions:
                    - dd
                    - debug_backtrace
                    - dump
                    - exec
                    - passthru
                    - phpinfo
                    - print_r
                    - proc_open
                    - shell_exec
                    - system
                    - var_dump

            # 检测 print 语句
            -
                type: Expr_Print
                functions: null

            # 检测反引号执行 shell 命令
            -
                type: Expr_ShellExec
                functions: null

        # 检测非测试文件中使用测试命名空间
        use_from_tests: true

        # 设置错误是否可忽略
        non_ignorable: false # 默认是 true

登录后复制

通过这种方式，ekino/phpstan-banned-code 库可以帮助我们在代码审查和 CI 流程中自动检测这些不规范的代码，确保它们不会出现在生产环境中。

使用 ekino/phpstan-banned-code 的优势在于，它不仅可以检测常见的调试代码，还可以根据项目需求定制检测规则，灵活性极高。实际应用中，我发现它大大减少了人工审查的工作量，同时提高了代码的规范性和安全性。

总之，借助 Composer 和 ekino/phpstan-banned-code 库，我们可以轻松地解决 PHP 项目中调试代码的问题，确保项目的高质量和安全性。

以上就是如何使用Composer和ekino/phpstan-banned-code解决PHP项目中的调试代码问题？的详细内容，更多请关注php中文网其它相关文章！