阐述 WordPress `dbDelta()` 函数的源码：它是如何通过比较新旧表结构来生成 `ALTER TABLE` 语句的。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

好了，各位观众，今天咱们来聊聊 WordPress 里一个神奇的函数：dbDelta()。别看名字像个什么三角洲部队，实际上它跟数据库息息相关。这货是 WordPress 用来升级数据库表结构的秘密武器，能帮你自动搞定那些让人头疼的 ALTER TABLE 语句。

咱们的目标是：彻底搞懂 dbDelta() 的源码，看看它是怎么通过比较新旧表结构，然后聪明地生成 SQL 语句来升级数据库的。准备好了吗？ Let’s dive in!

开场白：为啥我们需要 dbDelta()？

想象一下，你开发了一个超酷的 WordPress 插件，用到了自定义数据库表。插件发布后，你又加了新功能，需要修改表的结构，比如新增一列，或者修改列的数据类型。

如果每次都手动写 ALTER TABLE 语句，那简直就是一场噩梦！不仅容易出错，而且不同的数据库版本（比如 MySQL 5.7 和 MySQL 8.0）对 SQL 语法的支持可能还有差异。

这时候，dbDelta() 就派上用场了。你只需要告诉它你想要的表结构，它就会自动帮你生成兼容的 SQL 语句，完成数据库升级。

dbDelta() 的基本用法

在深入源码之前，我们先来看看 dbDelta() 的基本用法，有个直观的认识。

global $wpdb;

$table_name = $wpdb->prefix . 'my_custom_table';

$charset_collate = $wpdb->get_charset_collate();

$sql = "CREATE TABLE $table_name (
    id mediumint(9) NOT NULL AUTO_INCREMENT,
    time datetime DEFAULT '0000-00-00 00:00:00' NOT NULL,
    name varchar(255) NOT NULL,
    description text,
    PRIMARY KEY  (id)
) $charset_collate;";

require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
dbDelta( $sql );

这段代码做了什么？

定义表名： $table_name 存储了表的完整名称，包括 WordPress 的表前缀。
定义字符集和排序规则： $charset_collate 存储了数据库的字符集和排序规则，用于创建表时指定。
定义 SQL 语句： $sql 存储了创建表的 SQL 语句。注意，这个 SQL 语句非常重要，它定义了你想要的表结构。 dbDelta() 会根据这个 SQL 语句来判断是否需要升级数据库。
引入 upgrade.php： 这个文件包含了 dbDelta() 函数。
调用 dbDelta()： dbDelta($sql) 执行数据库升级操作。

dbDelta() 源码剖析：一步一步揭秘

好了，现在我们开始深入 dbDelta() 的源码。源码位于 /wp-admin/includes/upgrade.php 文件中。为了便于理解，我对源码进行了简化和注释。

function dbDelta( $queries, $execute = true ) {
    global $wpdb;

    // 1. 获取当前数据库的版本
    $wp_db_version = get_option( 'db_version' );

    // 2. 将 SQL 语句分割成单个的 CREATE TABLE 语句
    if ( ! is_array( $queries ) ) {
        $queries = explode( ';', $queries );
    }

    // 3. 遍历每个 CREATE TABLE 语句
    foreach ( $queries as $query ) {
        $query = trim( $query );
        if ( empty( $query ) ) {
            continue;
        }

        // 4. 解析 CREATE TABLE 语句，提取表名和字段信息
        preg_match( '/CREATE TABLE `?(.+?)`?s/i', $query, $matches );
        if ( empty( $matches ) ) {
            continue;
        }
        $table_name = $matches[1];

        // 5. 获取当前数据库中该表的结构
        $existing_table_info = $wpdb->get_results( "DESCRIBE `$table_name`;" );

        // 6. 如果表不存在，则直接创建
        if ( empty( $existing_table_info ) ) {
            if ( $execute ) {
                $wpdb->query( $query );
            }
            continue;
        }

        // 7. 如果表已存在，则比较新旧表结构，生成 ALTER TABLE 语句
        $alter_queries = compare_table( $table_name, $query, $existing_table_info );

        // 8. 执行 ALTER TABLE 语句
        if ( ! empty( $alter_queries ) && $execute ) {
            foreach ( $alter_queries as $alter_query ) {
                $wpdb->query( $alter_query );
            }
        }
    }

    // 9. 更新数据库版本
    update_option( 'db_version', time() );

    return;
}

