使用declare(strict_types=1)来获得更健壮的PHP代码

介绍

如果您是PHP开发人员，您可能在某些PHP文件的开头看到过 declare(strict_types=1) 语句。

我第一次看到这个声明时，我不知道它是做什么的。我以为这是某种注释，或者是我之前的旧PHP语法，但我错了（大错特错！）。

在这篇文章中，我们将介绍什么是 declare(strict_types=1) ，以及它如何帮助您提高PHP代码的类型安全性。

declare(strict_types=1) 是什么？

declare(strict_types=1) 是一个启用PHP严格模式并在PHP应用程序中强制严格类型的语句。

它是在PHP 7.0中添加的，当时类型声明系统首次在PHP中实现。这意味着它可以在PHP 8项目中使用，因此您可以开始在代码中充分利用严格类型。

当你使用这个语句时，PHP会对函数的参数和返回类型进行严格的类型检查。这意味着如果一个函数需要某种类型的参数或返回值，如果使用了错误的类型，PHP将抛出错误。这也适用于具有指定类型提示和返回类型的PHP闭包和箭头函数。

让我们举一个不使用 declare(strict_types=1) 的简单例子：

functionadd(int $a, int $b): int
{
return $a + $b;
}


现在假设我们用字符串参数调用这个函数：

echo add('1', '2');
// Output:
// 3

PHP会很高兴地将字符串参数转换为整数并返回结果 3 。

在某些情况下，您可能完全不介意这种行为。但它可能会产生一些您没有预料到的意外后果，并可能导致应用程序中的错误。

然而，让我们假设我们想在这个例子中使用 declare(strict_types=1) 。我们可以通过在文件顶部添加以下语句来实现这一点：

declare(strict_types=1);
function add(int $a, int $b): int
{
return$a + $b;
}

现在，如果我们用字符串参数调用 add 函数，PHP将抛出一个错误：

echo add('1', '2');
// Output:
// Fatal error: Uncaught TypeError: Argument 1 passed to add() must be of the type int, string given

正如我们在这里看到的，PHP抛出了一个错误，因为 add 函数期望传递整数，但却接收到了字符串。

类似地，如果启用了严格的类型检查，并且我们试图从方法返回错误的数据类型，PHP也会抛出错误。例如，假设我们的 add 函数现在接受浮点数而不是整数，并且我们没有启用严格的类型检查：

function add(float$a, float$b): int
{
return$a + $b;
}


我们可以这样调用函数：

echo add(1.25, 2.25);
// Output:
// 3

你发现输出中的问题了吗？

我们应该得到的答案是 3.5 。然而，因为我们已经将返回类型定义为 int ，所以我们已经将浮点数（应该返回的）转换为整数，并失去了精度。可以想象，这可能会在我们应用程序的其他部分导致一些问题，我们正在使用这个结果，并且可能需要精度。

现在让我们通过使用 declare(strict_types=1) 来解决这个问题：

declare(strict_types=1);
function add(float$a, float$b): int
{
return$a + $b;
}

我们可以这样调用函数：

echo add(1.25, 2.25);
// Output:
// Fatal error: Uncaught TypeError: add(): Return value must be of type int, float returned

正如我们所看到的，通过启用严格的类型检查，我们可以发现函数没有返回与返回类型声明匹配的正确数据类型。这很好，因为它可以突出显示我们代码中可能存在的错误，而我们并不知道。然后，我们可以采取必要的步骤：

我应该使用 declare(strict_types=1) 吗？

我个人认为，在所有的PHP文件中使用 declare(strict_types=1) 是一个好主意。我曾经认为仅仅有类型提示和返回类型就足以确保传递正确的数据类型，但我现在改变了主意。当我使用 declare(strict_types=1) 时，我对我的代码更有信心，并且由于使用它而发现了一些bug（特别是当将它添加到旧代码库时）。

由于PHP是一种动态类型的语言（而不是严格类型的语言），这意味着如果你不想的话，你根本不需要指定任何返回类型或类型提示。相反，PHP将在运行时为您确定类型。然而，即使有可能这样做，我还是强烈建议不要这样做。如果你不能在代码中使用严格类型（无论出于什么原因），我仍然建议使用类型提示和返回类型作为最低限度来提高PHP代码质量。

自从了解它以来，我习惯在我创建的每个新PHP文件中使用它。事实上，我更新了PhpStorm设置中的所有模板，以便它自动包含在我创建的每个文件的顶部。例如，下面是创建一个新的PHP类时使用的模板：

<?php
declare(strict_types=1);
#parse("PHP File Header.php")
#if (${NAMESPACE})
namespace ${NAMESPACE};
#end
class ${NAME} {
}


这真的很方便，因为它鼓励我继续使用 declare(strict_types=1) ，而不需要在创建文件后进行任何手动更改（我肯定会忘记这样做！）。

对于我的任何Laravel阅读器，您还可以在运行Artisan命令（如 php artisan make:controller ）时发布用于创建PHP文件的存根。通过发布存根，您可以编辑它们并将 declare(strict_types=1) 添加到顶部。这意味着您使用Artisan命令创建的文件将在已启用更严格类型安全的情况下创建。

当然，如果您打算对现有文件添加更严格的类型检查，我强烈建议您首先要有一个高质量的测试套件。您的PHP代码可能允许传递不正确的数据类型而不引发任何错误。但是，通过启用严格的类型检查，您的代码将变得不那么宽容，并可能开始抛出错误。这可能会导致应用程序以用户意想不到的方式中断。

您可能还会发现需要重构一些代码，使其与 declare(strict_types=1) 兼容。但我不认为这是件坏事。相反，我认为这是一个提高代码质量的机会。

为了帮助您将 declare(strict_types=1) 添加到代码中，您可能需要使用PHPStan之类的工具，它可以为您收集这些类型不匹配。