分析 WordPress `get_post_meta()` 函数的源码：如何从数据库中获取文章元数据，并支持缓存。

各位观众老爷，晚上好！ 今天咱们来聊聊 WordPress 里一个非常重要的函数：get_post_meta()。 想象一下，WordPress 文章就像一栋房子，文章内容是房子的主体结构，而元数据就像房子里的家具、电器、装修风格等等，它们提供了关于这栋房子的额外信息。 get_post_meta() 就是我们获取这些“家具”的钥匙。

咱们的目标是深入源码，看看这个函数是如何从数据库里把文章的元数据“搬”出来的，以及它如何利用缓存来加速这个过程。准备好了吗？ Let’s dive in!

1. get_post_meta() 的基本用法

首先，简单回顾一下 get_post_meta() 的基本用法。 假设我们有一篇文章，ID 是 123，我们想获取名为 _my_custom_field 的元数据：

$meta_value = get_post_meta( 123, '_my_custom_field', true );

if ( $meta_value ) {
    echo '自定义字段的值是：' . $meta_value;
} else {
    echo '没有找到自定义字段。';
}

这里的三个参数分别是：

• $post_id: 文章的 ID。
• $key: 元数据的键名（也就是“家具”的名字）。
• $single: 一个布尔值，决定返回单个值还是一个数组。true 表示只返回第一个匹配的值，false 表示返回所有匹配的值的数组。

2. 源码剖析：get_post_meta() 的内部运作

现在，让我们打开 WordPress 的源代码，找到 get_post_meta() 函数的定义。 （通常在 /wp-includes/meta.php 文件中）。

get_post_meta() 函数的骨架大致如下：

function get_post_meta( $post_id, $key = '', $single = false ) {
    return get_metadata( 'post', $post_id, $key, $single );
}

哎？ 看起来 get_post_meta() 并没有做太多实际工作，它只是调用了另一个函数 get_metadata()。 这是 WordPress 代码中常见的设计模式：将通用功能抽象出来，方便重用。

get_metadata() 函数才是真正干活的家伙。 让我们深入 get_metadata() 函数：

function get_metadata( $meta_type, $object_id, $meta_key = '', $single = false ) {
    global $wpdb;

    $object_id = absint( $object_id );
    if ( ! $object_id ) {
        return false;
    }

    $meta_type = preg_replace( '/[^a-z0-9_]/', '', $meta_type );

    $cache_key = sanitize_key( $meta_type . '_' . $object_id );
    $id_cache = wp_cache_get( $cache_key, 'meta' );

    if ( ! is_array( $id_cache ) ) {
        $id_cache = array();
    }

    if ( $meta_key && isset( $id_cache[ $meta_key ] ) ) {
        if ( $single ) {
            return maybe_unserialize( $id_cache[ $meta_key ][0] );
        } else {
            return array_map( 'maybe_unserialize', $id_cache[ $meta_key ] );
        }
    }

    if ( ! $meta_key && isset( $id_cache[''] ) ) {
        if ( $single ) {
            return maybe_unserialize( $id_cache[''][0] );
        } else {
            return array_map( 'maybe_unserialize', $id_cache[''] );
        }
    }

    $table = _get_meta_table( $meta_type );

    if ( ! $table ) {
        return false;
    }

    $sql = "SELECT meta_key, meta_value FROM $table WHERE object_id = %d";

    if ( $meta_key ) {
        $sql .= $wpdb->prepare( " AND meta_key = %s", $meta_key );
    }

    $sql .= " ORDER BY meta_id ASC";

    $meta_list = $wpdb->get_results( $wpdb->prepare( $sql, $object_id ), ARRAY_A );

    if ( empty( $meta_list ) ) {
        return $single ? '' : array();
    }

    $id_cache = array();
    foreach ( $meta_list as $metarow ) {
        $meta_key = $metarow['meta_key'];
        $meta_value = $metarow['meta_value'];

        $id_cache[$meta_key][] = $meta_value;
    }

    wp_cache_add( $cache_key, $id_cache, 'meta' );

    if ( $meta_key && isset( $id_cache[ $meta_key ] ) ) {
        if ( $single ) {
            return maybe_unserialize( $id_cache[ $meta_key ][0] );
        } else {
            return array_map( 'maybe_unserialize', $id_cache[ $meta_key ] );
        }
    }

    if ( ! $meta_key && isset( $id_cache[''] ) ) {
        if ( $single ) {
            return maybe_unserialize( $id_cache[''][0] );
        } else {
            return array_map( 'maybe_unserialize', $id_cache[''] );
        }
    }

    return $single ? '' : array();
}

让我们把这个函数拆解成几个关键步骤：

步骤 1: 参数准备和安全性检查

• $object_id = absint( $object_id );: 将文章 ID 转换为整数，并确保它是正数。 这是一个很重要的安全措施，可以防止 SQL 注入攻击。
• $meta_type = preg_replace( '/[^a-z0-9_]/', '', $meta_type );: 清理元数据类型，只允许小写字母、数字和下划线。 同样是为了安全。

步骤 2: 尝试从缓存中获取数据

    $cache_key = sanitize_key( $meta_type . '_' . $object_id );
    $id_cache = wp_cache_get( $cache_key, 'meta' );

    if ( ! is_array( $id_cache ) ) {
        $id_cache = array();
    }

    if ( $meta_key && isset( $id_cache[ $meta_key ] ) ) {
        if ( $single ) {
            return maybe_unserialize( $id_cache[ $meta_key ][0] );
        } else {
            return array_map( 'maybe_unserialize', $id_cache[ $meta_key ] );
        }
    }

    if ( ! $meta_key && isset( $id_cache[''] ) ) {
        if ( $single ) {
            return maybe_unserialize( $id_cache[''][0] );
        } else {
            return array_map( 'maybe_unserialize', $id_cache[''] );
        }
    }

