在開發(fā)過程中，我遇到了一個棘手的問題：項目中殘留了大量的調試代碼，如 var_dump、exit 等。這些代碼在開發(fā)階段非常有用，但在生產(chǎn)環(huán)境中卻成了隱患。它們不僅會導致性能問題，還可能泄露敏感信息。為了解決這個問題，我決定使用 ekino/phpstan-banned-code 庫，通過 composer 來檢測和禁止這些調試代碼。
首先，通過 Composer 安裝 ekino/phpstan-banned-code 庫非常簡單，只需運行以下命令：
composer require --dev ekino/phpstan-banned-code
如果使用了 PHPStan 的擴展安裝器，安裝后就已經(jīng)完成了配置。如果沒有使用擴展安裝器，則需要在你的 PHPStan 配置文件中包含 extension.neon 文件：
includes: - vendor/ekino/phpstan-banned-code/extension.neon
接下來，可以通過配置文件來定制你想要檢測的代碼類型。例如，禁止 echo、eval、die/exit 以及一系列調試函數(shù)：
立即學習“PHP免費學習筆記（深入）”；
parameters: banned_code: nodes: # 檢測 echo - type: Stmt_Echo functions: null # 檢測 eval - type: Expr_Eval functions: null # 檢測 die/exit - type: Expr_Exit functions: null # 檢測一系列函數(shù) - 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 # 檢測反引號執(zhí)行 shell 命令 - type: Expr_ShellExec functions: null # 檢測非測試文件中使用測試命名空間 use_from_tests: true # 設置錯誤是否可忽略 non_ignorable: false # 默認是 true
通過這種方式，ekino/phpstan-banned-code 庫可以幫助我們在代碼審查和 CI 流程中自動檢測這些不規(guī)范的代碼，確保它們不會出現(xiàn)在生產(chǎn)環(huán)境中。
使用 ekino/phpstan-banned-code 的優(yōu)勢在于，它不僅可以檢測常見的調試代碼，還可以根據(jù)項目需求定制檢測規(guī)則，靈活性極高。實際應用中，我發(fā)現(xiàn)它大大減少了人工審查的工作量，同時提高了代碼的規(guī)范性和安全性。
總之，借助 Composer 和 ekino/phpstan-banned-code 庫，我們可以輕松地解決 PHP 項目中調試代碼的問題，確保項目的高質量和安全性。
