Analyse statique avec PHPSA: PHP Smart Analyzer

Les outils d'analyse de code statique, tels que PHP Smart Analyzer (PHPSA), sont essentiels pour maintenir le code de haute qualité, en particulier dans les grands projets. Ces outils examinent automatiquement le code, détectent les erreurs courantes, appliquent les normes de codage et les blocs de code nettoyants.

PHPSA est un outil d'analyse statique PHP convivial qui détecte les erreurs de syntaxe et fournit des commentaires sur la qualité du code et les normes de programmation. Il peut être installé en tant que fichier .phar ou via le compositeur.

En plus de détecter les erreurs de syntaxe, PHPSA peut également souligner des fonctions qui ne sont que d'autres alias de fonction, des propriétés non définies et des blocs de documents manquants et recommander de meilleurs principes de codage. Il peut convertir le code sans papiers et encombré en code clair entièrement documenté.

Bien que PHPSA soit encore dans son stade alpha précoce et que certaines fonctionnalités ne sont pas encore parfaites, c'est un outil prometteur pour faire respecter les normes de qualité dans la base de code. Il est particulièrement précieux dans un environnement d'équipe, garantissant que tout le monde adhère aux mêmes normes. Il est recommandé d'utiliser PHPSA en combinaison avec d'autres outils analytiques pour obtenir un système complet d'assurance qualité.

Que vous travailliez seul ou dans le travail d'équipe, travaillant sur de petits ou grands projets, une exigence constante est la qualité du code. Plus le projet et l'équipe sont gros, plus il est difficile de le maintenir.

Un bon moyen de ralentir cette augmentation de difficulté est d'utiliser des outils d'analyse statique. L'analyse statique est le processus d'analyse des logiciels sans exécuter réellement un programme - un type d'examen automatique de code. Les outils d'analyse statique détecteront les erreurs courantes, appliqueront les normes de codage et même le nettoyage des blocs de code. L'ère de php -l filename n'est pas terminée, mais nous avons maintenant de nombreux excellents outils qui peuvent nous aider à créer et à maintenir du code de haute qualité.

En parlant de php -l filename, le peluche PHP éprouvé, il effectuera une analyse de syntaxe sur le fichier cible et sortira toutes les erreurs qu'il trouve. J'utilisais ce code pour envoyer des e-mails avec PHP. C'est un bon point de départ pour notre 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 );
    }
}

Comme vous pouvez le voir, il s'agit d'un simple e-mail d'envoi de cours. Si nous exécutons PHP Lint sur ce code, nous verrons que tout fonctionne bien.

php -l Email.php

Les résultats sont les suivants:

Aucune erreur de syntaxe détectée dans email.php

En 2016, ce résultat n'a pas été suffisant car nous devons également considérer la qualité du code et les normes de programmation.

Entrez PHP Smart Analyzer

PHPSA est un outil d'analyse statique PHP.

PHPSA peut être installé en tant que fichier .phar ou via le compositeur, comme indiqué ci-dessous:

composer require ovr/phpsa

Cela créera un utilitaire de ligne de commande qui sera lié au dossier Vendor / Bin de notre projet.

en utilisant phpsa

Une fois l'installation terminée, nous pouvons exécuter ./vendor/bin/phpsa.

Le résultat obtenu après l'exécution ci-dessus est le même que le résultat de l'exécution de la commande List. La commande d'aide répertorie les instructions pour exécuter l'aide sur PHPSA. La commande Check effectue une analyse statique sur le fichier ou le dossier spécifié.

Parce que nous avons déjà exécuté des peluches PHP, nous ne devons pas trouver d'erreurs de syntaxe dans notre code. Mais que se passe-t-il si nous insérons délibérément une erreur? PHPSA peut-il le trouver?

Faisons un petit changement dans notre classe de messagerie. (Le code modifié est omis ici, le même que le texte d'origine, juste pour éviter la duplication)

Cette fois, il y a une erreur de syntaxe évidente dans notre code. Exécutons PHPSA et vérifions les résultats.

Comme nous pouvons le voir, PHPSA est capable de détecter rapidement les erreurs de syntaxe. Mais ce n'est en fait rien de nouveau, et notre simple peluche PHP peut également détecter cette erreur. Alors, corrigeons-le et vérifions quelles autres fonctionnalités il y a dans PHPSA.

Il y a beaucoup à voir maintenant! (Les informations d'avertissement de PHPSA sont omises ici, comme le texte d'origine, juste pour éviter la duplication)

Corrigeons notre code pour corriger tous les problèmes ci-dessus. (Le code modifié est omis ici, le même que le texte d'origine, juste pour éviter la duplication)

Après avoir exécuté PHPSA, nous ne verrons aucune erreur ou avertisseur, ce qui signifie que nous avons simplement ajouté une autre couche de qualité à notre code.

Conclusion

PHPSA est open source, ce qui signifie que nous pouvons réellement suivre son développement, demander des fonctionnalités et y contribuer du code, et comme il s'agit d'un outil ciblé, PHPSA est rapide et léger. Il est encore au début du stade alpha en ce moment, ce qui signifie qu'il peut se comporter parfois anormalement, donnant principalement des résultats différents sur différents systèmes d'exploitation. De plus, de nombreuses fonctionnalités sont toujours en cours de développement.

L'analyse statique est un outil précieux si nous voulons appliquer les normes de qualité dans notre base de code. Lorsque vous travaillez dans une équipe, cela devient plus précieux car il oblige tout le monde à utiliser les mêmes normes. Bien qu'il soit encore à la traîne de certains autres outils à certains égards, tels que Code Sniffer ou Mess Detector, PHPSA est un outil très utile qui montre de grandes prospects. Étant donné que l'une des meilleures façons de couvrir une plus large gamme d'erreurs est de combiner divers outils analytiques, envisagez d'utiliser PHPSA dans votre pile QA. Assurez-vous de l'essayer, contribuant peut-être à des projets sur GitHub, où diverses fonctionnalités tâches et planifiées sont répertoriées.

Avez-vous essayé PHPSA? Faites-nous savoir comment vous pensez que cela se compare à d'autres outils!

(La partie FAQ est omise ici, la même que le texte d'origine, juste pour éviter la duplication)

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!