书籍
PHP
第5章. 良好的编码实践
重构代码

PHP:
重构代码

如何操作：

让我们拿一个典型的PHP代码片段，并对其应用一些重构魔法。

在重构之前，我们的代码可能看起来像这样：

function printOrderDetails($order) {
    foreach ($order as $item) {
        echo "Item: " . $item['name'];
        echo " - Price: " . $item['price'];
        echo "<br>";
    }
    
    if (!empty($order)) {
        echo "Total: " . array_sum(array_column($order, 'price'));
    }
}

但我们可以重构这段代码以提高其清晰度和模块化：

function printItem($item) {
    echo "Item: {$item['name']} - Price: {$item['price']}<br>";
}

function calculateTotal($order) {
    return array_sum(array_column($order, 'price'));
}

function printOrderDetails(array $order) {
    array_walk($order, 'printItem');

    if (!empty($order)) {
        echo "Total: " . calculateTotal($order);
    }
}

通过将printOrderDetails函数细分为较小的函数，我们的代码变得更加可读并且更易于调试。

深入探讨

重构起源于20世纪90年代初的Smalltalk编程社区，并通过马丁·福勒的开创性著作《重构：改善既有代码的设计》（1999年）得到了进一步的推广。虽然重构可以应用于任何编程语言，但PHP的动态特性提供了一些独特的挑战和机会。

重构的替代方案可能包括从头开始重写代码，这通常更具风险且耗时更多。在PHP生态系统中，像PHPStan和Rector这样的工具可以分别自动发现并执行一些重构操作。在实施方面，保持重构规模小且通过单元测试进行广泛测试是确保成功重构而不引入缺陷的关键实践。

参见

  • 马丁·福勒的《重构》书籍：https://martinfowler.com/books/refactoring.html
  • PHPStan，一个PHP静态分析工具：https://phpstan.org/
  • Rector，一个用于PHP代码自动重构的工具：https://getrector.org/
  • 使用PHPUnit进行PHP单元测试：https://phpunit.de/
将代码组织成函数