Comment vérifier les spécifications et la qualité du code à l'aide de PHP et PHPUnit

Dans le développement de logiciels modernes, la qualité du code et les spécifications sont des facteurs extrêmement importants. Non seulement cela peut rendre le code plus propre et plus facile à maintenir, mais cela peut également améliorer la lisibilité et l’évolutivité du code. Mais comment vérifier la qualité et les spécifications de votre code ? Cet article expliquera comment utiliser PHP et PHPUnit pour atteindre cet objectif.

Étape 1 : Vérifiez la spécification du code

Dans le développement PHP, il existe une spécification de code très populaire, appelée PSR (PHP Standard Spécification). Le but de la spécification PSR est de rendre le code PHP plus lisible et maintenable. Les plus connus d'entre eux sont le PSR-1 et le PSR-2.

Lorsque nous utilisons PHP et PHPUnit pour vérifier les spécifications du code, nous devons installer un outil appelé "PHP_CodeSniffer". Il s'agit d'un vérificateur de spécification de code PHP qui peut vérifier si le code est conforme aux spécifications PSR.

Utiliser PHP_CodeSniffer est très simple. Nous pouvons l'installer en tant que commande globale (installée via Composer), puis utiliser la commande suivante dans le terminal pour vérifier les spécifications du code :

phpcs --standard=PSR2 path/to/code

Où "path/to/code" doit être remplacé par le répertoire de code ou le chemin du fichier souhaité. à vérifier. Après avoir exécuté cette commande, le nombre de lignes qui ont violé la spécification et les détails de l'erreur seront affichés. Vous pouvez modifier le code en fonction de la sortie pour vous conformer à la spécification PSR.

En plus de la spécification PSR, PHP_CodeSniffer prend également en charge d'autres spécifications, telles que Zend, PEAR, Squiz, etc. Vous pouvez spécifier la spécification à utiliser sur la ligne de commande à l'aide de l'option --standard.

Étape 2 : Vérifier la qualité du code

En termes de spécifications du code, nous avons utilisé PHP_CodeSniffer pour la vérification. Cependant, cet outil ne peut pas vérifier la qualité du code. Afin de vérifier la qualité du code, nous devons utiliser un autre outil appelé "PHPMD".

PHPMD est un analyseur de code statique qui peut vérifier si le code est conforme à certains problèmes courants de qualité de code. Il prend en charge la vérification d'une mauvaise conception, d'un code trop complexe, d'un code inutilisé, etc.

Comme PHP_CodeSniffer, nous pouvons également utiliser Composer pour installer PHPMD globalement, puis utiliser des outils de ligne de commande pour vérifier la qualité du code. La commande suivante peut vérifier les problèmes de qualité du code dans le code :

phpmd path/to/code text cleancode,codesize,controversial,design,naming,unusedcode

Cette commande vérifiera tous les fichiers PHP dans le répertoire de code "path/to/code". Le paramètre "texte" précise le format des résultats à afficher. PHPMD prend en charge plusieurs formats de résultats, tels que HTML, XML, JSON, etc. Les derniers paramètres "cleancode,codesize,controversial,design,naming,unusedcode" précisent l'ensemble de règles à utiliser. Ils couvrent de nombreux problèmes courants de qualité du code.

Après avoir exécuté cette commande, les fichiers qui enfreignent les règles de qualité, le nombre de lignes et le type de règle violée seront affichés. Vous pouvez corriger le code en fonction des résultats pour obtenir une qualité de code supérieure.

Troisième étape : vérification de l'intégration

Si vous souhaitez automatiser ce processus, vous pouvez intégrer PHP_CodeSniffer et PHPMD dans le processus de construction. PHP_CodeSniffer et PHPMD sont inspectés à l'aide d'outils de ligne de commande, afin que nous puissions les exécuter dans le cadre du script de construction.

Par exemple, si vous utilisez PHPUnit comme framework de test, vous pouvez ajouter le code suivant dans le fichier de configuration phpunit.xml :

<target name="phpcs">
   <exec executable="phpcs">
      <arg value="--standard=PSR2"/>
      <arg value="./path/to/code"/>
   </exec>
</target>

<target name="phpmd">
   <exec executable="phpmd">
      <arg value="./path/to/code"/>
      <arg value="text"/>
      <arg value="cleancode,codesize,controversial,design,naming,unusedcode"/>
   </exec>
</target>

<target name="build" depends="phpcs,phpmd">
   <echo message="Build success!"/>
</target>

Dans cet exemple, nous avons défini deux cibles de build : phpcs et phpmd. Ces cibles effectueront respectivement une inspection du code de PHP_CodeSniffer et PHPMD. À la fin de la construction, nous afficherons un message indiquant que la construction a réussi.

Cet exemple est simple, mais vous pouvez l'étendre à un processus de construction plus complexe. Par exemple, vous pouvez empêcher la poursuite du processus de génération si les vérifications de la qualité du code et des spécifications échouent.

Conclusion

Dans cet article, nous avons expliqué comment utiliser PHP et PHPUnit pour vérifier la spécification et la qualité du code. Ces outils peuvent grandement améliorer la qualité et la maintenabilité de votre code. Ils sont très simples à utiliser et vous pouvez les intégrer dans votre processus de construction pour automatiser les contrôles. Que vous écriviez une petite application ou un grand projet, la qualité et la spécification du code doivent être l'une de vos priorités.

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!