Maîtriser la refactorisation du code : un guide complet d'utilisation de Rector PHP

Photo de Matteo del Piano sur Unsplash

Introduction au Recteur PHP

Dans le monde en constante évolution du développement PHP, il est crucial de garder votre base de code propre, à jour et efficace. C'est là que Rector PHP entre en jeu. Si vous vous demandez comment utiliser Rector PHP, comment l'installer ou ce qu'est exactement Rector PHP, ce guide complet est fait pour vous. Nous vous expliquerons les bases, fournirons un didacticiel Rector PHP détaillé et vous offrirons des informations sur PHP Rector et comment l'utiliser efficacement. À la fin de cet article, vous aurez une solide compréhension de Rector PHP et de la manière dont il peut améliorer votre flux de travail de développement.

Qu’est-ce que le Recteur PHP ?

Rector a été lancé en 2020, mais n'a obtenu sa version 1.0 qu'en 2024. Il s'agit d'un outil de ligne de commande qui effectue une analyse statique d'une base de code. À partir de cette analyse, des changements peuvent être appliqués. Je suppose qu'un bon exemple de ceci serait ce qui se passerait si votre base de code était criblée d'appels array() alors que cela est maintenant considéré comme une vieille pratique, maintenant remplacée par la syntaxe de tableau court [].

Parcourir une base de code pour remplacer cela est fastidieux. Nous pourrions utiliser un simple outil de recherche et de remplacement, mais que se passerait-il s'il y avait un array() encapsulant une chaîne ou à l'intérieur d'un commentaire qui ne devrait pas être modifié ? Nous devons maintenant vérifier chaque instance que nous sommes remplacés.

Ce genre de problème est dans lequel Rector excelle. Au lieu de cela, Rector est capable de regarder le code et de savoir définitivement s'il s'agit d'un tableau à remplacer.

Vous vous demandez peut-être, PHP CS Fixer peut également le faire, ce qui est vrai. Mais Rector fait également fonctionner PHPStan sous le capot non seulement pour reconnaître la syntaxe, mais également pour analyser les types. Cela signifie que Rector peut détecter quand une classe a une classe parent particulière, quand une variable est d'un type particulier ou quel est le type de retour attendu d'une fonction. Ce qui lui donne une portée beaucoup plus grande pour apporter des modifications en masse à une base de code.

Comment installer le recteur PHP

Cela peut sembler évident pour les développeurs PHP expérimentés, mais il existe deux manières principales et cela dépend vraiment de la manière dont vous souhaitez utiliser Rector.

Si vous souhaitez utiliser Rector dans le cadre d'une intégration continue, il est logique d'installer Rector différemment dans vos projets via composer.

composer require --dev rector/rector

Mais si vous souhaitez expérimenter Rector sur un ou plusieurs projets pour effectuer des mises à niveau, vous feriez peut-être mieux d'installer Rector globalement en utilisant

composer global require rector/rector

Quelle que soit l'étape que vous choisissez, l'étape suivante consistera à créer une configuration dans le répertoire racine d'un projet et à inclure tous les dossiers contenant du code PHP que vous souhaitez mettre à niveau. Cela n’inclut bien sûr pas le dossier du fournisseur car nous ne voulons pas le modifier.

Voici à quoi pourrait ressembler une configuration pour, par exemple, un projet Laravel :

use Rector\Config\RectorConfig;
use Rector\Php71\Rector\List_\ListToArrayDestructRector;

return RectorConfig::configure()
    ->withPaths([__DIR__. '/config', __DIR__. '/src', __DIR__. '/tests', __DIR__. '/routes'])
    ->withImportNames(removeUnusedImports: true);

Recteur PHP : comment l'utiliser efficacement

Comme dans la dernière section, l'utilisation de Rector peut être déterminée par la manière dont vous souhaitez l'utiliser. Le recteur applique les modifications à travers les sélections de règles. C'est la même chose que PHP CS Fixer. Ces règles détecteront le problème, puis tenteront de résoudre le problème pour lequel elles sont conçues.

