WordPress源码深度解析之：`wp-admin/includes/upgrade.php`：数据库更新与`dbDelta()`函数的底层实现。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷们，晚上好！我是你们的老朋友，今天咱们来聊聊WordPress里一个至关重要的文件——wp-admin/includes/upgrade.php，以及它里面的灵魂人物dbDelta()函数。别害怕，虽然名字听起来像什么变形金刚，但其实它就是个数据库升级的小能手。

一、开场白：数据库升级的那些事儿

想想看，WordPress的版本一直在更新迭代，新的功能层出不穷。这些新功能往往需要新的数据库表，或者对现有表进行修改。如果没有一套完善的升级机制，那每次升级都得手动去执行SQL语句，那画面太美我不敢看。

wp-admin/includes/upgrade.php 文件就是用来解决这个问题的，它包含了一系列用于数据库升级的函数，而dbDelta()则是其中的核心。

二、upgrade.php 的主要职责

这个文件主要负责以下几个方面：

检测数据库版本： 检查当前数据库版本是否低于WordPress版本所需版本。
执行升级脚本： 根据版本差异，执行相应的升级脚本，包括创建新表、修改表结构、插入数据等。
更新数据库版本号： 升级完成后，更新数据库中的版本号，以便下次升级时知道从哪里开始。
一些辅助函数： 提供一些辅助函数，用于简化数据库操作，例如检查表是否存在，执行SQL语句等。

三、dbDelta()：数据库升级的瑞士军刀

好了，重头戏来了！dbDelta() 函数，它就像一把瑞士军刀，可以帮你完成各种数据库升级任务。

1. dbDelta() 的基本用法

dbDelta() 函数接受一个字符串参数，这个字符串包含一系列的SQL语句，用于定义数据库表结构。

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

    //... 省略部分代码 ...

    foreach ( (array) $queries as $query ) {
        if ( ! trim( $query ) ) {
            continue;
        }

        //... 省略部分代码 ...

        $cqueries = preg_split( '/[rn]+/', $query );

        foreach ( $cqueries as $cquery ) {
            if ( strpos( $cquery, 'CREATE TABLE' ) !== false ) {
                //... 处理创建表的情况 ...
            } elseif ( strpos( $cquery, 'ALTER TABLE' ) !== false ) {
                //... 处理修改表的情况 ...
            }
        }
    }

    //... 省略部分代码 ...
}

举个栗子：

$sql = "CREATE TABLE {$wpdb->prefix}my_custom_table (
  id bigint(20) unsigned NOT NULL auto_increment,
  name varchar(255) NOT NULL default '',
  value text NOT NULL,
  PRIMARY KEY  (id)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;";

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

这段代码会创建一个名为 wp_my_custom_table 的表，包含 id, name, value 三个字段。

2. dbDelta() 的神奇之处

dbDelta() 的神奇之处在于，它不会盲目执行SQL语句，而是会先检查数据库中是否已经存在相应的表或字段。如果已经存在，它就会跳过相应的语句，避免重复创建或修改。

3. dbDelta() 的工作原理

dbDelta() 的工作原理大致如下：

解析SQL语句： 将传入的SQL语句字符串分割成单个的SQL语句。
判断语句类型： 识别SQL语句的类型，例如 CREATE TABLE，ALTER TABLE 等。
检查表是否存在： 如果是 CREATE TABLE 语句，则检查数据库中是否已经存在同名的表。
检查字段是否存在： 如果是 ALTER TABLE 语句，则检查表中是否已经存在相应的字段。
执行SQL语句： 如果表或字段不存在，则执行相应的SQL语句。

四、dbDelta() 的底层实现：庖丁解牛

接下来，我们深入剖析dbDelta()的源码，看看它是如何实现上述功能的。

分割SQL语句

dbDelta() 首先使用 preg_split() 函数将传入的SQL语句字符串分割成单个的SQL语句。分割符是 rn，也就是回车和换行。

$cqueries = preg_split( '/[rn]+/', $query );

识别语句类型

dbDelta() 使用 strpos() 函数来判断SQL语句的类型。

if ( strpos( $cquery, 'CREATE TABLE' ) !== false ) {
    //... 处理创建表的情况 ...
} elseif ( strpos( $cquery, 'ALTER TABLE' ) !== false ) {
    //... 处理修改表的情况 ...
}

处理 CREATE TABLE 语句

如果SQL语句是 CREATE TABLE，dbDelta() 会检查数据库中是否已经存在同名的表。

$create_query = trim( substr( $cquery, 0, strpos( $cquery, '(' ) ) );
$tablename = trim( str_replace( 'CREATE TABLE', '', $create_query ) );

if ( ! empty( $wpdb->charset ) ) {
    //... 添加字符集和校对规则 ...
}

if ( ! $wpdb->get_var( "SHOW TABLES LIKE '" . $tablename . "'" ) ) {
    //... 执行创建表语句 ...
}