让我们分解一下 dbDelta() 的工作流程：

获取数据库版本： get_option( 'db_version' ) 获取当前数据库的版本号。这个版本号用于跟踪数据库的升级历史。
分割 SQL 语句： explode( ';', $queries ) 将传入的 SQL 语句分割成单个的 CREATE TABLE 语句。 dbDelta() 可以一次处理多个 CREATE TABLE 语句。
遍历 SQL 语句： foreach 循环遍历每个 CREATE TABLE 语句。
解析 SQL 语句： preg_match() 使用正则表达式从 CREATE TABLE 语句中提取表名。
获取现有表结构： $wpdb->get_results( "DESCRIBE$table_name;" ) 执行 DESCRIBE 语句，获取当前数据库中该表的结构信息。 DESCRIBE 语句会返回一个包含字段名、数据类型、键等信息的数组。
表不存在： 如果 DESCRIBE 语句返回空，说明表不存在，直接执行 CREATE TABLE 语句创建表。
表已存在： 如果表已存在，调用 compare_table() 函数比较新旧表结构，生成 ALTER TABLE 语句。compare_table() 是整个 dbDelta() 函数的核心！
执行 ALTER TABLE 语句： foreach 循环遍历 compare_table() 返回的 ALTER TABLE 语句，并执行它们。
更新数据库版本： update_option( 'db_version', time() ) 更新数据库版本号，表示数据库已经升级到最新状态。

compare_table() 函数：新旧表结构的大PK

compare_table() 函数负责比较新旧表结构，并生成相应的 ALTER TABLE 语句。由于 compare_table 函数比较复杂，我们再简化一下，只关注核心逻辑。

function compare_table( $table_name, $new_table_query, $existing_table_info ) {
    global $wpdb;

    $alter_queries = array();

    // 1. 解析新的 CREATE TABLE 语句
    $new_table_fields = parse_fields_from_create_table( $new_table_query );

    // 2. 遍历新的字段定义
    foreach ( $new_table_fields as $field_name => $field_definition ) {
        // 3. 检查字段是否存在于现有表中
        $field_exists = false;
        foreach ( $existing_table_info as $existing_field ) {
            if ( strtolower( $existing_field->Field ) == strtolower( $field_name ) ) {
                $field_exists = true;
                // 4. 比较字段定义是否相同
                if ( ! compare_field_definitions( $field_definition, $existing_field ) ) {
                    // 生成 ALTER TABLE CHANGE 语句
                    $alter_queries[] = "ALTER TABLE `$table_name` CHANGE `$field_name` `$field_name` $field_definition";
                }
                break;
            }
        }

        // 5. 如果字段不存在，则添加字段
        if ( ! $field_exists ) {
            // 生成 ALTER TABLE ADD COLUMN 语句
            $alter_queries[] = "ALTER TABLE `$table_name` ADD `$field_name` $field_definition";
        }
    }

    // 6. 检查是否有字段需要删除 (简化，实际dbDelta会处理删除字段的情况)

    return $alter_queries;
}

compare_table() 的工作流程：

解析新的 CREATE TABLE 语句： parse_fields_from_create_table() 函数解析 CREATE TABLE 语句，提取出字段名和字段定义。
遍历新的字段定义： foreach 循环遍历新的字段定义。
检查字段是否存在： 遍历现有表的字段信息，检查新的字段是否存在于现有表中。
比较字段定义： 如果字段存在，调用 compare_field_definitions() 函数比较新旧字段的定义是否相同。如果不同，则生成 ALTER TABLE CHANGE 语句。
添加新字段： 如果字段不存在，则生成 ALTER TABLE ADD COLUMN 语句。
删除旧字段： (简化) 实际的 dbDelta() 还会检查是否有字段需要删除。
返回 ALTER TABLE 语句： 返回一个包含所有 ALTER TABLE 语句的数组。

parse_fields_from_create_table() 函数：SQL 语句的解剖大师

parse_fields_from_create_table() 函数负责解析 CREATE TABLE 语句，提取出字段名和字段定义。这个函数也比较复杂，我们同样进行简化。

function parse_fields_from_create_table( $create_table_query ) {
    $fields = array();
    // 使用正则表达式匹配字段定义
    preg_match_all( '/`(.+?)`s(.*?)(,|n)/', $create_table_query, $matches, PREG_SET_ORDER );

    foreach ( $matches as $match ) {
        $field_name = $match[1];
        $field_definition = trim( $match[2] );
        $fields[ $field_name ] = $field_definition;
    }

    return $fields;
}

