深入理解 WordPress `wpdb` 类的 `query()` 方法源码：它是如何处理 `SELECT`、`UPDATE`、`INSERT` 等不同类型的 SQL。

嘿，大家好！今天咱们来聊聊 WordPress 的 `wpdb` 类里那个神秘又重要的 `query()` 方法。

想象一下，wpdb 就像一个辛勤的邮递员，而 query() 方法就是它送信的核心技能。不管你是想从数据库里“取”包裹（SELECT），还是想往数据库里“放”东西（INSERT、UPDATE、DELETE），都得经过它。那么，这个“邮递员”是怎么根据不同的“包裹”类型，选择不同的投递方式的呢？咱们今天就来扒一扒它的源码，看看它到底是怎么工作的。

1. query() 方法的骨架

首先，咱们先来看看 wpdb 类里 query() 方法的基本结构：

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

    // 初始化一些变量
    $this->num_queries++;
    $this->last_query = $query;

    // ... (一些预处理和调试代码) ...

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

    // ... (一些结果处理和缓存代码) ...

    return $result;
}

这个方法接收一个 SQL 查询字符串 $query 作为参数。大致流程是：

计数和记录: 记录查询次数，并保存本次查询的 SQL 语句。
预处理: 进行一些预处理和调试（我们稍后会深入）。
真正执行: 使用 $this->db->query() 执行 SQL 查询。注意这里的 $this->db 实际上是 WordPress 使用的数据库连接对象，通常是 mysqli 或 PDO 的实例。
结果处理: 根据查询结果进行不同的处理，例如缓存结果。
返回结果: 返回查询结果。

2. 预处理：让 SQL 更“听话”

在真正执行 SQL 之前，query() 方法会进行一些预处理。虽然在核心源码中预处理部分相对简单，但理解其目的至关重要。这些预处理就像给 SQL 穿上合适的“衣服”，确保它能顺利地被数据库执行。

错误处理: query() 会检查数据库连接是否正常。如果连接失败，它会尝试重新连接。这就像邮递员在送信前，先确认邮局是否正常营业。
WP_DEBUG 模式: 如果开启了 WP_DEBUG 模式，query() 会记录查询时间和 SQL 语句，方便开发者调试。这就像邮递员在送信时，记录下每个包裹的投递时间，方便追踪。

3. $this->db->query()：真正与数据库对话

预处理完成后，query() 方法会调用 $this->db->query( $query ) 来执行 SQL 查询。这里的 $this->db 是一个数据库连接对象，它负责与数据库服务器进行通信。具体来说，$this->db->query() 会将 SQL 语句发送到数据库服务器，并接收服务器返回的结果。

不同的数据库连接对象（例如 mysqli 或 PDO）会有不同的 query() 方法实现。但它们的目的都是一样的：执行 SQL 查询并返回结果。

4. 结果处理：区分 “包裹” 类型

SQL 查询有很多种类型，常见的有 SELECT、INSERT、UPDATE 和 DELETE。 query() 方法会根据查询结果的类型，进行不同的处理。这就像邮递员根据包裹上的标签，选择不同的投递方式。

SELECT 查询：取数据

对于 SELECT 查询，query() 方法会将查询结果保存在 $this->last_result 属性中。同时，它还会将结果中的字段名保存在 $this->last_query 属性中。这就像邮递员将取到的包裹登记在册，方便日后查找。

if ( preg_match( '/^s*(select|show|describe|explain)s/i', $query ) ) {
    $this->last_result = $this->db->load_row_list( $result, OBJECT );
    $this->num_rows = $this->db->num_rows( $result );
}

这里，preg_match() 函数用于判断 SQL 语句是否以 SELECT、SHOW、DESCRIBE 或 EXPLAIN 开头。如果是，就认为这是一个 SELECT 查询。然后，$this->db->load_row_list() 方法会将查询结果转换成一个对象数组，并保存在 $this->last_result 属性中。 $this->db->num_rows() 方法会返回查询结果的行数，并保存在 $this->num_rows 属性中。

