PHP代碼靜態分析工具PHPStan

最近發現本身寫的PHP代碼運行結果總跟本身預想的不同，排查時發現大可能是語法錯誤，在運行以前錯誤已經種下。多是本身粗枝大葉，或者說 php -l檢測太簡單，不過的確是有一些語法錯誤埋藏得太深（畢竟PHP是動態語言），那麼有沒有辦法，在代碼代碼正式運行以前，把語法錯誤全找出來呢？

這裏介紹一款PHP代碼靜態分析工具：PHPStan，不須要運行代碼，也能夠對代碼進行嚴格的語法檢測，儘可能將代碼運行錯誤率降到最低。

PHPStan

安裝

目前，PHPStanV0.10.2要求系統環境的PHP版本不低於7.1。用Composer全局安裝：

$ composer global require phpstan/phpstan

使用

PHPStan靜態分析的使用方法十分簡單：

$ phpstan analyse [-c|--configuration CONFIGURATION] [-l|--level LEVEL] [--no-progress] [--debug] [-a|--autoload-file AUTOLOAD-FILE] [--errorFormat ERRORFORMAT] [--memory-limit MEMORY-LIMIT] [--] [<paths>]...

• configuration：運行配置文件的路徑；
• level：嚴格級別，0-7，越大越嚴格；
• no-progress：不顯示進度；
• debug：debug模式；
• autoload-file：自動加載文件的路徑；
• errorFormat：錯誤格式；
• memory-limit：內存限制；
• paths：待分析的文件路徑。

好比，分析一個PHP文件：

$ phpstan analyse --level=7 --autoload-file=/PATH/TO/vendor/autoload.php /PATH/TO/someone.php

PHPStan in VSCode

固然，語法分析應該是編輯器作的事，寫完代碼還要切換到命令終端執行phpstan，未免過於繁瑣。因此這裏推薦一款VSCode擴展：PHP Static Analysis。

首先，用Composer全局安裝PHPStan；而後，在VSCode的擴展管理中搜索PHP Static Analysis，安裝第一個匹配的擴展；重載VSCode重載窗口後，擴展會自動分析VSCode下打開的PHP文件。

運行效果：

好比，聲明瞭一個變量未調用，調用了一個未聲明的變量和調用了一個未定義的方法等等這樣錯誤都會被檢測出了。

不過，寬鬆一點地來講，其實$this->array()方法是存在的，只是經過魔術方法__call()實現的。

PHPStan with Laravel

高嚴格級別的PHPStan檢測到調用未聲明的類方法時，會報告類中方法不存在的錯誤，即便這個類定義了__call()或__callStatic()。

不少應用框架爲了優雅，大量使用了魔術方法，好比Laravel。
用PHPStan檢測Laravel項目，天然會報告不少調用未聲明類方法的錯誤，對於這個問題，能夠藉助laravel-ide-helper來下降誤報。

安裝laravel-ide-helper

$ cd /PATH/TO/LARAVEL_PROJECT
$ composer require barryvdh/laravel-ide-helper

注入LaravelIdeHelper

編輯app/Providers/AppServiceProvider.php裏的註冊方法：

<?php
    ...
    public function register()
    {
        if ($this->app->environment() !== 'production') {
            $this->app->register(\Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class);
        }
        // ...
    }

生成_ide_helper.php

$ cd /PATH/TO/LARAVEL_PROJECT
$ php artisan ide-helper:generate

這時，Laravel框架中的Facade類，本來經過__callStatic()獲取的靜態方法，所有在_ide_helper.php聲明瞭，在PHPStan檢測Laravel項目代碼時引入_ide_helper.php文件，就能夠減小誤報。

PHPStan配置

在Laravel項目的根目錄下，新建phpstan.neon文件：

parameters:
    autoload_files:
        - %currentWorkingDirectory%/_ide_helper.php

在Laravel項目的根目錄下，執行phpstan命令時，會自動使用phpstan.neon這個配置。

最後

代碼的語法錯誤，應該在編寫的時候及時發現，儘可能減小正式運行時錯誤。