PHP使用PHPStan優(yōu)化代碼

這篇文章給大家分享的是PHP使用PHPStan優(yōu)化代碼的方法。小編覺(jué)得挺實(shí)用的，因此分享給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧。

這里介紹一款PHP代碼靜態(tài)分析工具：PHPStan，不需要運(yùn)行代碼，也可以對(duì)代碼進(jìn)行嚴(yán)格的語(yǔ)法檢測(cè)，盡量將代碼運(yùn)行錯(cuò)誤率降到最低。

PHPStan

安裝

目前，PHPStanV0.10.2要求系統(tǒng)環(huán)境的PHP版本不低于7.1。用Composer全局安裝：

$ composer global require phpstan/phpstan

使用

PHPStan靜態(tài)分析的使用方法十分簡(jiǎn)單：

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

• configuration：運(yùn)行配置文件的路徑；

• level：嚴(yán)格級(jí)別，0-7，越大越嚴(yán)格；

• no-progress：不顯示進(jìn)度；

• debug：debug模式；

• autoload-file：自動(dòng)加載文件的路徑；

• errorFormat：錯(cuò)誤格式；

• memory-limit：內(nèi)存限制；

• paths：待分析的文件路徑。

比如，分析一個(gè)PHP文件：

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

PHPStan in VSCode

當(dāng)然，語(yǔ)法分析應(yīng)該是編輯器做的事，寫(xiě)完代碼還要切換到命令終端執(zhí)行phpstan，未免過(guò)于繁瑣。所以這里推薦一款VSCode擴(kuò)展：PHP Static Analysis。

PHP Static Analysis

首先，用Composer全局安裝PHPStan；然后，在VSCode的擴(kuò)展管理中搜索PHP Static Analysis，安裝第一個(gè)匹配的擴(kuò)展；重載VSCode重載窗口后，擴(kuò)展會(huì)自動(dòng)分析VSCode下打開(kāi)的PHP文件。

運(yùn)行效果：

比如，聲明了一個(gè)變量未調(diào)用，調(diào)用了一個(gè)未聲明的變量和調(diào)用了一個(gè)未定義的方法等等這樣錯(cuò)誤都會(huì)被檢測(cè)出了。

不過(guò)，寬松一點(diǎn)地來(lái)說(shuō)，其實(shí)$this->array()方法是存在的，只是通過(guò)魔術(shù)方法__call()實(shí)現(xiàn)的。

PHPStan with Laravel

高嚴(yán)格級(jí)別的PHPStan檢測(cè)到調(diào)用未聲明的類(lèi)方法時(shí)，會(huì)報(bào)告類(lèi)中方法不存在的錯(cuò)誤，即使這個(gè)類(lèi)定義了__call()或__callStatic()。

很多應(yīng)用框架為了優(yōu)雅，大量使用了魔術(shù)方法，比如Laravel。

用PHPStan檢測(cè)Laravel項(xiàng)目，自然會(huì)報(bào)告很多調(diào)用未聲明類(lèi)方法的錯(cuò)誤，對(duì)于這個(gè)問(wèn)題，可以借助laravel-ide-helper來(lái)降低誤報(bào)。

安裝laravel-ide-helper

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

注入LaravelIdeHelper

編輯app/Providers/AppServiceProvider.php里的注冊(cè)方法：

<?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

這時(shí)，Laravel框架中的Facade類(lèi)，原本通過(guò)__callStatic()獲取的靜態(tài)方法，全部在_ide_helper.php聲明了，在PHPStan檢測(cè)Laravel項(xiàng)目代碼時(shí)引入_ide_helper.php文件，就可以減少誤報(bào)。

PHPStan配置

在Laravel項(xiàng)目的根目錄下，新建phpstan.neon文件：

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

在Laravel項(xiàng)目的根目錄下，執(zhí)行phpstan命令時(shí)，會(huì)自動(dòng)使用phpstan.neon這個(gè)配置。

看完這篇文章，你們學(xué)會(huì)使用PHPStan優(yōu)化代碼了嗎？如果還想學(xué)到更多技能或想了解更多相關(guān)內(nèi)容，歡迎關(guān)注億速云行業(yè)資訊頻道，感謝各位的閱讀。