阐述 `wpdb` 类的 `query()`, `get_var()`, `get_row()`, `get_results()` 方法的源码，并解释它们之间的区别。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

咳咳，各位WordPress技术爱好者，晚上好！我是今天的主讲人，咱们今天来聊聊WordPress数据库操作的核心——wpdb 类。特别是它里面四个非常重要的“四大金刚”：query(), get_var(), get_row(), 和 get_results()。它们就像四位身怀绝技的武林高手，各自负责不同的数据库任务。

准备好了吗？咱们这就开始深入源码，扒一扒它们的底裤，看看它们到底是怎么工作的，以及它们之间到底有什么区别。

首先，认识一下主角：wpdb 类

wpdb 类是 WordPress 提供的用于与数据库交互的核心类。它封装了底层的数据库操作，让我们开发者可以更方便地执行 SQL 查询，而不需要直接面对那些复杂的数据库驱动程序。简单来说，它就是一个连接WordPress和MySQL数据库的桥梁。

第一位高手：query() – 万能的执行者

query() 方法可以说是 wpdb 类中最基础、也最万能的方法。它负责执行任意的 SQL 查询语句，无论是 SELECT、INSERT、UPDATE、DELETE，还是其他任何你想要执行的 SQL 命令，它都能胜任。

源码剖析：

虽然 wpdb 的源码非常庞大，但是 query() 方法的核心逻辑相对清晰：

public function query( $query ) {
    global $EZSQL_ERROR;

    // 初始化
    $this->flush();

    // 清理查询字符串
    $query = trim( $query );

    // 记录最后一次查询
    $this->last_query = $query;

    // 开始计时
    $this->timer_start();

    // 如果需要，显示查询信息
    if ( $this->show_errors ) {
        $this->debug_echo( $this->last_query );
    }

    // 执行查询
    if ( $this->use_mysqli ) {
        $this->result = mysqli_query( $this->dbh, $query );
    } else {
        $this->result = mysql_query( $query, $this->dbh );
    }

    // 停止计时
    $this->timer_stop();

    // 处理错误
    if ( $this->last_error = $this->get_last_error() ) {
        $EZSQL_ERROR[] = array( 'query' => $query, 'error_str' => $this->last_error );
        $this->print_error();
        return false;
    }

    // 计算受影响的行数
    if ( preg_match( '/^s*(insert|delete|update|replace) /i', $query ) ) {
        $this->rows_affected = $this->get_num_rows();

        // 返回受影响的行数
        return $this->rows_affected;
    }

    // 计算查询结果中的行数
    if ( preg_match( '/^s*(select) /i', $query ) ) {
        $num_rows = 0;
        while ( $row = $this->next_result( MYSQLI_ASSOC ) ) {
            $this->last_result[$num_rows] = $row;
            $num_rows++;
        }

        // 释放结果集
        if ( $this->use_mysqli ) {
            mysqli_free_result( $this->result );
        } else {
            mysql_free_result( $this->result );
        }

        // 返回查询结果中的行数
        $this->num_rows = $num_rows;
        return $this->num_rows;
    }

    // 返回 true 表示成功执行
    return true;
}

代码解读：

初始化和清理： $this->flush() 用于重置 wpdb 类的内部状态，确保每次查询都是在一个干净的环境中执行。 trim($query) 用于去除查询语句前后的空格。
记录查询： $this->last_query 记录了最后一次执行的查询语句，方便调试。
计时： $this->timer_start() 和 $this->timer_stop() 用于记录查询执行的时间，可以用来做性能分析。
执行查询： mysqli_query() 或 mysql_query() 函数真正执行查询。 wpdb 类会根据你使用的数据库驱动（MySQLi 或 MySQL）选择合适的函数。
错误处理： $this->get_last_error() 获取最后一次发生的错误，如果出现错误，会记录错误信息并输出。
处理结果：
- 如果是 INSERT、UPDATE、DELETE 或 REPLACE 语句，那么 $this->get_num_rows() 会获取受影响的行数，并返回这个值。
- 如果是 SELECT 语句，那么它会循环读取查询结果，并将结果存储到 $this->last_result 数组中，然后返回结果的行数。
返回结果： 根据查询类型，返回不同的结果。

