使用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中文网其他相关文章！