分析 WordPress `_prime_post_caches()` 函数的源码：解释它如何预加载文章元数据和分类术语，以减少数据库查询。

大家好！欢迎来到今天的“WordPress源码解密”小课堂。今天我们要聊的是一个隐藏在幕后、默默提升WordPress性能的关键函数：_prime_post_caches()。

想象一下，你正在经营一家繁忙的咖啡馆。每位顾客点单后，你都要跑到仓库里去取咖啡豆、牛奶、糖……效率简直低到爆炸！_prime_post_caches()就像是你的咖啡馆里的一个高级咖啡师，他提前把常用的材料（文章元数据、分类术语）准备好放在手边，这样顾客点单时就能立刻制作，大大缩短等待时间。

那么，这位“咖啡师”具体是怎么工作的呢？让我们深入源码一探究竟。

1. _prime_post_caches() 的身世背景

_prime_post_caches()函数位于wp-includes/post.php文件中。它的主要作用就是批量预加载（"prime"）文章的缓存，包括文章的元数据（meta data）和分类术语（terms）。为什么要预加载？因为每次WordPress要显示一篇文章的时候，都需要从数据库中查询这些信息。如果每次都去数据库查询，那数据库的压力就太大了，网站速度也会慢下来。所以，WordPress使用了缓存机制，把常用的数据放到缓存里，下次需要的时候直接从缓存里取，速度快多了。

2. 源码剖析：一步一步走进 _prime_post_caches()

我们先来看一下_prime_post_caches()函数的基本结构：

function _prime_post_caches( $post_ids, $update_term_cache = true, $update_meta_cache = true ) {
    if ( empty( $post_ids ) ) {
        return;
    }

    $post_ids = array_map( 'intval', (array) $post_ids );
    $post_ids = array_unique( $post_ids );

    if ( $update_term_cache ) {
        _prime_post_terms_caches( $post_ids );
    }

    if ( $update_meta_cache ) {
        update_post_caches( $post_ids );
    }
}

代码解读：

参数：
- $post_ids：一个包含文章ID的数组，告诉函数要预加载哪些文章的数据。必须是数组，而且数组里的值必须是整数。
- $update_term_cache：一个布尔值，默认为true，表示是否更新文章的分类术语缓存。
- $update_meta_cache：一个布尔值，默认为true，表示是否更新文章的元数据缓存。
空数组检查：如果$post_ids为空，函数直接返回，避免不必要的处理。
数据清洗：
- array_map( 'intval', (array) $post_ids )：确保$post_ids是一个数组，并且数组中的每个元素都是整数。这是为了防止SQL注入等安全问题。
- array_unique( $post_ids )：移除$post_ids数组中重复的ID，避免重复查询。
更新分类术语缓存：如果$update_term_cache为true，则调用_prime_post_terms_caches()函数更新文章的分类术语缓存。
更新元数据缓存：如果$update_meta_cache为true，则调用update_post_caches()函数更新文章的元数据缓存。

3. _prime_post_terms_caches()：分类术语缓存的秘密

_prime_post_terms_caches()函数负责预加载文章的分类术语缓存。让我们继续深入源码：

function _prime_post_terms_caches( $post_ids, $taxonomies = null ) {
    $post_ids = array_map( 'intval', (array) $post_ids );
    $post_ids = array_unique( $post_ids );

    $terms = get_the_terms( $post_ids, $taxonomies );

    if ( false === $terms || is_wp_error( $terms ) ) {
        return;
    }
}

代码解读：

参数：
- $post_ids：一个包含文章ID的数组。
- $taxonomies：一个可选参数，指定要预加载的分类法（taxonomy），例如category、post_tag。如果为null，则加载所有分类法。
数据清洗：同样对$post_ids进行数据清洗，确保其安全性和唯一性。
获取分类术语：调用get_the_terms()函数获取指定文章ID和分类法的所有分类术语。
错误处理：检查get_the_terms()函数的返回值，如果出现错误（例如没有找到分类术语），则直接返回。

get_the_terms() 函数的内部运作

get_the_terms()这个函数是获取文章相关联的terms的关键。它内部会先检查缓存，如果缓存中没有，才会去数据库查询。查询结果会存储在缓存中，以便下次使用。