Si nous souhaitons utiliser Rector de manière intégrée continue, parce que nous voulons que tout le code soit aussi optimisé que possible au fur et à mesure que nous le développons, nous pouvons utiliser uniquement un ensemble particulier de règles.

Rector a des ensembles de règles, souvent décrites comme Dead Code ou Code Quality, qui suppriment le code ou améliorent et optimisent respectivement. Il est très avantageux de s’en tenir uniquement à ces ensembles car nous pouvons être sûrs qu’ils fonctionnent la plupart du temps. Mais vous devez absolument être conscient que la façon dont Rector écrit le code n’est jamais parfaite. Souvent, lorsque des règles sont écrites, elles peuvent couvrir des scénarios typiques et manquer certaines circonstances liées à votre base de code. Cela pourrait conduire à un code cassé.

Dans le cas où vous souhaiteriez utiliser Rector, vous devez absolument avoir des tests écrits pour votre application. Sans eux, Rector peut facilement conduire à l’introduction de bugs que vous ne découvrirez pas tant qu’il ne s’agit pas d’un problème.

Une autre chose à considérer lors de l'utilisation de Rector est que vous devez utiliser un outil de peluchage comme PHP CS Fixer. Rector ne regarde pas les espaces, les espaces et les nouvelles lignes entre les appels de méthode et ses arguments, etc. L'utilisation d'un outil de peluchage devrait maintenir le formatage du code à la norme que vous attendez une fois que Rector a appliqué ses correctifs.

Tutoriel PHP Rector étape par étape

Maintenant que nous avons installé Rector et que nous sommes prêts à l'essayer, essayons d'appliquer une règle. Commençons par mettre à jour notre fichier de configuration que nous avons créé plus tôt.

use Rector\Config\RectorConfig;
use Rector\Php71\Rector\List_\ListToArrayDestructRector;

return RectorConfig::configure()
    ->withPaths([__DIR__. '/config', __DIR__. '/src', __DIR__. '/tests', __DIR__. '/routes'])
    ->withImportNames(removeUnusedImports: true)
    ->withRules([
        ListToArrayDestructRector::class,
    ]);

Dans le cas de cette configuration, nous allons remplacer l'utilisation de lists afin d'utiliser à la place la restructuration de tableaux. Les changements que nous nous attendons à apporter sont les suivants :

-list($a, $b) = ['a', 'b'];
+[$a, $b] = ['a', 'b'];

Now we can test this config by performing a dry run of Rector.

rector --dry-run

If everything has been successful we should now see an output that contains a diff of all the changes to each file, with a list of the rules that made the changes. Our config only lists one rule so only one rule is applied but if more rules are added we’ll see a list of one or more here.

This is then a great time to review the changes and make sure the rule is performing as expected. Once we’re happy we can run Rector again. Without the dry run flag, changes will be written to the files.

rector

After it’s completed we should run our favourite linting tool and then run our tests. That’s it. We’ve now used Rector.

Conclusion: Boosting Your PHP Development with Rector

Rector PHP is a powerful tool that can significantly enhance your PHP development workflow by automating code refactoring and ensuring your codebase remains clean and modern. By understanding what Rector PHP is, learning how to install it, and mastering how to use it effectively, you can leverage its capabilities to streamline code updates, improve code quality, and reduce the risk of code feeling like a “legacy” project. Whether you’re integrating Rector into your continuous integration pipeline or using it for large-scale codebase upgrades, Rector is an indispensable asset for any PHP developer looking to maintain a high standard of code excellence.

If you want to take you knowledge of Rector further I suggest going to https://getrector.com/.

I’m Peter Fox, a software developer in the UK who works with Laravel. Thank you for reading my article, I’ve got many more to read at https://articles.peterfox.me. I’m also now Sponsorable on GitHub. If you’d like to encourage me to write more articles like this please do consider dropping a small one-off donation.

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!