• $cache_key = sanitize_key( $meta_type . '_' . $object_id );: 生成一个唯一的缓存键。 这个键由元数据类型（例如 ‘post’）和文章 ID 组成。 sanitize_key() 函数用于确保缓存键的安全性。
• $id_cache = wp_cache_get( $cache_key, 'meta' );: 尝试从 WordPress 的对象缓存中获取数据。 wp_cache_get() 函数是 WordPress 缓存 API 的一部分，它可以从内存中快速检索数据。
• 后面的 if 语句检查缓存中是否有所需的元数据。 如果找到了，就直接从缓存中返回，避免了数据库查询。 maybe_unserialize() 函数用于将从数据库中取出的序列化数据反序列化。

步骤 3: 如果缓存未命中，则从数据库中查询

    $table = _get_meta_table( $meta_type );

    if ( ! $table ) {
        return false;
    }

    $sql = "SELECT meta_key, meta_value FROM $table WHERE object_id = %d";

    if ( $meta_key ) {
        $sql .= $wpdb->prepare( " AND meta_key = %s", $meta_key );
    }

    $sql .= " ORDER BY meta_id ASC";

    $meta_list = $wpdb->get_results( $wpdb->prepare( $sql, $object_id ), ARRAY_A );

    if ( empty( $meta_list ) ) {
        return $single ? '' : array();
    }

• $table = _get_meta_table( $meta_type );: 根据元数据类型获取数据库表的名称。 对于文章元数据，表名通常是 wp_postmeta。
• 构建 SQL 查询语句。 注意，这里使用了 $wpdb->prepare() 函数来防止 SQL 注入攻击。 这个函数会对查询语句中的变量进行转义，确保它们不会被解释为 SQL 代码。
• $meta_list = $wpdb->get_results( ... );: 执行 SQL 查询，从数据库中获取元数据。 $wpdb 是 WordPress 的数据库对象，提供了与数据库交互的各种方法。

步骤 4: 将数据存入缓存

    $id_cache = array();
    foreach ( $meta_list as $metarow ) {
        $meta_key = $metarow['meta_key'];
        $meta_value = $metarow['meta_value'];

        $id_cache[$meta_key][] = $meta_value;
    }

    wp_cache_add( $cache_key, $id_cache, 'meta' );

• 将从数据库中获取的元数据组织成一个数组。
• wp_cache_add( $cache_key, $id_cache, 'meta' );: 将元数据存入缓存，以便下次可以快速检索。

步骤 5: 返回结果

    if ( $meta_key && isset( $id_cache[ $meta_key ] ) ) {
        if ( $single ) {
            return maybe_unserialize( $id_cache[ $meta_key ][0] );
        } else {
            return array_map( 'maybe_unserialize', $id_cache[ $meta_key ] );
        }
    }

    if ( ! $meta_key && isset( $id_cache[''] ) ) {
        if ( $single ) {
            return maybe_unserialize( $id_cache[''][0] );
        } else {
            return array_map( 'maybe_unserialize', $id_cache[''] );
        }
    }

    return $single ? '' : array();

• 从缓存中（刚刚存入的）检索所需的数据，并返回。

3. 缓存机制的优势

get_post_meta() 函数的缓存机制带来了显著的性能提升。 想象一下，如果没有缓存，每次访问文章元数据都需要查询数据库，这会给数据库带来很大的压力，尤其是在高流量的网站上。

通过使用缓存，get_post_meta() 可以将元数据存储在内存中，从而大大减少了数据库查询的次数。 这可以显著提高网站的响应速度，并降低服务器的负载。

4. 数据库表结构

为了更好地理解 get_post_meta() 的工作原理，我们需要了解 WordPress 元数据表的结构。 对于文章元数据，相关的表是 wp_postmeta。 这个表通常包含以下字段：

字段名	数据类型	描述
meta_id	bigint(20) UNSIGNED	元数据的唯一 ID
post_id	bigint(20) UNSIGNED	文章 ID (关联到 wp_posts 表)
meta_key	varchar(255)	元数据的键名 (例如 ‘_my_custom_field’)
meta_value	longtext	元数据的值

5. 性能优化建议

虽然 get_post_meta() 已经使用了缓存机制，但我们仍然可以通过一些技巧来进一步优化性能：

• 避免过度使用元数据: 尽量减少存储在元数据中的数据量。 如果需要存储大量数据，可以考虑使用自定义表。
• 合理使用 $single 参数: 如果只需要获取单个值，请将 $single 设置为 true。 这可以避免返回不必要的数组。
• 使用对象缓存插件: 如果你的网站流量很大，可以考虑使用高级的对象缓存插件，例如 Memcached 或 Redis。 这些插件可以将缓存存储在内存中，从而提高缓存的性能。
• 避免在循环中调用 get_post_meta(): 如果需要在循环中获取多个文章的元数据，可以考虑一次性获取所有元数据，然后将其存储在一个数组中。 这可以避免多次查询数据库。 使用 update_meta_cache() 函数来预先加载多个文章的元数据。

6. 总结

get_post_meta() 是 WordPress 中一个非常重要的函数，它用于从数据库中获取文章元数据。 这个函数使用了缓存机制，可以显著提高性能。 通过深入理解 get_post_meta() 的工作原理，我们可以更好地优化 WordPress 网站的性能。

希望今天的讲座对大家有所帮助！ 感谢大家的收看，我们下次再见！