使用PHPSA的靜態分析：PHP智能分析儀

靜態代碼分析工具，例如PHP Smart Analyzer (PHPSA)，對於維護高質量代碼至關重要，尤其是在大型項目中。這些工具自動審查代碼，檢測常見錯誤，強制執行編碼標準並清理代碼塊。

PHPSA是一款用戶友好的PHP靜態分析工具，可以檢測語法錯誤並提供有關代碼質量和編程標準的反饋。它可以作為.phar文件安裝，也可以通過Composer安裝。

除了檢測語法錯誤外，PHPSA還可以指出僅僅是其他函數別名的函數、未定義的屬性和缺少的文檔塊，並建議使用更好的編碼原則。它可以將未經文檔記錄的、雜亂的代碼轉換為完全記錄的清晰代碼。

儘管PHPSA仍處於早期alpha階段，一些功能尚不完善，但它是一個很有前景的工具，可以用於在代碼庫中強制執行質量標準。它在團隊環境中尤其寶貴，確保每個人都遵守相同的標準。建議將PHPSA與其他分析工具結合使用，以獲得全面的質量保證體系。

無論您是獨自工作還是團隊合作，是在小型項目還是大型項目上工作，一個不變的要求就是代碼質量。項目和團隊越大，維護起來就越困難。

減緩這種難度增加的一個好方法是使用靜態分析工具。靜態分析是在不實際執行程序的情況下分析軟件的過程——一種自動代碼審查。靜態分析工具將檢測常見錯誤，強制執行編碼標準，甚至清理代碼塊。 php -l filename 的時代並沒有結束，但我們現在有許多優秀的工具可以幫助我們創建和維護高質量的代碼。

說到php -l filename，也就是久經考驗的PHP lint，它將對目標文件執行語法分析並輸出它找到的任何錯誤。我過去經常使用這段代碼來發送帶有PHP的電子郵件。這是我們分析的一個很好的起點。

<?php 
class Email{

    //构造函数
    function Email( $subject, $message, $senderName, $senderEmail, $toList, $ccList=0, $bccList=0, $replyTo=0 ){

        $this->sender = $senderName . " <$senderEmail>";
        $this->replyTo = $replyTo;
        $this->subject = $subject;
        $this->message = $message;

        // 设置收件人
        if( is_array($toList)){
            $this->to = implode( $toList, "," );
        }else{
            $this->to = $toList;
        }

        // 设置抄送列表
        if( is_array($ccList) && count($ccList)){
            $this->cc = implode( $ccList, "," );
        }else{
            $this->cc = $ccList;
        }

        // 设置密送列表
        if( is_array($bccList) && count($bccList)){
            $this->bcc = implode( $bccList, "," );
        }else{
            $this->bcc = $bccList;
        }
    }

    function sendMail(){

        // 为PHP mail()函数创建标头
        $this->headers = "From: " . $this->sender . "\n";
        if( $this->replyTo ){
            $this->headers .= "Reply-To: " . $this->replyTo . "\n";
        }
        if( $this->cc ){
            $this->headers .= "Cc: " . $this->cc . "\n";
        }
        if( $this->bcc ){
            $this->headers .= "Bcc: " . $this->bcc . "\n";
        }

        print "To: " . $this->to ."<br></br>Subject: " . $this->subject . "<br></br>Message: " . $this->message . "<br></br>Headers: " . $this->headers;
        return mail( $this->to, $this->subject, $this->message, $this->headers );
    }
}

如您所見，這是一個簡單的電子郵件發送類。如果我們對這段代碼運行PHP lint，我們將看到一切正常。

php -l Email.php

結果如下：

No syntax errors detected in Email.php

在2016年，這個結果還不夠，因為我們還需要考慮代碼質量和編程標準。

進入PHP Smart Analyzer

PHPSA是一個PHP靜態分析工具。

PHPSA可以作為.phar文件安裝，也可以通過Composer安裝，如下所示：

composer require ovr/phpsa

這將創建一個命令行實用程序，該程序將鏈接到我們項目的vendor/bin文件夾。

使用PHPSA

安裝完成後，我們可以運行./vendor/bin/phpsa。

在上述執行之後得到的結果與運行list命令的結果相同。 help命令將列出在PHPSA上運行幫助的說明。 check命令將對指定文件或文件夾執行靜態分析。

因為我們之前運行了PHP lint，所以預計PHPSA不會在我們的代碼中找到任何語法錯誤。但是，如果我們故意插入一個錯誤會怎樣？ PHPSA能夠找到它嗎？

讓我們在我們的Email類中做一個小小的改變。 (此處省略修改後的代碼，與原文相同，只是為了避免重複)

這次，我們的代碼中有一個明顯的語法錯誤。讓我們運行PHPSA並檢查結果。

如我們所見，PHPSA能夠快速檢測到語法錯誤。但這實際上並沒有什麼新意，我們簡單的PHP lint也可以檢測到這個錯誤。因此，讓我們糾正它並檢查PHPSA還有什麼其他功能。

現在有很多東西需要查看！ (此處省略PHPSA的警告信息，與原文相同，只是為了避免重複)

讓我們修復我們的代碼以糾正所有上述問題。 (此處省略修改後的代碼，與原文相同，只是為了避免重複)

運行PHPSA後，我們將看不到任何錯誤或警告，這意味著我們剛剛為我們的代碼增加了另一層質量。

結論

PHPSA是開源的，這意味著我們實際上可以跟踪它的開發，請求功能並為其貢獻代碼，並且由於它是一個專注的工具，因此PHPSA快速且輕量級。目前它仍處於早期alpha階段，這意味著它有時可能會表現異常，主要是在不同的操作系統上給出不同的結果。此外，許多功能仍在開發中。

如果我們想在代碼庫中強制執行質量標準，靜態分析是一個有價值的工具。當在團隊中工作時，它變得更有價值，因為它迫使每個人都使用相同的標準。儘管它在某些方面仍落後於其他一些工具，例如Code Sniffer或Mess Detector，但PHPSA是一個非常有用的工具，顯示出很大的前景。由於覆蓋更廣泛的錯誤的更好方法之一是結合各種分析工具，因此請考慮在您的QA堆棧中使用PHPSA。一定要試一試，也許可以為github上的項目做出貢獻，在那裡列出了各種待辦事項和計劃的功能。

您嘗試過PHPSA了嗎？讓我們知道您覺得它與其他工具相比如何！

(此處省略FAQ部分，與原文相同，只是為了避免重複)

以上是使用PHPSA的靜態分析：PHP智能分析儀的詳細內容。更多資訊請關注PHP中文網其他相關文章！