别再用 PHP 动态方法调用了！三个坑让你代码难以维护

你可能在项目代码里见过这样的写法：$this->{'methodName'}() 或者 $this->{$variable}()。这就是动态方法调用，在运行时才确定要调用哪个方法。

看起来很灵活对吧？但用多了你就会发现，这玩意儿会给代码维护带来不少麻烦。IDE 找不到引用、全局搜索搜不到、代码可读性还差。

本文就来聊聊动态方法调用的三大坑，以及更好的替代方案。
原文链接- 别再用 PHP 动态方法调用了！三个坑让你代码难以维护

什么是动态方法调用？

正常情况下，我们调用方法都是这样写的：$this->methodName()。方法名是写死的，一眼就能看出来。

但动态方法调用不一样，它允许你用变量或表达式来决定调用哪个方法：

$methodName = 'doSomething';
$this->{$methodName}();  // 等同于 $this->doSomething()

这种写法确实灵活，特别是在写框架或库的时候，运行时才知道要调用什么方法。但在普通业务代码里，这种灵活性往往会带来更多问题。

举个实际的例子。假设你在做一个 webhook 处理类，根据不同的事件类型调用不同的处理方法。比如收到 success 事件就调用 handleSuccessWebhook，收到 failure 事件就调用 handleFailureWebhook。

webhook 的数据结构大概是这样：

$payload = [
    'event' => 'success',
    'details' => [
        // ...
    ],
];

用动态方法调用的话，代码可能是这样：

final readonly class WebhookHandler
{
    public function handleWebhook(array $payload): void
    {
        $this->{'handle' . ucfirst($payload['event']) . 'Webhook'}($payload);
    }

    private function handleSuccessWebhook(array $payload): void
    {
        // 处理成功事件
    }

    private function handleFailureWebhook(array $payload): void
    {
        // 处理失败事件
    }

    // 其他处理方法...
}

看到 handleWebhook 方法里那一长串了吗？它从 $payload['event'] 取值，首字母大写，拼上 handle 前缀和 Webhook 后缀，最后动态调用这个方法。

看起来挺聪明的，一行代码搞定所有事件类型。但问题也就藏在这里。

动态方法调用的危险性

现在让我们探讨使用这种方法的一些危险性。

IDE 难以识别

我在动态方法调用中遇到的最大问题之一是集成开发环境(IDE),如 PhpStorm,很难理解它们的使用。由于方法名是在运行时构造的,IDE 很难检测 handleSuccessWebhook 和 handleFailureWebhook 方法是否真的被使用。这可能导致 IDE 将它们标记为未使用,这可能会产生误导。

过去,我曾被诱惑删除 IDE 标记为未使用的方法,后来才发现它们确实通过动态方法调用被使用了。这可能导致应用程序中的错误和意外行为。幸运的是,我在部署到生产环境之前及时发现了它们。但那是一次险情。

PhpStorm 无法理解动态方法调用的另一个缺点是你无法充分利用 IDE 的重构工具。例如,如果你想在 PhpStorm 中重命名一个方法,它将无法找到所有引用(因为它们是动态的),也不会为你重命名它们。如果你不小心,这可能导致代码损坏。

更难查找

我发现动态方法调用的另一个问题是你无法轻松地在代码库中搜索它们的使用。

假设你想找到 handleSuccessWebhook 方法被调用的任何地方。所以你在 PhpStorm 中按 CMD+SHIFT+F 打开全局搜索窗口并搜索 “handleSuccessWebhook”。你不会找到任何结果(除了方法定义本身),因为方法名从未在代码的其他地方明确提及。

此时,你必须问自己:”这个方法在任何地方被使用了吗?还是可以安全删除它?”如果你有一个全面的测试套件覆盖了该特定方法并确认它正在被使用,那么这个问题就会变得更容易回答。但如果你的测试套件没有覆盖这个特定功能,那么你必须手动检查代码以查看它是否在任何地方被使用。这可能既耗时又容易出错,尤其是在较大的代码库中。

更难阅读

我个人发现动态方法调用会使代码在第一眼看上去更难阅读。你觉得这两个中哪一个在第一眼看上去更清晰?

// 动态方法调用:
$this->{'handle' . ucfirst($payload['event']) . 'Webhook'}($payload);

// 或者,传统方法调用:
$this->handleSuccessWebhook($payload);

我猜测大多数人会发现传统方法调用更清晰。对于动态方法调用,你必须在心里解析字符串连接才能弄清楚正在调用什么方法。如果字符串连接更复杂,或者你不知道 $event 的可能值是什么,这可能特别具有挑战性。

替代方法

出于上述原因,我通常在代码中避免使用动态方法调用。相反,我更喜欢使用更明确的方法。

不过,这纯粹是我的个人偏好,并不是说动态方法调用本质上是不好的。所以如果你正在阅读这篇文章并在自己的代码中使用它们,请不要认为我在侮辱你的代码。如果它适合你的用例,完全被测试覆盖,并让你保持高效,那么我完全支持。

我只是更喜欢使用更明确的方法所带来的额外信心和安全性。而且我也认为它使代码更容易阅读,特别是对于刚接触代码库的开发人员。

如果我要重构上面的 WebhookHandler 类,我可能会使用 match 表达式:

final readonly class WebhookHandler
{
    public function handleWebhook(array $payload): void
    {
        match ($payload['event']) {
            'success' => $this->handleSuccessWebhook($payload),
            'failure' => $this->handleFailureWebhook($payload),
            default => throw new Exception('没有该事件的处理器: ' . $event)
        };
    }

    private function handleSuccessWebhook(array $payload): void
    {
        // 在这里处理 "success" webhook...
    }

    private function handleFailureWebhook(array $payload): void
    {
        // 在这里处理 "failure" webhook...
    }

    // 其他 webhook 处理方法...
}

在上面的方法中,我们使用了 “match 表达式”来读取负载的 event 字段,然后根据其值调用相应的方法。如果事件不被识别,它会抛出一个异常。

通过使用这种方法,我们能够在代码中明确写出方法名。因此,这意味着我们的 IDE 可以理解它们的使用,所以我们可以充分利用其功能(例如重构工具,以及知道将返回哪些类型)。这也意味着我们可以轻松地在代码库中搜索它们的使用。我还认为,它使代码在第一眼看上去更容易阅读。

结论

希望这篇文章让你对在 PHP 中使用动态方法调用的危险性有所思考。虽然它们在某些场景中可能很有用,但它们也伴随着一些你应该注意的风险。

本作品采用《CC 协议》，转载必须注明作者和本文链接