既然不推荐使用 fetchAll() 和 FetchMode，如何将结果提取到自定义对象中？

Posted 2023-02-24

【中文标题】既然不推荐使用 fetchAll() 和 FetchMode，如何将结果提取到自定义对象中？

【英文标题】：How to fetch results into a custom object now that fetchAll() and FetchMode are deprecated?

【发布时间】：2021-02-04 15:31:22

【问题描述】：

在一些现有代码上，我有以下语句（经过相当长的查询构建练习）：

return $statement->fetchAll(
    DBAL\FetchMode::CUSTOM_OBJECT,
    PublishedLead::class
);

这有效（到目前为止），但我现在看到 fetchAll() 和 FetchMode 自 DBAL 2.11 以来已被弃用：

// ResultStatement::fetchAll()
/* 
 * @deprecated Use fetchAllNumeric(), fetchAllAssociative()
 * or fetchFirstColumn() instead.
 */

// FetchMode
/* 
 * @deprecated Use one of the fetch- or iterate-related 
 * methods on the Statement
 */

为了使我的代码尽可能向前兼容，如何编写此代码以获取水合到自定义对象中的结果？我是否必须根据结果编写自定义补水逻辑，或者 DBAL 可以为我做这件事吗？

【参考方案1】：

DBAL 3

API 与 DBAL 3 发生了一些重大变化。值得注意的是，对于这个答案，语句不再用于存储和访问结果，因此不再可能执行语句然后简单地循环它。与已执行的Statement 不同，从$statement->execute() 返回的Result 对象不是Traversable，因此必须将下面建议的代码更改为在循环之前显式调用$result->fetchAllAssociative（或在foreach 语句中），但是否则仍然兼容（此时变量只是具有不同的类型）：

function getDatabaseResult(): Generator  // change return type hint, if applicable
    // rest of your function/method
    $result = $statement->execute(); // or ->execute($values);
    foreach ($result->fetchAllAssociative() as $row) 
        yield PublishedLead::fromArray($row);
    

DBAL 2

据我通过阅读 DBAL 源代码得知，通常不推荐使用 fetch 模式，而应使用提供的辅助方法，这将结果限制为数字或关联数组。

这意味着将结果编组到您自己的类中的过程现在可能应该在 DBAL 之外处理。这可能是一个促进使用 Doctrine ORM 的战术决定，或者他们可能只想关注名称中的内容（抽象数据库访问），而忽略与该任务无关的内容。无论哪种方式，编写自定义补水逻辑实际上并不那么复杂，您基本上可以只编写一个提供静态方法fromArray($data) 的 Trait，它遍历数组并设置所有对象属性，然后返回对象（请参阅the answer to the corresponding question） .在要从关联数组构建的所有类中使用此 trait。

我假设你在某个时候循环遍历你的对象数组，所以你实际上可以把你的函数变成一个生成器。如果您最终使用foreach 来遍历您的结果集，这甚至不需要对使用结果的代码进行任何更改。这意味着用以下循环替换您的 return 语句：

foreach ($statement as $row) 
    yield PublishedLead::fromArray($row);

如果您不熟悉生成器，这会将您的函数转换为返回 \Generator 的函数，它可以像 foreach 中的数组一样使用，但实际上并不占用整个内存空间来保存所有数据。相反，只要需要下一个值，就会继续执行原始函数，直到到达下一个 yield 语句，此时返回的 yield 值会被立即使用。

另外，如果您想知道，该语句实际上实现了Traversable，因此您可以在从execute 获取它之后直接通过它foreach，而无需实际调用任何获取方法，即我在上面的例子中做了什么； $row 将是一个关联数组，或者更准确地说，是从 \PDO::FETCH_BOTH 默认获取模式获得的数组。

这是一个完整的原型：

<?php
// newly created
trait FromArrayTrait 
    public static function fromArray(array $data = []): self 
        foreach (get_object_vars($obj = new self) as $property => $default) 
            $obj->$property = $data[$property] ?? $default;
        
        return $obj;
    


class PublishedLead 
    use FromArrayTrait; // add this line
    // rest of your class


function getDatabaseResult(): Generator  // change return type hint, if applicable
    // rest of your function/method
    // the following 3 lines replace 'return $statement->fetchAll(...);'
    foreach ($statement as $row) 
        yield PublishedLead::fromArray($row);
    


// your actual main code, this is unchanged assuming you already use foreach
foreach (getDatabaseResult() as $lead) 
    $lead->doSomething();

显然要考虑命名空间，并将这些部分放在代码中应有的任何位置。顺便说一句，我稍微更改了fromArray 方法，因此它使用默认值以防数组值为空。如果您确实希望能够用 null 替换默认值，请恢复到上面链接的原始版本。如果您想设置动态属性，即使它们没有在您的类中显式声明，请循环通过 $data 而不是 get_object_vars()：

    public static function fromArrayDynamic(iterable $data = []): self 
        $obj = new self;
        foreach ($data as $property => $value) 
            $obj->$property = $value;
        
        return $obj;
    

当然，如果数组中包含空值，这将用空值覆盖默认值。作为奖励，它与iterable 输入兼容，因此它不仅可以使用数组，还可以与生成器和遍历器一起使用。

【讨论】：

Doctrine API 的更改是一场灾难。它们打破了 PHP API 中长期存在的命名方式，实际收益为零。

这里是文档链接doctrine-project.org/2021/03/29/dbal-2.13.html