Statische Analyse mit PHPSA: PHP Smart Analyzer

Tools für statische Codeanalyse wie PHP Smart Analyzer (PHPSA) sind entscheidend für die Aufrechterhaltung eines qualitativ hochwertigen Code, insbesondere in großen Projekten. Diese Tools überprüfen automatisch den Code, erkennen gemeinsame Fehler, erzwingen Codierungsstandards und saubere Codeblöcke.

PHPSA ist ein benutzerfreundliches PHP-statischer Analyse-Tool, das Syntaxfehler erkennt und Feedback zu Codequalität und Programmierstandards bietet. Es kann als .phar -Datei oder über einen Komponisten installiert werden.

Zusätzlich zum Erkennen von Syntaxfehlern kann PHPSA auch auf Funktionen hinweisen, die nur andere Funktionen, undefinierte Eigenschaften und fehlende Dokumentblöcke sind und bessere Codierungsprinzipien empfehlen. Es kann undokumentierte, überfüllte Code in einen vollständig dokumentierten Code umwandeln.

Obwohl sich PHPSA noch in der frühen Alpha -Phase befindet und einige Funktionen noch nicht perfekt sind, ist es ein vielversprechendes Instrument zur Durchsetzung von Qualitätsstandards in der Codebasis. In einer Teamumgebung ist es besonders wertvoll und sorgt dafür, dass jeder die gleichen Standards hält. Es wird empfohlen, PHPSA in Kombination mit anderen analytischen Tools zu verwenden, um ein umfassendes Qualitätssicherungssystem zu erhalten.

Unabhängig davon, ob Sie alleine oder in Teamwork arbeiten und an kleinen oder großen Projekten arbeiten, ist eine konstante Anforderung die Codequalität. Je größer das Projekt und das Team ist, desto schwieriger ist es, es aufrechtzuerhalten.

Eine gute Möglichkeit, diese Schwierigkeit zu verlangsamen, besteht darin, statische Analysewerkzeuge zu verwenden. Die statische Analyse ist der Prozess der Analyse von Software, ohne tatsächlich ein Programm auszuführen - eine Art automatischer Codeüberprüfung. Statische Analyse -Tools erkennen gemeinsame Fehler, erzwingen die Codierungsstandards und säuberten sogar Codeblöcke. Die Ära von php -l filename ist noch nicht vorbei, aber wir haben jetzt viele hervorragende Tools, mit denen wir qualitativ hochwertige Code erstellen und aufrechterhalten können.

Apropos php -l filename, dem bewährten PHP -Lint, wird eine Syntaxanalyse in der Zieldatei durchgeführt und alle fundierenden Fehler ausgegeben. Ich habe diesen Code verwendet, um E -Mails mit PHP zu senden. Dies ist ein guter Ausgangspunkt für unsere Analyse.

<?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 );
    }
}

Wie Sie sehen, ist dies eine einfache E -Mail -Sendeklasse. Wenn wir PHP -Lint in diesem Code ausführen, werden wir sehen, dass alles gut funktioniert.

php -l Email.php

Die Ergebnisse sind wie folgt:

Keine Syntaxfehler in E -Mail.php

erkannt

im Jahr 2016 war dieses Ergebnis nicht ausreichend, da wir auch Codequalität und Programmierstandards in Betracht ziehen müssen.

PHP Smart Analyzer

eingeben

PHPSA ist ein statisches PHP -Tool.

PHPSA kann als .Phar -Datei oder über einen Komponisten installiert werden, wie unten gezeigt:

composer require ovr/phpsa

Dies erstellt ein Befehlszeilen -Dienstprogramm, das mit dem Ordner unseres Projekts mit dem Anbieter/Bin -Ordner verknüpft wird.

Verwenden Sie PHPSA

Nach Abschluss der Installation können wir ./vendor/bin/phpsa ausführen.

Das nach der obigen Ausführung erhaltene Ergebnis entspricht dem Ergebnis des Ausführens des Befehls von Listen. In dem Befehl help listet Anweisungen zum Ausführen der Hilfe auf PHPSA auf. Mit dem Befehl check achte eine statische Analyse in der angegebenen Datei oder in der angegebenen Ordner.

Da wir zuvor PHP -Lint ausgeführt haben, wird nicht erwartet, dass wir Syntaxfehler in unserem Code finden. Aber was passiert, wenn wir absichtlich einen Fehler einfügen? Kann PHPSA es finden?

Lassen Sie uns in unserer E -Mail -Klasse eine kleine Änderung vornehmen. (Der geänderte Code wird hier weggelassen, genau wie der Originaltext, nur um eine Duplikation zu vermeiden)

Diesmal gibt es einen offensichtlichen Syntaxfehler in unserem Code. Lassen Sie uns PHPSA ausführen und die Ergebnisse überprüfen.

Wie wir sehen können, kann PHPSA Syntaxfehler schnell erkennen. Dies ist jedoch eigentlich nichts Neues, und unser einfacher PHP -Lint kann diesen Fehler auch erkennen. Lassen Sie uns es also korrigieren und überprüfen, welche anderen Funktionen es in PHPSA gibt.

Es gibt jetzt viel zu sehen! (Die Warninformationen von PHPSA sind hier weggelassen, genau wie der Originaltext, um eine Duplikation zu vermeiden)

Lassen Sie uns unseren Code beheben, um alle oben genannten Probleme zu korrigieren. (Der geänderte Code wird hier weggelassen, genau wie der Originaltext, nur um eine Duplikation zu vermeiden)

Nach dem Ausführen von PHPSA werden wir keine Fehler oder Warnungen sehen, was bedeutet, dass wir unserem Code nur eine weitere Qualitätsebene hinzugefügt haben.

Schlussfolgerung

PHPSA ist Open Source, was bedeutet, dass wir ihre Entwicklung verfolgen, Funktionen anfordern und Code dazu beitragen können. Da es sich um ein fokussiertes Tool handelt, ist PHPSA schnell und leicht. Es befindet sich im Moment noch im frühen Alpha -Stadium, was bedeutet, dass es sich manchmal abnormal verhalten kann, was hauptsächlich unterschiedliche Ergebnisse auf verschiedenen Betriebssystemen liefert. Darüber hinaus befinden sich noch viele Funktionen.

Statische Analyse ist ein wertvolles Instrument, wenn wir Qualitätsstandards in unserer Codebasis durchsetzen möchten. Bei der Arbeit in einem Team wird es wertvoller, weil es alle dazu zwingt, dieselben Standards zu verwenden. Obwohl es in gewisser Weise immer noch hinter einigen anderen Tools zurückbleibt, wie z. B. Code -Sniffer oder Messdetektor, ist PHPSA ein sehr nützliches Tool, das großartige Aussichten zeigt. Da eine der besseren Möglichkeiten, um eine größere Auswahl an Fehlern abzudecken, darin besteht, verschiedene analytische Tools zu kombinieren, sollten Sie PHPSA in Ihrem QA -Stapel verwenden. Probieren Sie es aus und tragen Sie möglicherweise zu Projekten auf Github bei, bei denen verschiedene Aufgaben und geplante Funktionen aufgeführt sind.

Haben Sie PHPSA ausprobiert? Lassen Sie uns wissen, wie Sie es vergleichbar mit anderen Werkzeugen!

(Der FAQ -Teil wird hier weggelassen, genauso wie der Originaltext, nur um eine Duplikation zu vermeiden)

Das obige ist der detaillierte Inhalt vonStatische Analyse mit PHPSA: PHP Smart Analyzer. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!