编写可读代码：通过提前返回来减少缩进

在这篇简短的文章中，我想向您提供有关编写可读 PHP 的技巧。

在处理旧代码或通过 PR 提交的代码时，有时会看到以下模式：

public function doSomething($someParameter)
{
    /** 可以是任何类型的测试 */
    if ($someParameter === 0) {
        // 实际工作
    }
}

　　

在函数的开头，有一个正在执行的测试。实际工作在 if 块中。

这可以通过反转条件和使用早期返回来重构。

public function doSomething($someParameter)
{
    if ($someParameter !== 0) {
        return;
    }

    // 实际工作
}

　　

这样做有两个好处：

一个缩进级别丢失。仅此一项就使阅读更加愉快。您无需费心将代码包裹在某种东西中。

提前返回对人类来说也很好。当有人读了你的代码，对早期返回感兴趣，他或她不需要进一步的早期返回。在第一个示例中，仍然可能有一些代码在 if 块之后执行。

当您考虑行长度限制 (您应该这样做) 时，您现在可以在执行实际工作时使用更多的字符。

当存在多个条件时，此技术也适用。考虑以下功能：

public function doSomething($someParameter, $someOtherParameter)
{
    /** 可以是任何类型的测试 */
    if ($someParameter === 0) {
        if ($someOtherParameter === 0) {
            // 实际执行
        }
    }
}

　　

通过使用早期返回，您可以将其重写为更具可读性的内容。

public function doSomething($someParameter, $someOtherParameter)
{
    if ($someParameter !== 0) {
        return;
    }

    if ($someOtherParameter !== 0) {
        return;
    }

    // do the actual work
}

　　

您可能想要重写这个 if 语句。

if ($someParameter !== 0 || $someOtherParameter !== 0) {

　　

在大多数情况下，出于以下三个原因，我不这样做：

1. 就我个人而言，我需要更多的脑力来分析这个问题

2. 当有更多条件时，很容易出错 (我应该使用 || 还是 &&)

3. 使用早期返回更容易调试。可以在那些 if 块中放置断点或 dump 语句。这样，您就知道哪个条件会导致提前返回。

本文总结：每当您看到在 if 块中执行某些代码时，请检查是否可以反转该条件以丢失缩进级别。

 

更多学习内容请访问：

腾讯T3-T4标准精品PHP架构师教程目录大全，只要你看完保证薪资上升一个台阶（持续更新）