function get_the_terms( $id = 0, $taxonomy = '' ) {
    global $wpdb;

    $id = (int) $id;

    $taxonomy = sanitize_key( $taxonomy );

    $cache = wp_cache_get( $id, $taxonomy . '_relationships' );
    if ( false !== $cache ) {
        return apply_filters( 'get_the_terms', $cache, $id, $taxonomy );
    }

    $terms = get_object_term_cache( $id, $taxonomy );

    if ( false === $terms ) {
        $terms = wp_get_object_terms( $id, $taxonomy );

        if ( ! is_wp_error( $terms ) ) {
            wp_cache_add( $id, $terms, $taxonomy . '_relationships' );
        }
    }

    return apply_filters( 'get_the_terms', $terms, $id, $taxonomy );
}

这段代码的核心逻辑：

缓存检查: 首先尝试从缓存中获取terms，使用的是wp_cache_get函数。缓存的key是 $taxonomy . '_relationships'，这说明WordPress会为每种taxonomy单独缓存文章与其terms之间的关系。
get_object_term_cache 检查: 如果缓存没有命中，则尝试使用 get_object_term_cache 获取terms。这个函数会从全局 $wp_object_cache 对象中查找缓存，提供更细粒度的缓存控制。
数据库查询: 如果缓存仍然没有命中，就调用 wp_get_object_terms 从数据库中查询terms。
缓存存储: 查询结果通过 wp_cache_add 函数添加到缓存中，以便下次快速访问。

4. update_post_caches()：元数据缓存的大本营

update_post_caches()函数负责预加载文章的元数据缓存。我们再来看看源码：

function update_post_caches( &$posts, $update_term_cache = true ) {
    if ( empty( $posts ) ) {
        return;
    }

    $post_ids = array();
    foreach ( (array) $posts as $post ) {
        if ( is_object( $post ) ) {
            $post_ids[] = $post->ID;
        } else {
            $post_ids[] = $post;
        }
    }

    $post_ids = array_map( 'intval', $post_ids );
    $post_ids = array_unique( $post_ids );

    if ( $update_term_cache ) {
        _prime_post_terms_caches( $post_ids );
    }

    update_post_meta_cache( $post_ids );
}

代码解读：

参数：
- $posts：一个包含文章对象或文章ID的数组。
- $update_term_cache：一个布尔值，默认为true，表示是否更新文章的分类术语缓存。这里再次调用了_prime_post_terms_caches()，确保分类术语缓存是最新的。
空数组检查：如果$posts为空，函数直接返回。
提取文章ID：遍历$posts数组，提取文章ID。如果数组中的元素是文章对象，则提取$post->ID；如果是文章ID，则直接使用。
数据清洗：对$post_ids进行数据清洗，确保其安全性和唯一性。
更新分类术语缓存：如果$update_term_cache为true，则调用_prime_post_terms_caches()函数更新文章的分类术语缓存。
更新元数据缓存：调用update_post_meta_cache()函数更新文章的元数据缓存。

update_post_meta_cache() 函数的深入分析

update_post_meta_cache() 是负责批量加载文章元数据的核心函数。让我们深入了解它的实现：

function update_post_meta_cache( $post_ids ) {
    global $wpdb, $wp_object_cache;

    $post_ids = array_map( 'intval', (array) $post_ids );
    $post_ids = array_unique( $post_ids );

    $non_cached_ids = array();
    foreach ( $post_ids as $post_id ) {
        if ( wp_cache_get( $post_id, 'post_meta' ) ) {
            continue;
        }

        $non_cached_ids[] = $post_id;
    }

    if ( empty( $non_cached_ids ) ) {
        return;
    }

    $id_list = implode( ',', $non_cached_ids );
    $sql = "SELECT post_id, meta_key, meta_value FROM {$wpdb->postmeta} WHERE post_id IN ($id_list) ORDER BY meta_key";

    $meta_list = $wpdb->get_results( $sql );

    if ( empty( $meta_list ) ) {
        return;
    }

    $cache = array();
    foreach ( $meta_list as $meta ) {
        $cache[ $meta->post_id ][$meta->meta_key][] = maybe_unserialize( $meta->meta_value );
    }

    foreach ( $non_cached_ids as $post_id ) {
        if ( ! isset( $cache[ $post_id ] ) ) {
            $cache[ $post_id ] = array();
        }

        wp_cache_add( $post_id, $cache[ $post_id ], 'post_meta' );
    }
}

