分析 WordPress `wpdb` 类的 `get_results()` 方法的源码：如何处理查询结果并将其转换为对象数组。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷，晚上好！今天咱们来聊聊 WordPress 数据库操作的核心——wpdb 类的 get_results() 方法。这个方法可以说是 WordPress 中查询数据库的常用利器，它不仅能执行 SQL 查询，还能将查询结果巧妙地转换成我们需要的对象数组。别担心，今天咱们不用啃那些晦涩难懂的官方文档，我会用最通俗易懂的方式，带你一步一步揭开 get_results() 方法的神秘面纱。

1. get_results() 方法概览

首先，咱们来简单了解一下 get_results() 方法的基本用法。它的语法如下：

$wpdb->get_results( string $query = null, string $output = OBJECT, int $y = 0 )

$query: 要执行的 SQL 查询语句。这是灵魂！
$output: 指定结果的输出格式。默认是 OBJECT，也就是对象数组。
- OBJECT (默认): 返回一个对象数组，每个对象对应一行数据。
- OBJECT_K: 返回一个对象数组，但是以第一列的值作为键名。
- ARRAY_A: 返回一个关联数组数组，每个关联数组对应一行数据。
- ARRAY_N: 返回一个索引数组数组，每个索引数组对应一行数据。
$y: 通常用于分页查询，指定返回结果的起始行（不常用，一般用 LIMIT）。

2. 深入源码：get_results() 方法的运作机制

好了，现在咱们进入正题，看看 get_results() 方法的源码，了解它是如何将数据库查询结果转化为对象数组的。为了方便大家理解，我将源码进行了简化，去掉了错误处理、缓存等无关紧要的部分，只保留了核心逻辑。

<?php
class wpdb {

    public $last_query;
    public $last_error;
    public $result;

    private $dbh; // Database handle (PDO instance)

    public function __construct($db_user, $db_password, $db_name, $db_host) {
        // In a real implementation, this would establish a connection to the database
        // Here, we'll just simulate a connection for demonstration purposes.
        try {
            $this->dbh = new PDO("mysql:host=$db_host;dbname=$db_name", $db_user, $db_password);
            $this->dbh->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
        } catch (PDOException $e) {
            die("Database connection failed: " . $e->getMessage());
        }
    }

    public function query( $query ) {
        $this->last_query = $query;

        try {
            $stmt = $this->dbh->prepare( $query );
            $stmt->execute();
            $this->result = $stmt; // Store the PDOStatement
            return $stmt->rowCount(); // Return the number of affected rows.  Crucial for INSERT/UPDATE/DELETE
        } catch (PDOException $e) {
            $this->last_error = $e->getMessage();
            return false;
        }
    }

    public function get_results( $query = null, $output = OBJECT, $y = 0 ) {
        if ( $query ) {
            $this->query( $query ); // First, execute the query
        }

        $return_value = null;

        if ( $this->result ) { // Check if a result set exists
            switch ( $output ) {
                case OBJECT:
                    $return_value = $this->result->fetchAll(PDO::FETCH_OBJ);
                    break;
                case OBJECT_K:
                    $return_value = array();
                    $results = $this->result->fetchAll(PDO::FETCH_OBJ);
                    foreach ( $results as $row ) {
                        $key = reset( (array) $row ); // Get the first property's value as key
                        $return_value[ $key ] = $row;
                    }
                    break;
                case ARRAY_A:
                    $return_value = $this->result->fetchAll(PDO::FETCH_ASSOC);
                    break;
                case ARRAY_N:
                    $return_value = $this->result->fetchAll(PDO::FETCH_NUM);
                    break;
                default:
                    $return_value = $this->result->fetchAll(PDO::FETCH_OBJ);
                    break;
            }
        }
        return $return_value;
    }
}

// Example Usage (assuming database credentials are correct)
$db_user = 'your_db_user';
$db_password = 'your_db_password';
$db_name = 'your_db_name';
$db_host = 'localhost';

$wpdb = new wpdb($db_user, $db_password, $db_name, $db_host);

// Example query
$query = "SELECT id, name, email FROM users";

$results = $wpdb->get_results( $query, OBJECT );

if ( $results ) {
    foreach ( $results as $row ) {
        echo "ID: " . $row->id . ", Name: " . $row->name . ", Email: " . $row->email . "<br>";
    }
} else {
    echo "No results found or query error: " . $wpdb->last_error . "<br>";
}

$results_array = $wpdb->get_results( $query, ARRAY_A );

if ( $results_array ) {
    foreach ( $results_array as $row ) {
        echo "ID: " . $row['id'] . ", Name: " . $row['name'] . ", Email: " . $row['email'] . "<br>";
    }
} else {
    echo "No results found or query error: " . $wpdb->last_error . "<br>";
}

$results_keyed = $wpdb->get_results( $query, OBJECT_K );

if ( $results_keyed ) {
    foreach ( $results_keyed as $key => $row ) {
        echo "Key: " . $key . ", Name: " . $row->name . ", Email: " . $row->email . "<br>";
    }
} else {
    echo "No results found or query error: " . $wpdb->last_error . "<br>";
}

