代碼規(guī)范 - Phan靜態(tài)分析

luqiuwen 發(fā)布于2019-07-01 12:44 / 468人閱讀

摘要：簡(jiǎn)介是一個(gè)的靜態(tài)分析器，它傾向于最小化誤報(bào)。它試圖證明錯(cuò)誤而不是正確。它會(huì)查找常見問題，并在類型信息可用或可以推斷時(shí)驗(yàn)證各種操作的類型兼容性。

Phan 簡(jiǎn)介

Phan是一個(gè)PHP的靜態(tài)分析器，它傾向于最小化誤報(bào)。它試圖證明錯(cuò)誤而不是正確。

它會(huì)查找常見問題，并在類型信息可用或可以推斷時(shí)驗(yàn)證各種操作的類型兼容性。

擴(kuò)展安裝

ast

windows

mac: pecl install ast

pcntl.so

mac: 用源碼編譯安裝

windows: 不支持

入門

## 安裝
composer require --dev phan/phan

## 初始化配置
vendor/bin/phan --init --init-level=3

## 執(zhí)行
vendor/bin/phan

## 執(zhí)行(windows)
sh vendorinphan

核心配置解讀 .phan/config.php

return [
    // 開啟的子進(jìn)程數(shù)量，需要使用pcntl擴(kuò)展，windows不支持，mac安裝后，可以修改
    "processes" => 1,
    
    // 開啟進(jìn)度條
    "progress_bar" => true,
    
    // 解析的目錄（包含依賴，依賴需要從exclude剔除）
    "directory_list" => [
        "app",
        "vendor" // 建議最小化原則，少加載文件
    ],
    
    // 不需要解析的目錄
    "exclude_analysis_directory_list" => [
        "vendor",
        ".phan",
    ],
    
    // 需要解析的多帶帶的文件
    "file_list" => [],
    
    // 需要剔除的文件列表
    "exclude_file_list" => [],
    
    // 自動(dòng)加載的內(nèi)部類庫(kù)，一般用于加載擴(kuò)展stub，下面引入了laravel的stub
    "autoload_internal_extension_signatures" => [
        "laravelIdeHelper" => "_ide_helper.php",
        "laravelMeta" => ".phpstorm.meta.php"
    ],
]

忽略部分報(bào)錯(cuò)：建議盡量不要使用 suppress 忽略整個(gè)方法

class D {
    /**
     * @suppress PhanUndeclaredClassMethod
     */
    function g() {
        C::f();
    }
}

@phan-suppress-current-line 忽略當(dāng)前行

function test_line_suppression() {
    echo $undef1;  // @phan-suppress-current-line PhanUndeclaredVariable
    echo $undef2 + missingFn();
}

@phan-suppress-next-line 忽略下一行

function test_line_suppression() {
    // @phan-suppress-next-line PhanUndeclaredVariable, PhanUndeclaredFunction
    echo $undefVar2 + missing_function();  
}