使用示例：

global $wpdb;

// 插入数据
$result = $wpdb->query("INSERT INTO wp_options (option_name, option_value, autoload) VALUES ('my_option', 'my_value', 'yes')");

if ($result) {
    echo "插入成功！受影响的行数：" . $wpdb->rows_affected;
} else {
    echo "插入失败！错误信息：" . $wpdb->last_error;
}

// 更新数据
$result = $wpdb->query("UPDATE wp_options SET option_value = 'new_value' WHERE option_name = 'my_option'");

if ($result) {
    echo "更新成功！受影响的行数：" . $wpdb->rows_affected;
} else {
    echo "更新失败！错误信息：" . $wpdb->last_error;
}

// 删除数据
$result = $wpdb->query("DELETE FROM wp_options WHERE option_name = 'my_option'");

if ($result) {
    echo "删除成功！受影响的行数：" . $wpdb->rows_affected;
} else {
    echo "删除失败！错误信息：" . $wpdb->last_error;
}

// 查询数据
$result = $wpdb->query("SELECT * FROM wp_options WHERE option_name = 'my_option'");

if ($result) {
    echo "查询成功！查询结果的行数：" . $wpdb->num_rows;
    if ($wpdb->num_rows > 0) {
        foreach ($wpdb->last_result as $row) {
            echo "<br>Option Name: " . $row->option_name . ", Option Value: " . $row->option_value;
        }
    }
} else {
    echo "查询失败！错误信息：" . $wpdb->last_error;
}

总结：

query() 方法是最通用的数据库操作方法，可以执行任何 SQL 查询语句。
它返回的结果类型取决于查询语句的类型。
它是其他三个方法的基础。

第二位高手：get_var() – 精准的取值器

get_var() 方法专门用于从数据库中获取单个变量的值。当你只需要查询结果中的一个值时，使用 get_var() 会更方便、更高效。想象一下，你只想知道某个用户的ID，用这个就最合适了。

源码剖析：

public function get_var( $query = null, $x = 0, $y = 0 ) {
    $this->func_call = "$db->get_var(string query,int x,int y)";

    if ( $query ) {
        $this->last_query = $query;
    }

    // 执行查询
    $result = $this->query( $query );

    // 如果查询出错，返回 NULL
    if ( $result === false ) {
        return null;
    }

    // 如果没有结果，返回 NULL
    if ( ! $this->last_result ) {
        return null;
    }

    // 从结果集中获取指定位置的值
    return $this->last_result[ $y ]->$x;
}

代码解读：

调用 query()： get_var() 方法首先调用 query() 方法来执行 SQL 查询。
错误处理： 如果 query() 方法返回 false，说明查询出错，get_var() 会返回 null。
结果处理： 如果查询成功，get_var() 会从 $this->last_result 数组中获取指定位置的值。 $x 和 $y 参数分别指定了要获取的列和行的索引。默认情况下，$x 为 0， $y 也为 0，也就是返回结果集中第一行第一列的值。
返回结果： 返回获取到的值。

使用示例：

global $wpdb;

// 获取用户总数
$total_users = $wpdb->get_var("SELECT COUNT(*) FROM wp_users");

echo "用户总数: " . $total_users;

// 获取指定用户的邮箱地址
$user_email = $wpdb->get_var("SELECT user_email FROM wp_users WHERE ID = 1");

echo "<br>用户的邮箱地址: " . $user_email;

总结：

get_var() 方法用于获取单个变量的值。
它内部调用了 query() 方法来执行查询。
它返回查询结果集中指定位置的值。
使用 get_var() 可以避免不必要的内存开销，提高性能。

第三位高手：get_row() – 捕捉单行记录

get_row() 方法用于从数据库中获取单行记录。当你需要获取查询结果中的一行数据时，使用 get_row() 非常方便。比如，你只想获取某个用户的详细信息，就可以用它。

源码剖析：

