PHP代码重构：识别坏味道与优化方法

大家好，今天本人给大家带来文章《PHP代码重构：识别坏味道与优化技巧》，文中内容主要涉及到，如果你对文章方面的知识点感兴趣，那就请各位朋友继续看下去吧~希望能真正帮到你们，谢谢！

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

重构PHP代码，特别是那些遗留代码，核心在于识别代码中的“坏味道”，然后针对性地进行优化。这不仅关乎代码的可读性，更影响系统的可维护性和扩展性。

解决方案

重构是一个迭代的过程，并非一次性完成。首先，我们需要建立一套完整的测试体系，确保重构后的代码功能与之前保持一致。这包括单元测试、集成测试，甚至端到端测试。没有测试，重构就是一场豪赌。

接下来，识别代码中的“坏味道”。这可以通过静态代码分析工具，如PHPStan、Psalm等，也可以通过人工代码审查。常见的坏味道包括：

• 过长函数/类： 函数或类承担了过多的职责，导致难以理解和维护。
• 重复代码： 在多个地方出现相同的代码片段，违反了DRY（Don't Repeat Yourself）原则。
• 过大的参数列表： 函数的参数过多，难以理解参数的含义和使用方式。
• 发散式变化： 一个类因为多种原因而修改，违反了单一职责原则。
• 霰弹式修改： 一次修改需要在多个类中进行，代码耦合度过高。
• 依恋情结： 一个类过于依赖另一个类，导致代码耦合度过高。
• 数据泥团： 多个类中出现相同的数据项，应该将这些数据项封装成一个类。
• 基本类型偏执： 使用基本类型来表示复杂的概念，应该使用对象来表示。
• switch语句/if-else嵌套过深： 难以理解和维护，可以使用多态来替代。
• 注释过多： 代码本身应该具有良好的可读性，过多的注释可能意味着代码需要重构。

针对这些坏味道，我们可以采用一些常见的重构手法：

• 提取函数/类： 将过长的函数或类拆分成更小的、更易于理解的单元。
• 提取方法对象： 将复杂的算法封装成一个方法对象，提高代码的可读性和可维护性。
• 函数组合成类： 将多个相关的函数封装成一个类，提高代码的内聚性。
• 引入参数对象： 将多个相关的参数封装成一个参数对象，减少参数列表的长度。
• 分解条件表达式： 将复杂的条件表达式拆分成更小的、更易于理解的单元。
• 以多态取代条件表达式： 使用多态来替代switch语句/if-else嵌套，提高代码的可扩展性。
• 移除设值函数： 如果一个字段不应该被修改，则应该移除设值函数。
• 以工厂模式取代构造函数： 使用工厂模式来创建对象，可以隐藏对象的创建逻辑。

举个例子，假设我们有一个函数，用于计算订单的总金额，其中包含了大量的条件判断：

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进行静态代码分析？

PHPStan和Psalm都是强大的PHP静态代码分析工具，可以帮助我们发现代码中的潜在问题。它们通过分析代码的语法和语义，可以检测出类型错误、未使用的变量、潜在的bug等。

使用方法通常如下：

1. 安装： 通过Composer安装PHPStan或Psalm。

   composer require --dev phpstan/phpstan
   # 或者
   composer require --dev vimeo/psalm

2. 配置： 创建一个配置文件，例如phpstan.neon或psalm.xml，指定要分析的代码目录和规则。

   # phpstan.neon
   parameters:
       level: 5
       paths:
           - src

3. 运行： 在命令行中运行PHPStan或Psalm，指定要分析的代码目录。

   ./vendor/bin/phpstan analyse src
   # 或者
   ./vendor/bin/psalm

4. 分析结果： 分析结果会显示在命令行中，包括错误类型、错误位置等。根据分析结果，我们可以逐步修复代码中的问题。

PHPStan和Psalm都支持自定义规则，可以根据项目的需要进行配置。例如，可以指定代码的编码风格、命名规范等。

如何编写有效的单元测试来支持PHP代码重构？

单元测试是重构的基础。没有单元测试，重构就像是在黑暗中摸索，无法保证重构后的代码功能与之前保持一致。

编写有效的单元测试需要遵循一些原则：

• 测试先行： 在编写代码之前，先编写单元测试。这可以帮助我们更好地理解需求，并设计出更易于测试的代码。
• 覆盖率： 单元测试应该覆盖代码的所有分支和边界情况。可以使用代码覆盖率工具来衡量测试的覆盖率。
• 独立性： 单元测试应该独立运行，不依赖于外部环境。可以使用Mock对象来模拟外部依赖。
• 可读性： 单元测试应该具有良好的可读性，易于理解和维护。可以使用清晰的命名和注释来提高可读性。
• 快速： 单元测试应该快速运行，以便可以频繁运行。

例如，对于上面的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函数的不同分支，确保重构后的代码功能与之前保持一致。

如何处理PHP遗留代码中的数据库访问问题？

遗留代码中常见的数据库访问问题包括：

• *直接使用`mysql_函数：** 这些函数已经过时，不安全，应该使用mysqli_*`或PDO来替代。
• SQL注入漏洞： 没有对用户输入进行充分的验证和过滤，导致SQL注入漏洞。
• 硬编码SQL语句： SQL语句硬编码在代码中，难以维护和修改。
• 数据库连接管理不当： 没有正确地打开和关闭数据库连接，导致资源泄漏。

针对这些问题，我们可以采取以下措施：

• 升级数据库访问方式： 将mysql_*函数替换为mysqli_*或PDO。PDO提供了更好的安全性和可扩展性。
• 使用参数化查询： 使用参数化查询可以防止SQL注入漏洞。参数化查询可以将用户输入作为参数传递给SQL语句，而不是直接拼接到SQL语句中。
• 使用ORM框架： ORM框架可以将数据库表映射到对象，简化数据库访问。常见的PHP ORM框架包括Doctrine和Eloquent。
• 使用连接池： 使用连接池可以提高数据库连接的效率。连接池可以预先创建一些数据库连接，并在需要时从连接池中获取连接，而不是每次都重新创建连接。

例如，使用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代码重构,坏味道的内容请关注golang学习网公众号！