这段代码的步骤如下：

数据清洗: 对传入的 $post_ids 进行整数转换和去重，确保数据的安全和唯一性。
检查缓存: 遍历 $post_ids，使用 wp_cache_get 检查每个 post_id 的元数据是否已经存在于缓存中。如果存在，则跳过该 post_id。
构建SQL查询: 对于没有缓存的 post_id，构建一个 SQL 查询，从 wp_postmeta 表中批量获取这些 post_id 的所有元数据。
执行查询: 使用 $wpdb->get_results 执行 SQL 查询，获取元数据结果集。
组织缓存数据: 遍历查询结果 $meta_list，将每个元数据项按照 post_id 和 meta_key 组织成一个多维数组 $cache。 maybe_unserialize 用于反序列化存储在数据库中的元数据值。
添加到缓存: 遍历 $non_cached_ids，将每个 post_id 的元数据添加到缓存中，使用的缓存 key 是 post_meta。如果某个 post_id 没有关联的元数据，也会添加一个空数组到缓存中，防止后续重复查询。

5. _prime_post_caches() 的实际应用场景

那么，_prime_post_caches()函数在哪些场景下会被调用呢？

主循环（The Loop）：在WordPress主题中使用主循环显示文章列表时，_prime_post_caches()会被调用，预加载当前页面所有文章的元数据和分类术语。
相关文章（Related Posts）：在显示相关文章时，_prime_post_caches()会被调用，预加载相关文章的数据。
自定义查询（Custom Queries）：在使用WP_Query进行自定义查询时，可以手动调用_prime_post_caches()，预加载查询结果中的文章数据。

6. 性能优化建议

避免过度使用元数据：虽然元数据非常灵活，但过多的元数据会增加数据库的负担，影响网站性能。尽量减少不必要的元数据字段。
合理使用缓存插件：选择一款优秀的缓存插件，例如WP Super Cache、W3 Total Cache等，可以有效提升网站性能。这些插件会自动处理缓存，减少数据库查询。
分析慢查询：使用Query Monitor等工具分析慢查询，找出性能瓶颈，针对性地进行优化。
注意： 即使使用了_prime_post_caches()，也要注意避免N+1查询问题。例如，在循环中不要再对每个文章都进行独立的数据库查询，尽量批量获取数据。

7. 总结

_prime_post_caches()函数是WordPress性能优化的一个重要组成部分。通过预加载文章的元数据和分类术语，它可以有效减少数据库查询次数，提升网站速度。了解了这个函数的工作原理，我们可以更好地进行WordPress性能优化，打造更快速、更流畅的网站。

让我们用一个表格来总结一下今天的内容：

函数名	作用	参数
`_prime_post_caches()`	批量预加载文章的元数据和分类术语缓存	`$post_ids` (文章ID数组), `$update_term_cache` (是否更新分类术语缓存), `$update_meta_cache` (是否更新元数据缓存)
`_prime_post_terms_caches()`	预加载文章的分类术语缓存	`$post_ids` (文章ID数组), `$taxonomies` (分类法数组)
`update_post_caches()`	预加载文章的元数据缓存，并再次调用`_prime_post_terms_caches()`更新分类术语缓存	`$posts` (文章对象或ID数组), `$update_term_cache` (是否更新分类术语缓存)
`update_post_meta_cache()`	批量从数据库查询文章元数据并存入缓存	`$post_ids` (文章ID数组)
`get_the_terms()`	获取文章相关的terms，会检查缓存，如果缓存没有命中，才会从数据库查询terms	`$id` (文章ID), `$taxonomy` (分类法)

希望今天的讲解能够帮助大家更好地理解WordPress的缓存机制，提升网站性能。谢谢大家！下课！

发表回复 取消回复

发表回复取消回复