public function get_row( $query = null, $output = OBJECT, $y = 0 ) {
    $this->func_call = "$db->get_row(string query,string output,int y)";

    if ( $query ) {
        $this->last_query = $query;
    }

    // 执行查询
    $result = $this->query( $query );

    // 如果查询出错，返回 NULL
    if ( $result === false ) {
        return null;
    }

    // 如果没有结果，返回 NULL
    if ( ! $this->last_result ) {
        return null;
    }

    // 根据输出类型返回结果
    if ( $output == OBJECT ) {
        return $this->last_result[ $y ];
    } elseif ( $output == ARRAY_A ) {
        return (array) $this->last_result[ $y ];
    } elseif ( $output == ARRAY_N ) {
        return array_values( (array) $this->last_result[ $y ] );
    } else {
        $this->print_error( " $db->get_row(string query, output type) -- Output type must be OBJECT, ARRAY_A or ARRAY_N" );
    }

    return null;
}

代码解读：

调用 query()： get_row() 方法首先调用 query() 方法来执行 SQL 查询。
错误处理： 如果 query() 方法返回 false，说明查询出错，get_row() 会返回 null。
结果处理： 如果查询成功，get_row() 会根据 $output 参数指定的输出类型返回结果。
- OBJECT：返回一个对象，对象的属性对应于数据库表的列名。
- ARRAY_A：返回一个关联数组，数组的键名对应于数据库表的列名。
- ARRAY_N：返回一个索引数组，数组的值对应于数据库表的列值。
返回结果： 返回获取到的行数据。

使用示例：

global $wpdb;

// 获取 ID 为 1 的用户的信息
$user = $wpdb->get_row("SELECT * FROM wp_users WHERE ID = 1");

if ($user) {
    echo "用户的用户名: " . $user->user_login;
    echo "<br>用户的邮箱地址: " . $user->user_email;
} else {
    echo "没有找到该用户！";
}

// 获取 ID 为 1 的用户的信息，以关联数组形式返回
$user_array = $wpdb->get_row("SELECT * FROM wp_users WHERE ID = 1", ARRAY_A);

if ($user_array) {
    echo "<br>用户的用户名: " . $user_array['user_login'];
    echo "<br>用户的邮箱地址: " . $user_array['user_email'];
} else {
    echo "没有找到该用户！";
}

总结：

get_row() 方法用于获取单行记录。
它内部调用了 query() 方法来执行查询。
它可以根据 $output 参数返回不同类型的结果（对象、关联数组、索引数组）。
使用 get_row() 可以方便地获取单行数据，并以你想要的格式进行处理。

第四位高手：get_results() – 搜罗所有结果

get_results() 方法用于从数据库中获取多行记录。当你需要获取查询结果中的所有数据时，使用 get_results() 是最合适的选择。比如，你想获取所有文章的标题和内容，就可以用它。

源码剖析：

public function get_results( $query = null, $output = OBJECT ) {
    $this->func_call = "$db->get_results(string query, string output)";

    if ( $query ) {
        $this->last_query = $query;
    }

    // 执行查询
    $result = $this->query( $query );

    // 如果查询出错，返回 NULL
    if ( $result === false ) {
        return null;
    }

    // 如果没有结果，返回一个空数组
    if ( ! $this->last_result ) {
        return array();
    }

    // 根据输出类型返回结果
    if ( $output == OBJECT ) {
        return $this->last_result;
    } elseif ( $output == ARRAY_A ) {
        $i = 0;
        foreach ( $this->last_result as $row ) {
            $this->last_result[ $i ] = (array) $row;
            $i++;
        }
        return $this->last_result;
    } elseif ( $output == ARRAY_N ) {
        $i = 0;
        foreach ( $this->last_result as $row ) {
            $this->last_result[ $i ] = array_values( (array) $row );
            $i++;
        }
        return $this->last_result;
    } else {
        $this->print_error( " $db->get_results(string query, output type) -- Output type must be OBJECT, ARRAY_A or ARRAY_N" );
    }

    return null;
}

代码解读：