?>

接下来，咱们一步一步地分析这段代码：

执行查询 ($this->query( $query )): get_results() 方法首先会调用 $this->query() 方法来执行 SQL 查询。 $this->query() 方法负责与数据库建立连接（在这个例子中，我简化了连接过程），发送 SQL 查询语句，并获取查询结果。 $this->query() 方法会将查询结果存储在 $this->result 属性中。请注意，$this->query() 的返回值是受影响的行数，这对于 SELECT 语句来说用处不大，但对于 INSERT, UPDATE, DELETE 语句来说非常重要。
判断输出格式 (switch ( $output )): 接下来，get_results() 方法会根据 $output 参数的值，选择不同的方式来处理查询结果。
- OBJECT (默认): 这是我们今天的主角。当 $output 为 OBJECT 时，get_results() 方法会调用 $this->result->fetchAll(PDO::FETCH_OBJ)。 PDO::FETCH_OBJ 的作用是将每一行数据转换成一个对象，并将所有对象组成一个数组。这个数组就是最终返回的对象数组。
- OBJECT_K: 这种模式下，get_results() 先使用 PDO::FETCH_OBJ 获取对象数组，然后遍历这个数组，将每个对象的第一个属性的值作为键名，重新构建一个关联数组。也就是说，结果数组的键名不再是数字索引，而是数据库表中的某一列的值。这在某些场景下非常有用，例如，当你需要根据用户的 ID 快速查找用户信息时，可以将用户 ID 作为键名。
- ARRAY_A: 当 $output 为 ARRAY_A 时，get_results() 方法会调用 $this->result->fetchAll(PDO::FETCH_ASSOC)。 PDO::FETCH_ASSOC 的作用是将每一行数据转换成一个关联数组，并将所有关联数组组成一个数组。关联数组的键名是数据库表中的列名。
- ARRAY_N: 当 $output 为 ARRAY_N 时，get_results() 方法会调用 $this->result->fetchAll(PDO::FETCH_NUM)。 PDO::FETCH_NUM 的作用是将每一行数据转换成一个索引数组，并将所有索引数组组成一个数组。索引数组的键名是数字索引，从 0 开始。
返回结果 (return $return_value): 最后，get_results() 方法会将处理后的结果数组返回。

3. OBJECT 输出格式的优势

为什么 OBJECT 格式如此受欢迎呢？因为它具有以下优势：

易于访问: 可以使用对象属性的方式来访问数据，代码更加简洁易懂。例如，$row->name 比 $row['name'] 更易读。
类型安全: 对象属性的类型是确定的，可以避免一些潜在的类型转换错误。
面向对象: 更符合面向对象的编程思想，可以方便地将数据封装成对象，并添加自定义方法。

4. OBJECT_K 输出格式的应用场景

OBJECT_K 格式虽然不如 OBJECT 格式常用，但在某些场景下却能发挥奇效。例如：

根据 ID 快速查找数据: 可以将 ID 列作为键名，快速查找对应的数据行。
构建关联数组: 可以将数据库表中的某一列的值作为关联数组的键名，方便地构建关联数组。

5. 实际案例：获取用户列表

假设我们有一个名为 users 的数据库表，包含以下字段：

字段名	数据类型
id	INT
name	VARCHAR
email	VARCHAR

现在，我们要获取所有用户的 ID、姓名和邮箱，并将结果以对象数组的形式返回。可以使用以下代码：

<?php
// 假设 $wpdb 对象已经创建并连接到数据库

$query = "SELECT id, name, email FROM users";
$users = $wpdb->get_results( $query );

if ( $users ) {
    foreach ( $users as $user ) {
        echo "ID: " . $user->id . ", Name: " . $user->name . ", Email: " . $user->email . "<br>";
    }
} else {
    echo "No users found.";
}
?>

这段代码会执行 SQL 查询，并将查询结果转换成一个对象数组。然后，遍历这个数组，依次输出每个用户的 ID、姓名和邮箱。

6. 注意事项

在使用 get_results() 方法时，需要注意以下几点：

SQL 注入: 一定要对 SQL 查询语句进行转义，防止 SQL 注入攻击。可以使用 $wpdb->prepare() 方法来安全地构建 SQL 查询语句。
性能问题: 如果查询结果集非常大，可能会导致内存占用过高，影响性能。可以使用分页查询来限制每次返回的结果数量。
错误处理: 应该对查询结果进行判断，如果查询失败，应该进行错误处理。可以使用 $wpdb->last_error 属性来获取最后一次查询的错误信息。

7. 总结

wpdb 类的 get_results() 方法是 WordPress 中查询数据库的常用方法，它可以将查询结果灵活地转换成对象数组、关联数组或索引数组。理解 get_results() 方法的运作机制，可以帮助我们更好地利用它来操作数据库，提高开发效率。

希望今天的讲解对大家有所帮助！如果有什么疑问，欢迎随时提问。下课！

发表回复 取消回复

发表回复取消回复