substr() 和 strpos() 用于提取表名。
$wpdb->get_var() 用于检查表是否存在。

处理 ALTER TABLE 语句

如果SQL语句是 ALTER TABLE，dbDelta() 会检查表中是否已经存在相应的字段。

$alter_query = trim( substr( $cquery, 0, strpos( $cquery, 'ADD' ) ) );
$tablename = trim( str_replace( 'ALTER TABLE', '', $alter_query ) );

$field_query = trim( substr( $cquery, strpos( $cquery, 'ADD' ) + 3 ) );
$fieldname = trim( str_replace( array( '`', '"' ), '', substr( $field_query, 0, strpos( $field_query, ' ' ) ) ) );

$exists = $wpdb->get_var( "SHOW COLUMNS FROM {$tablename} LIKE '{$fieldname}'" );

if ( ! $exists ) {
    //... 执行修改表语句 ...
}

substr() 和 strpos() 用于提取表名和字段名。
$wpdb->get_var() 用于检查字段是否存在。

五、dbDelta() 的使用技巧

使用 $wpdb->prefix 前缀

为了避免与其他插件或主题的表名冲突，建议在创建表时使用 $wpdb->prefix 前缀。

$sql = "CREATE TABLE {$wpdb->prefix}my_custom_table ( ... )";

定义字符集和校对规则

为了保证数据的正确存储和显示，建议在创建表时定义字符集和校对规则。

$charset_collate = $wpdb->get_charset_collate();
$sql = "CREATE TABLE {$wpdb->prefix}my_custom_table ( ... ) $charset_collate;";

使用 ENGINE=InnoDB

InnoDB 引擎支持事务和外键，建议使用它作为表的存储引擎。

$sql = "CREATE TABLE {$wpdb->prefix}my_custom_table ( ... ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;";

一次性执行多个SQL语句

dbDelta() 可以一次性执行多个SQL语句，只需要将它们放在同一个字符串中，并用回车和换行分隔。

$sql = "CREATE TABLE {$wpdb->prefix}table1 ( ... );n";
$sql .= "CREATE TABLE {$wpdb->prefix}table2 ( ... );";
dbDelta( $sql );

六、dbDelta() 的局限性

dbDelta() 虽然强大，但也有一些局限性：

只能处理简单的表结构修改： 对于复杂的表结构修改，例如重命名表，删除字段等，dbDelta() 可能无法胜任。
不支持存储过程和函数： dbDelta() 只能处理表结构相关的SQL语句，不支持存储过程和函数。
错误处理不够完善： 如果SQL语句执行失败，dbDelta() 可能会抛出异常，但错误信息不够详细。

七、示例：完整的数据库升级脚本

下面是一个完整的数据库升级脚本示例：

function my_plugin_update_db_check() {
    if ( get_site_option( 'my_plugin_db_version' ) != '1.0' ) {
        my_plugin_install();
    }
}
add_action( 'plugins_loaded', 'my_plugin_update_db_check' );

function my_plugin_install() {
    global $wpdb;

    $charset_collate = $wpdb->get_charset_collate();

    $sql = "CREATE TABLE {$wpdb->prefix}my_custom_table (
      id bigint(20) unsigned NOT NULL auto_increment,
      name varchar(255) NOT NULL default '',
      value text NOT NULL,
      PRIMARY KEY  (id)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci $charset_collate;";

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

    update_site_option( 'my_plugin_db_version', '1.0' );
}

这个脚本会在插件激活时检查数据库版本，如果版本低于 1.0，则执行 my_plugin_install() 函数，创建 wp_my_custom_table 表，并将数据库版本更新为 1.0。

八、总结

dbDelta() 函数是WordPress数据库升级的核心，它可以简化数据库升级的过程，避免重复创建或修改表结构。了解 dbDelta() 的工作原理和使用技巧，可以帮助你更好地开发WordPress插件和主题。

重点知识表格：

函数/变量	作用
`dbDelta()`	核心函数，用于执行数据库升级，自动检查表和字段是否存在，避免重复创建或修改。
`$wpdb->prefix`	WordPress数据库表前缀，用于避免与其他插件或主题的表名冲突。
`$wpdb->get_charset_collate()`	获取数据库字符集和校对规则，用于保证数据的正确存储和显示。
`ENGINE=InnoDB`	表的存储引擎，`InnoDB` 支持事务和外键。
`preg_split()`	PHP函数，用于分割字符串。
`strpos()`	PHP函数，用于查找字符串在另一个字符串中首次出现的位置。
`$wpdb->get_var()`	WordPress数据库查询函数，用于执行SQL查询并返回结果的第一行第一列的值。
`update_site_option()`	WordPress函数，用于更新站点选项。

好了，今天的讲座就到这里，希望对大家有所帮助！记住，dbDelta() 虽然强大，但也要谨慎使用，避免对数据库造成不必要的损失。下次再见！

发表回复 取消回复

发表回复取消回复