INSERT、UPDATE、DELETE 查询：改数据

对于 INSERT、UPDATE 和 DELETE 查询，query() 方法会返回受影响的行数。这就像邮递员告诉你，你成功地向数据库里“放”了多少东西，或者从数据库里“拿走”了多少东西。

elseif ( preg_match( '/^s*(insert|delete|update|replace)s/i', $query ) ) {
    $this->rows_affected = $this->db->affected_rows( $this->dbh );
    // Return number of rows affected
    $return_val = $this->rows_affected;
}

这里，preg_match() 函数用于判断 SQL 语句是否以 INSERT、DELETE、UPDATE 或 REPLACE 开头。如果是，就认为这是一个修改数据的查询。然后，$this->db->affected_rows() 方法会返回受影响的行数，并保存在 $this->rows_affected 属性中。

其他查询：管它呢

对于其他类型的查询，query() 方法通常会直接返回查询结果，不做特殊处理。

5. 缓存：提高效率的秘密武器

WordPress 使用对象缓存来提高数据库查询的效率。对象缓存就像一个“快递柜”，它可以将常用的数据保存在内存中，避免每次都去数据库里查询。

query() 方法会根据查询的类型和内容，决定是否使用对象缓存。例如，对于一些常用的 SELECT 查询，query() 方法会将查询结果保存在对象缓存中。当下次需要查询相同的数据时，query() 方法会直接从对象缓存中获取，而不需要再次查询数据库。

if ( $cache && $cache_key && 'SELECT' == strtoupper( substr( trim( $query ), 0, 6 ) ) ) {
    if ( ! is_object( $wp_object_cache ) ) {
        return $return_val;
    }

    $cache_lifetime = (int) apply_filters( 'cache_users_global_lifetime', DAY_IN_SECONDS, $query );
    $wp_object_cache->add( $cache_key, $this->last_result, 'global', $cache_lifetime );
}

这段代码片段展示了 query() 方法如何使用对象缓存。首先，它会检查是否开启了缓存，并且是否生成了缓存键 $cache_key。然后，它会判断 SQL 语句是否以 SELECT 开头。如果以上条件都满足，query() 方法会将查询结果 $this->last_result 保存在对象缓存中，并设置缓存的过期时间。

6. 错误处理：出错时的应对

即使是最优秀的邮递员，也难免会遇到包裹丢失或损坏的情况。同样，query() 方法在执行 SQL 查询时，也可能会遇到各种错误。

query() 方法会使用 $this->show_errors 属性来控制是否显示错误信息。如果 $this->show_errors 属性为真，query() 方法会将错误信息输出到屏幕上。否则，query() 方法会将错误信息记录在 $this->last_error 属性中。

此外，query() 方法还会触发 dbDelta 动作，允许其他插件或主题对数据库进行修复。

7. 源码剖析：更深入的理解

为了更深入地理解 query() 方法的工作原理，咱们可以看一些更具体的源码片段。

prepare() 方法：防止 SQL 注入

wpdb 类提供了一个 prepare() 方法，用于防止 SQL 注入攻击。 prepare() 方法会将 SQL 语句中的变量进行转义，确保它们不会被恶意利用。

public function prepare( $query, ...$args ) {
    $args = func_get_args();
    array_shift( $args ); // Remove the query from the array.
    // If there is nothing to prepare then return the unaltered query.
    if ( null === $args || 0 === count( $args ) ) {
        return $query;
    }

    $prepared = str_replace( array( '%s', '%d', '%f' ), array( "'%s'", '%d', '%f' ), $query );
    $prepared = vsprintf( $prepared, array_map( array( $this, 'esc_like' ), $args ) );
    return $prepared;
}

这个方法接收一个 SQL 语句 $query 和一些变量 $args 作为参数。它会将 SQL 语句中的 %s、%d 和 %f 占位符替换成相应的变量，并使用 esc_like() 方法对变量进行转义。

esc_like() 方法：转义特殊字符

