重构php遗留代码的核心是识别“坏味道”并逐步优化,必须先建立完整的测试体系以确保功能一致性;2. 使用phpstan或psalm进行静态分析可发现类型错误、未使用变量等潜在问题,需通过composer安装、配置规则文件并运行分析命令;3. 编写有效的单元测试应遵循测试先行、高覆盖率、独立性、可读性和快速执行原则,使用phpunit等框架覆盖各类分支场景;4. 处理遗留代码中的数据库问题需淘汰过时的mysql_*函数,改用pdo或mysqli并采用参数化查询防止sql注入,推荐使用orm框架如doctrine或eloquent提升可维护性,同时利用连接池优化数据库连接管理;5. 针对常见坏味道应实施提取函数/类、引入参数对象、以多态取代条件表达式等重构手法,提升代码内聚性与扩展性,整个重构过程应持续迭代、小步推进,确保系统稳定性不受影响。

重构PHP代码,特别是那些遗留代码,核心在于识别代码中的“坏味道”,然后针对性地进行优化。这不仅关乎代码的可读性,更影响系统的可维护性和扩展性。
重构是一个迭代的过程,并非一次性完成。首先,我们需要建立一套完整的测试体系,确保重构后的代码功能与之前保持一致。这包括单元测试、集成测试,甚至端到端测试。没有测试,重构就是一场豪赌。
接下来,识别代码中的“坏味道”。这可以通过静态代码分析工具,如PHPStan、Psalm等,也可以通过人工代码审查。常见的坏味道包括:
立即学习“PHP免费学习笔记(深入)”;
针对这些坏味道,我们可以采用一些常见的重构手法:
举个例子,假设我们有一个函数,用于计算订单的总金额,其中包含了大量的条件判断:
function calculateOrderTotal($order, $discountCode, $shippingAddress) {
$total = $order['subtotal'];
if ($discountCode == 'SUMMER20') {
$total *= 0.8; // 20% off
} elseif ($discountCode == 'WINTER10') {
$total *= 0.9; // 10% off
}
if ($shippingAddress['country'] == 'US') {
$total += 5; // Shipping fee for US
} elseif ($shippingAddress['country'] == 'CA') {
$total += 10; // Shipping fee for CA
}
// ... more conditions
return $total;
}这个函数违反了单一职责原则,应该将其拆分成更小的函数,并使用策略模式或多态来处理不同的折扣和运费计算。
PHPStan和Psalm都是强大的PHP静态代码分析工具,可以帮助我们发现代码中的潜在问题。它们通过分析代码的语法和语义,可以检测出类型错误、未使用的变量、潜在的bug等。
使用方法通常如下:
安装: 通过Composer安装PHPStan或Psalm。
composer require --dev phpstan/phpstan # 或者 composer require --dev vimeo/psalm
配置: 创建一个配置文件,例如
phpstan.neon
psalm.xml
# phpstan.neon
parameters:
level: 5
paths:
- src运行: 在命令行中运行PHPStan或Psalm,指定要分析的代码目录。
./vendor/bin/phpstan analyse src # 或者 ./vendor/bin/psalm
分析结果: 分析结果会显示在命令行中,包括错误类型、错误位置等。根据分析结果,我们可以逐步修复代码中的问题。
PHPStan和Psalm都支持自定义规则,可以根据项目的需要进行配置。例如,可以指定代码的编码风格、命名规范等。
单元测试是重构的基础。没有单元测试,重构就像是在黑暗中摸索,无法保证重构后的代码功能与之前保持一致。
编写有效的单元测试需要遵循一些原则:
例如,对于上面的
calculateOrderTotal
use PHPUnit\Framework\TestCase;
class OrderTest extends TestCase
{
public function testCalculateOrderTotalWithNoDiscountAndNoShippingFee()
{
$order = ['subtotal' => 100];
$shippingAddress = ['country' => 'Other'];
$discountCode = null;
$total = calculateOrderTotal($order, $discountCode, $shippingAddress);
$this->assertEquals(100, $total);
}
public function testCalculateOrderTotalWithSummerDiscount()
{
$order = ['subtotal' => 100];
$shippingAddress = ['country' => 'Other'];
$discountCode = 'SUMMER20';
$total = calculateOrderTotal($order, $discountCode, $shippingAddress);
$this->assertEquals(80, $total);
}
// ... more test cases
}这些单元测试可以覆盖
calculateOrderTotal
遗留代码中常见的数据库访问问题包括:
函数:** 这些函数已经过时,不安全,应该使用
针对这些问题,我们可以采取以下措施:
mysql_*
mysqli_*
例如,使用PDO进行数据库访问:
try {
$dbh = new PDO('mysql:host=localhost;dbname=test', 'user', 'password');
$dbh->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
$stmt = $dbh->prepare("SELECT * FROM users WHERE id = ?");
$stmt->execute([$_GET['id']]);
$user = $stmt->fetch();
// ...
$dbh = null; // 关闭连接
} catch (PDOException $e) {
print "Error!: " . $e->getMessage() . "<br/>";
die();
}这段代码使用了PDO来连接数据库,并使用了参数化查询来防止SQL注入漏洞。
总而言之,PHP代码重构是一个需要耐心和技巧的过程。通过识别代码中的“坏味道”,并针对性地进行优化,我们可以提高代码的可读性、可维护性和可扩展性。同时,建立一套完整的测试体系,可以确保重构后的代码功能与之前保持一致。
以上就是PHP代码重构实战:坏味道识别 如何优化和重构遗留PHP代码的方法的详细内容,更多请关注php中文网其它相关文章!
PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号