调用 query()： get_results() 方法首先调用 query() 方法来执行 SQL 查询。
错误处理： 如果 query() 方法返回 false，说明查询出错，get_results() 会返回 null。
结果处理： 如果查询成功，get_results() 会根据 $output 参数指定的输出类型返回结果。
- OBJECT：返回一个对象数组，数组中的每个对象对应于数据库表的一行记录，对象的属性对应于数据库表的列名。
- ARRAY_A：返回一个关联数组的数组，数组中的每个关联数组对应于数据库表的一行记录，关联数组的键名对应于数据库表的列名。
- ARRAY_N：返回一个索引数组的数组，数组中的每个索引数组对应于数据库表的一行记录，索引数组的值对应于数据库表的列值。
返回结果： 返回获取到的所有行数据。

使用示例：

global $wpdb;

// 获取所有文章的标题和内容
$posts = $wpdb->get_results("SELECT post_title, post_content FROM wp_posts WHERE post_type = 'post' AND post_status = 'publish'");

if ($posts) {
    foreach ($posts as $post) {
        echo "文章标题: " . $post->post_title;
        echo "<br>文章内容: " . substr($post->post_content, 0, 100) . "..."; // 只显示部分内容
        echo "<br><br>";
    }
} else {
    echo "没有找到任何文章！";
}

// 获取所有文章的标题和内容，以关联数组形式返回
$posts_array = $wpdb->get_results("SELECT post_title, post_content FROM wp_posts WHERE post_type = 'post' AND post_status = 'publish'", ARRAY_A);

if ($posts_array) {
    foreach ($posts_array as $post) {
        echo "文章标题: " . $post['post_title'];
        echo "<br>文章内容: " . substr($post['post_content'], 0, 100) . "..."; // 只显示部分内容
        echo "<br><br>";
    }
} else {
    echo "没有找到任何文章！";
}

总结：

get_results() 方法用于获取多行记录。
它内部调用了 query() 方法来执行查询。
它可以根据 $output 参数返回不同类型的结果（对象数组、关联数组的数组、索引数组的数组）。
使用 get_results() 可以方便地获取所有数据，并以你想要的格式进行处理。

“四大金刚”的对比：

为了更清晰地理解这四个方法的区别，我们用一个表格来进行对比：

方法	功能	返回值类型	适用场景
`query()`	执行任意 SQL 查询	`true` (成功), `false` (失败), 受影响的行数 (INSERT/UPDATE/DELETE), 行数 (SELECT)	执行任何类型的 SQL 查询，特别是需要执行非 `SELECT` 查询时
`get_var()`	获取单个变量的值	变量值 (字符串、数字等), `null` (失败)	只需要获取单个值时，例如获取总用户数、某个选项的值等
`get_row()`	获取单行记录	对象, 关联数组, 索引数组, `null` (失败)	需要获取单行数据时，例如获取某个用户的详细信息、某个文章的信息等
`get_results()`	获取多行记录	对象数组, 关联数组的数组, 索引数组的数组, 空数组 (没有结果), `null` (失败)	需要获取多行数据时，例如获取所有文章的标题和内容、所有分类的名称等

选择哪个方法？

选择哪个方法取决于你的具体需求。记住以下几点：

如果你需要执行非 SELECT 查询，或者你需要获取受影响的行数，那么使用 query()。
如果你只需要获取单个值，那么使用 get_var()。
如果你需要获取单行数据，那么使用 get_row()。
如果你需要获取多行数据，那么使用 get_results()。

性能优化小贴士：

尽量避免在循环中使用数据库查询。如果你需要获取多行数据，最好一次性获取所有数据，而不是在循环中逐行获取。
使用预处理语句可以提高性能，防止 SQL 注入。 WordPress 提供了 $wpdb->prepare() 方法来创建预处理语句。
只查询你需要的列。避免使用 SELECT *，而是明确指定你需要查询的列。

总结：

今天我们深入剖析了 wpdb 类中的 query(), get_var(), get_row(), 和 get_results() 这四个重要的方法。希望通过今天的讲解，你能够更深入地理解它们的工作原理，并能够根据实际需求选择合适的方法，编写出更高效、更安全的 WordPress 代码。

记住，熟练掌握这“四大金刚”，你在WordPress的开发道路上就能披荆斩棘，所向披靡。

好了，今天的讲座就到这里。感谢大家的参与！如果大家有什么问题，欢迎提问。

发表回复 取消回复

发表回复取消回复