esc_like() 方法用于转义 SQL 语句中用于 LIKE 表达式的特殊字符。

public function esc_like( $text ) {
    global $wpdb;
    return addcslashes( esc_sql( $text ), '%_' );
}

这个方法首先使用 esc_sql() 方法对字符串进行转义，然后使用 addcslashes() 方法对 % 和 _ 字符进行转义。

8. 总结：query() 方法的核心职责

总的来说，wpdb 类的 query() 方法承担了以下核心职责：

执行 SQL 查询: 它是与数据库交互的唯一入口。
处理查询结果: 根据查询类型，进行不同的结果处理。
缓存查询结果: 使用对象缓存提高查询效率。
错误处理: 处理查询过程中可能出现的错误。
安全防护: 使用 prepare() 方法防止 SQL 注入攻击。

功能	描述
SQL 执行	接收 SQL 语句，通过 `$this->db->query()` 发送到数据库服务器执行。
结果类型判断	使用正则表达式判断 SQL 语句的类型 (SELECT, INSERT, UPDATE, DELETE)，以便进行不同的处理。
SELECT 处理	将查询结果转换为对象数组，存储在 `$this->last_result` 中，并将行数存储在 `$this->num_rows` 中。
INSERT/UPDATE/DELETE 处理	获取受影响的行数，存储在 `$this->rows_affected` 中。
缓存	对于 SELECT 查询，根据缓存配置将结果存储在对象缓存中，以便下次快速访问。
错误处理	检查数据库连接状态，记录错误信息，并根据配置显示错误。
安全	通过 `prepare()` 方法对 SQL 语句中的变量进行转义，防止 SQL 注入攻击。
调试	在 `WP_DEBUG` 模式下，记录查询时间和 SQL 语句，方便调试。

9. 案例分析：用 query() 方法实现一个简单的查询

为了更好地理解 query() 方法的用法，咱们来看一个简单的例子。假设我们要从 wp_posts 表中查询所有文章的标题和内容。

global $wpdb;

$query = "SELECT post_title, post_content FROM {$wpdb->posts}";

$results = $wpdb->query( $query );

if ( $results ) {
    foreach ( $wpdb->last_result as $post ) {
        echo '<h2>' . esc_html( $post->post_title ) . '</h2>';
        echo '<p>' . esc_html( $post->post_content ) . '</p>';
    }
} else {
    echo 'No posts found.';
}

在这个例子中，我们首先构建了一个 SQL 查询语句，用于从 wp_posts 表中查询 post_title 和 post_content 字段。然后，我们调用 $wpdb->query() 方法执行查询。如果查询成功，$wpdb->last_result 属性会包含一个对象数组，每个对象代表一行查询结果。我们可以遍历这个数组，并将文章的标题和内容输出到屏幕上。

10. 最佳实践：如何更安全、更高效地使用 query() 方法

使用 prepare() 方法防止 SQL 注入: 这是最重要的一点。永远不要直接将用户输入拼接到 SQL 语句中。
尽量使用 WordPress 提供的 API: WordPress 提供了很多方便的 API，例如 get_posts()、update_post_meta() 等。这些 API 已经帮你处理了很多底层细节，可以让你更安全、更高效地操作数据库。
合理使用缓存: 对于常用的查询，可以考虑使用对象缓存来提高效率。
注意性能问题: 避免执行复杂的 SQL 查询。可以考虑使用索引来优化查询性能。

好了，今天的讲座就到这里。希望大家通过今天的学习，对 WordPress 的 wpdb 类的 query() 方法有了更深入的理解。记住，query() 方法是 WordPress 与数据库交互的核心，掌握它可以让你更好地开发 WordPress 插件和主题。咱们下次再见！

嘿，大家好！今天咱们来聊聊 WordPress 的 wpdb 类里那个神秘又重要的 query() 方法。

发表回复 取消回复

嘿，大家好！今天咱们来聊聊 WordPress 的 `wpdb` 类里那个神秘又重要的 `query()` 方法。

发表回复取消回复