通过示例来深入了解PHP中的泛型

深入泛型

我在 上一篇 中展示了一个非常无聊的泛型示例，我们将在这个中做得更好。

$users = new Collection<User>();

$slugs = new Collection<string>();

集合 它们可能是解释泛型的最简单方法，但它们也是每个人在讨论泛型时都会谈论的示例。人们通常认为「泛型」和「具有类型的集合」是一回事。绝对不是这样。

所以让我们再看两个例子。

这是一个名为「app」的函数——如果你使用像 Laravel 这样的框架，它可能看起来很熟悉：这个函数接受一个类名，并使用依赖容器解析该类的一个实例：

function app(string $className): mixed
{
    return Container::get($className);
}

现在，你不需要知道容器是如何工作的，重要的是这个函数会给你一个你请求的类的实例。

所以，基本上，它是一个通用函数；一个返回类型取决于你给它的类名。如果我们的 IDE 和其他静态分析器也明白，如果我给这个函数提供类名「UserRepository」，我希望返回一个 UserRepository 的实例，而不是别的，那就太酷了：

function app(string $className): mixed
{ /* … */ }

app(UserRepository::class); // ?

好吧，泛型允许我们这样做。

我想现在是提一下我一直保守秘密的好时机，就像: 我在 上一篇 中提到 PHP 中不存在泛型；好吧，这并不完全正确。那里的所有静态分析器——无需运行即可读取代码的工具，像你的 IDE 之类的工具——他们允许将 doc 块注释用于泛型：

/**
 * @template Type
 * @param class-string<Type> $className
 * @return Type
 */
function app(string $className): mixed
{ /* … */ }

诚然：这不是最完美的语法，所有静态分析器都依赖于一个简单的协议，即这是没有官方规范语法； 但是：它有效。PHP 世界中最大的三个静态分析器：PhpStorm、Psalm 和 PhpStan，都在一定程度上理解这种语法。

像 PhpStorm 这样的 IDE 使用它，以便在程序员编写代码时向他们提供反馈，而像 Psalm 和 PhpStan 这样的工具使用它，来批量分析你的代码库并检测潜在的 bug，主要基于类型定义。

所以实际上，我们可以构建这个 app 函数，使我们的工具不再在黑暗中运行。 当然，PHP 本身并不能保证返回类型是正确的，因为 PHP 不会在运行时对该函数进行类型检查； 但是，如果我们可以相信我们的静态分析器是正确的，那么在运行它时，这段代码就很少——甚至没有机会被中断。

这就是静态分析令人难以置信的力量：实际上,我们可以确定，无需运行我们的代码； 其中大部分将按预期工作。 所有这一切都归功于类型——包括泛型。

让我们来看一个更复杂的例子：

Attributes::in(MyController::class)
    ->filter(RouteAttribute::class)
    ->newInstance()
    ->

在这里，我们有一个可以“查询”属性并即时实例化它们的类。 如果你在知道它们的反射 API 相当冗长之前使用过属性，那么我发现这种辅助类非常有用。

当我们使用 filter 方法时，我们给它一个属性的类名； 然后调用 newInstance 方法，我们知道结果将是我们过滤类的一个实例。 再说一遍：如果我们的 IDE 能理解我们在说什么，那就太好了。

你猜对了：泛型允许我们这样做：

/** @template AttributeType */
class Attributes
{
    /**
     * @template InputType
     * @param class-string<InputType> $className
     * @return self<InputType>
     */
    public function filter(string $className): self
    { /* … */ }

    /**
     * @return AttributeType 
     */   
    public function newInstance(): mixed
    { /* … */ }

    // …
}

我希望你开始看到简单类型信息的强大功能。几年前，我需要一个 IDE 插件才能让这些洞察力发挥作用，现在我只需要添加一些类型信息。

不过，这个最新的示例不仅依赖于泛型，还有另一个同样重要的部分在起作用。类型推断：静态分析器「猜测」—— 或可靠地确定 —— 无需用户指定类型的能力。 这就是那里的类字符串注释正在发生的事情。我们的 IDE 能够将我们提供给此函数的输入识别为类名，并将该类型推断为泛型类型。

所以，一切都解决了，对吧：PHP中有泛型，所有主要的静态分析器都知道如何使用它们。嗯…有几个警告。

首先，没有关于泛型应该是什么样子的官方规范，现在每个静态分析器都可以使用自己的语法；目前，他们碰巧已经就其中一个达成了一致；但未来几乎没有保障。

其次：在我看来，文档块是次优的。他们觉得自己在我们的代码库中不那么重要。当然，泛型注释只提供静态洞察，没有运行时功能，但我们已经看到了静态分析的强大功能，即使没有运行时类型检查。我认为将类型信息视为“文档注释”是不公平的，它没有在我们的代码中传达这些类型的重要性。这就是为什么我们在PHP8中得到了属性：属性提供的所有功能，在docblock注释中都是可能的，但感觉还不够好。泛型也是如此。

最后一点：如果没有合适的规范，所有三种主要的静态分析仪在其泛型实现之间都存在差异。PhpStorm是目前最缺乏的一种。理想情况下，会有一个来自PHP内部的官方规范。但是官方现在没有。

这些是我认为值得在更持久、更可持续的解决方案上投入时间的主要原因。那么为什么PHP还没有合适的泛型呢？为什么我们依赖没有明确规范的文档块？

原文地址：https://stitcher.io/blog/generics-in-php-2

译文地址：https://learnku.com/php/t/66484

推荐：《PHP视频教程》