这个函数使用正则表达式来匹配 CREATE TABLE 语句中的字段定义，然后将字段名和字段定义存储到一个数组中。

compare_field_definitions() 函数：字段定义的精细比较

compare_field_definitions() 函数负责比较新旧字段的定义是否相同。这个函数需要考虑各种因素，比如数据类型、长度、是否允许为空、默认值等等。为了简化，我们只比较数据类型和长度。

function compare_field_definitions( $new_field_definition, $existing_field ) {
    // 提取现有字段的数据类型和长度
    preg_match( '/([a-z]+)(?(d*))?/', $existing_field->Type, $matches );
    $existing_data_type = $matches[1];
    $existing_data_length = isset( $matches[2] ) ? $matches[2] : '';

    // 提取新的字段定义的数据类型和长度
    preg_match( '/([a-z]+)(?(d*))?/i', $new_field_definition, $matches );
    $new_data_type = $matches[1];
    $new_data_length = isset( $matches[2] ) ? $matches[2] : '';

    // 比较数据类型和长度 (忽略大小写)
    if ( strtolower( $new_data_type ) != strtolower( $existing_data_type ) || $new_data_length != $existing_data_length ) {
        return false; // 定义不同
    }

    return true; // 定义相同
}

这个函数使用正则表达式来提取数据类型和长度，然后进行比较。如果数据类型或长度不同，则认为字段定义不同。

举例说明：dbDelta() 的实际应用

假设我们有一个名为 wp_my_table 的表，最初的结构如下：

CREATE TABLE wp_my_table (
    id mediumint(9) NOT NULL AUTO_INCREMENT,
    name varchar(255) NOT NULL,
    PRIMARY KEY  (id)
);

现在，我们需要添加一个新的字段 email，类型为 varchar(100)。我们可以这样使用 dbDelta()：

global $wpdb;

$table_name = $wpdb->prefix . 'my_table';

$sql = "CREATE TABLE $table_name (
    id mediumint(9) NOT NULL AUTO_INCREMENT,
    name varchar(255) NOT NULL,
    email varchar(100),
    PRIMARY KEY  (id)
);";

require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
dbDelta( $sql );

dbDelta() 会比较新的表结构和现有的表结构，发现缺少 email 字段，然后生成以下 ALTER TABLE 语句：

ALTER TABLE `wp_my_table` ADD `email` varchar(100);

dbDelta() 会自动执行这个 ALTER TABLE 语句，完成数据库升级。

总结：dbDelta() 的核心思想

dbDelta() 的核心思想是：

描述期望的状态： 通过 CREATE TABLE 语句描述你期望的表结构。
自动比较和升级： dbDelta() 会自动比较期望的表结构和现有的表结构，然后生成 ALTER TABLE 语句来升级数据库。

dbDelta() 极大地简化了 WordPress 插件和主题的数据库升级过程，让开发者可以专注于业务逻辑，而不用担心数据库的兼容性问题。

注意事项：dbDelta() 的使用技巧

完整的 CREATE TABLE 语句： dbDelta() 需要完整的 CREATE TABLE 语句，包括字段名、数据类型、长度、键、字符集等等。
表前缀： 确保 CREATE TABLE 语句中的表名包含 WordPress 的表前缀。
字符集和排序规则： 使用 $wpdb->get_charset_collate() 获取数据库的字符集和排序规则，并在 CREATE TABLE 语句中指定。
只处理表结构： dbDelta() 主要用于处理表结构的变化，不适合处理数据迁移。
谨慎使用： 虽然 dbDelta 很方便，但是也需要谨慎使用，特别是在生产环境中。最好先在测试环境中进行测试，确保升级过程没有问题。
代码之外： 理解dbDelta的原理可以帮助你更好地设计数据库结构和升级策略。例如，尽量避免删除字段，因为dbDelta处理删除字段的情况比较复杂。尽量使用标准的数据类型，避免使用数据库特定的数据类型。

结语：dbDelta() 的威力

dbDelta() 是 WordPress 开发中一个非常有用的工具。掌握 dbDelta() 的原理和使用技巧，可以让你更高效地开发 WordPress 插件和主题，并轻松应对数据库升级的挑战。

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

发表回复 取消回复

发表回复取消回复