0

0

掌握代码重构:使用 Rector PHP 的完整指南

王林

王林

发布时间:2024-08-26 09:03:10

|

754人浏览过

|

来源于dev.to

转载

掌握代码重构:使用 Rector PHP 的完整指南
照片由 matteo del piano 在 unsplash 上拍摄

php 校长简介

在不断发展的 php 开发世界中,保持代码库干净、最新且高效至关重要。这就是 rector php 发挥作用的地方。如果您一直想知道如何使用 rector php、如何安装它或者 rector php 到底是什么,那么这份综合指南非常适合您。我们将引导您了解基础知识,提供详细的 rector php 教程,并提供有关 php rector 以及如何有效使用它的见解。读完本文后,您将牢牢掌握 rector php 以及它如何增强您的开发工作流程。

php 校长是什么?

rector 于 2020 年启动,但在 2024 年才发布 1.0 版本。它是一个对代码库执行静态分析的命令行工具。根据该分析可以应用更改。我想一个很好的例子是,如果你的代码库充满了 array() 调用,而这现在被认为是一种旧的做法,现在被 [] 短数组语法取代。

通过代码库来替换它是很乏味的。我们可以使用一个简单的查找和替换工具,但是如果有一个 array() 封装了一个字符串或一个不应更改的注释,该怎么办?现在我们必须检查每个被替换的实例。

这类问题正是rector所擅长的。相反,rector 能够查看代码并明确知道它是否是要替换的数组。

你可能会问,php cs fixer 也可以做到这一点,这是真的。但 rector 还让 phpstan 在后台工作,不仅可以识别语法,还可以分析类型。这意味着 rector 可以检测某个类何时具有特定的父类、变量何时为特定类型或函数的预期返回类型。给予它更大的范围来对代码库进行大量更改。

立即学习PHP免费学习笔记(深入)”;

如何安装 rector php

对于经验丰富的 php 开发人员来说,这似乎是显而易见的,但有两种主要方法,这实际上取决于您想要如何使用 rector。

如果您想使用 rector 作为持续集成的一部分,那么通过 composer 将不同的 rector 安装到您的项目中是有意义的。

composer require --dev rector/rector

但是,如果您想在单个或多个项目上尝试使用 rector 来执行升级,那么最好使用
全局安装 rector

composer global require rector/rector

无论您选择哪一步,下一步都是在项目的根目录中创建一个配置,并包含所有包含您希望升级的 php 代码的文件夹。当然,这不包括供应商文件夹,因为我们不想修改它。

这就是 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);

php rector:如何有效使用它

就像上一节一样,使用 rector 可以根据你想如何使用它来决定。校长通过选择规则来应用变更。这与 php cs fixer 相同。这些规则都会检测问题,然后尝试解决它们旨在解决的问题。

如果我们希望以持续集成的方式使用 rector,因为我们希望所有代码在开发时都尽可能优化,我们可能只使用一组特定的规则。

rector 有一组规则,通常被描述为死代码或代码质量,分别删除代码或增强和优化。坚持使用这些设置是非常有利的,因为我们可以确信它们在大多数情况下都有效。但您绝对应该意识到 rector 编写代码的方式从来都不是完美的。通常,在编写规则时,它们可能会涵盖典型场景,并且可能会遗漏一些在您的代码库中找到的情况。这可能会导致代码损坏。

谱乐AI
谱乐AI

谱乐AI,集成 Suno、Udio 等顶尖AI音乐模型的一站式AI音乐生成平台。

下载

如果您想使用 rector,您绝对应该为您的应用程序编写测试。没有它们,rector 很容易导致引入错误,而这些错误在成为问题之前你不会发现。

使用 rector 时要考虑的另一件事是,您应该使用像 php cs fixer 这样的 linting 工具。 rector 不会查看空格、方法调用之间的空格和换行符及其参数等。在 rector 应用修复后,使用 linting 工具应该将代码格式保持为您期望的标准。

rector php 分步教程

现在我们已经安装了 rector,我们准备好尝试一下,让我们尝试应用一个规则。让我们从更新之前制作的配置文件开始。

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,
    ]);

在此配置中,我们将替换列表的使用,从而使用数组重组。我们期望做出的改变如下:

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

现在我们可以通过执行 rector 的试运行来测试此配置。

rector --dry-run

如果一切顺利,我们现在应该看到一个输出,其中包含每个文件的所有更改的差异,以及进行更改的规则列表。我们的配置仅列出一条规则,因此仅应用一条规则,但如果添加更多规则,我们将在此处看到一个或多个规则的列表。

掌握代码重构:使用 Rector PHP 的完整指南

现在是审查更改并确保规则按预期执行的好时机。一旦我们满意,我们就可以再次运行 rector。如果没有试运行标志,更改将写入文件。

rector

完成后,我们应该运行我们最喜欢的 linting 工具,然后运行我们的测试。就是这样。我们现在已经使用了 rector。

结论:使用 rector 促进 php 开发

rector php 是一个功能强大的工具,可以通过自动代码重构并确保您的代码库保持干净和现代来显着增强您的 php 开发工作流程。通过了解 rector php 是什么、学习如何安装它以及掌握如何有效使用它,您可以利用它的功能来简化代码更新、提高代码质量并降低代码感觉像是“遗留”项目的风险。无论您是将 rector 集成到持续集成管道中还是将其用于大规模代码库升级,rector 都是任何希望保持高标准的卓越代码的 php 开发人员不可或缺的资产。

如果你想进一步了解 rector 我建议去 https://getrector.com/.

我是 peter fox,一位在英国使用 laravel 的软件开发人员。感谢您阅读我的文章,我还有更多内容可以阅读 https://articles.peterfox.me。我现在也是 github 上的赞助者。如果您想鼓励我写更多这样的文章,请考虑捐赠一笔小额一次性捐款。

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2513

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1597

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1491

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

952

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1416

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1234

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1445

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1306

2023.11.13

Java 桌面应用开发(JavaFX 实战)
Java 桌面应用开发(JavaFX 实战)

本专题系统讲解 Java 在桌面应用开发领域的实战应用,重点围绕 JavaFX 框架,涵盖界面布局、控件使用、事件处理、FXML、样式美化(CSS)、多线程与UI响应优化,以及桌面应用的打包与发布。通过完整示例项目,帮助学习者掌握 使用 Java 构建现代化、跨平台桌面应用程序的核心能力。

36

2026.01.14

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Laravel---API接口
Laravel---API接口

共7课时 | 0.6万人学习

PHP自制框架
PHP自制框架

共8课时 | 0.6万人学习

PHP面向对象基础课程(更新中)
PHP面向对象基础课程(更新中)

共12课时 | 0.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号