各位观众，晚上好！我是今天的客座讲师，今天咱们聊聊 WordPress WP-CLI 的扫尾工作：WP_CLI::get_runner()->do_when_exit()，看看它怎么在命令执行完后，默默地收拾残局。
开场白：一场命令执行后的狂欢
想象一下，你在 WordPress 后台兢兢业业地输入各种命令，WP-CLI 就像一个勤劳的小蜜蜂，帮你完成各种任务：更新插件，导入数据，备份网站… 一顿操作猛如虎，然后呢？命令执行完了，WP-CLI 就拍拍屁股走人了？当然不是！它还得做一些扫尾工作，确保一切安好。
WP_CLI::get_runner()->do_when_exit() 就是负责这些扫尾工作的总指挥。 咱们今天就来扒一扒它的源码，看看它到底干了些什么。
WP_CLI::get_runner()->do_when_exit() 的真面目
首先，我们得找到 WP_CLI::get_runner()->do_when_exit() 这个函数在哪里。 它实际上是 WP_CLIRunner 类的一个方法，负责在 WP-CLI 进程退出时执行一系列操作。
<?php
namespace WP_CLI;
/**
* Class Runner
*
* This class is responsible for running the WP-CLI application.
*
* @package WP_CLI
*/
class Runner {
/**
* Run cleanup routines before exiting.
*
* @access public
*/
public function do_when_exit() {
WP_CLI::debug( 'Running cleanup routines', 'bootstrap' );
// Close the database connection, if it was opened.
if ( WP_CLI::get_wp_db() instanceof wpdb ) {
WP_CLI::get_wp_db()->close();
}
// Do anything registered for 'exit'.
do_action( 'wp_cli_after_invoke' );
do_action( 'shutdown' );
do_action( 'wp_cli_exit' );
}
}从源码中可以看出，do_when_exit() 主要做了以下几件事：
- 调试信息：
WP_CLI::debug( 'Running cleanup routines', 'bootstrap' );记录一条调试信息，告诉你 WP-CLI 正在进行清理工作。 这就像一个勤劳的小蜜蜂在离开前，还不忘给自己点个赞：“我正在清理战场，棒棒哒！” - 关闭数据库连接：
if ( WP_CLI::get_wp_db() instanceof wpdb ) { WP_CLI::get_wp_db()->close(); }如果 WP-CLI 在执行命令的过程中打开了数据库连接，那么在这里会关闭它。 这就像用完水龙头，记得关紧，节约用水。 - 触发钩子：
do_action( 'wp_cli_after_invoke' ); do_action( 'shutdown' ); do_action( 'wp_cli_exit' );触发一系列 WordPress 钩子，允许其他代码在 WP-CLI 退出前执行一些操作。 这就像在派对结束后，给客人一个告别拥抱，让他们有机会说声再见。
深入剖析：每一步都至关重要
让我们更深入地了解一下 do_when_exit() 的每一个步骤。
-
调试信息： 这条调试信息对于开发者来说非常有用，可以帮助他们了解 WP-CLI 的运行过程。 尤其是在排查问题时，可以看到 WP-CLI 什么时候开始清理工作，从而更好地定位问题。
-
关闭数据库连接： 关闭数据库连接非常重要，可以释放数据库资源，防止资源浪费。 如果不关闭数据库连接，可能会导致数据库连接数达到上限，影响网站的正常运行。 在高并发的场景下，这一点尤为重要。
-
触发钩子：
do_action( 'wp_cli_after_invoke' );这个钩子在 WP-CLI 命令执行完毕后，但在清理工作开始前触发。do_action( 'shutdown' );是 WordPress 常规的 shutdown 钩子，在脚本执行即将结束时触发。do_action( 'wp_cli_exit' );是 WP-CLI 特有的退出钩子，在所有清理工作完成后触发。 这些钩子允许开发者在 WP-CLI 退出前执行一些自定义操作，例如：- 发送通知：在命令执行完毕后，发送邮件或短信通知管理员。
- 记录日志：将命令执行的详细信息记录到日志文件中。
- 清理缓存：清理缓存，确保网站显示最新的内容。
钩子大作战：自定义扫尾工作
既然 do_when_exit() 提供了这么多钩子，我们就可以利用这些钩子来定制自己的扫尾工作。 下面是一些示例：
示例 1：发送邮件通知
<?php
add_action( 'wp_cli_exit', 'my_wp_cli_exit_callback' );
function my_wp_cli_exit_callback() {
$to = '[email protected]';
$subject = 'WP-CLI 命令执行完毕';
$message = 'WP-CLI 命令已经执行完毕，请注意查看。';
$headers = array('Content-Type: text/html; charset=UTF-8');
wp_mail( $to, $subject, $message, $headers );
WP_CLI::log( '已发送邮件通知。' );
}这段代码会在 WP-CLI 退出时，发送一封邮件给管理员，通知他们命令已经执行完毕。
示例 2：记录日志
<?php
add_action( 'wp_cli_exit', 'my_wp_cli_log_callback' );
function my_wp_cli_log_callback() {
$log_file = WP_CONTENT_DIR . '/wp-cli.log';
$message = sprintf( '[%s] WP-CLI 命令执行完毕。', date( 'Y-m-d H:i:s' ) );
file_put_contents( $log_file, $message . PHP_EOL, FILE_APPEND );
WP_CLI::log( '已记录日志。' );
}这段代码会将命令执行完毕的信息记录到 wp-cli.log 文件中。
示例 3：清理对象缓存
<?php
add_action( 'wp_cli_after_invoke', 'my_wp_cli_clear_object_cache' );
function my_wp_cli_clear_object_cache() {
wp_cache_flush();
WP_CLI::log( '已清理对象缓存。' );
}这段代码在命令执行后，清理对象缓存。 注意，这里使用的是 wp_cli_after_invoke 钩子，因为它在清理数据库连接之前触发，这样可以确保缓存被正确清理。
do_when_exit() 的调用时机
那么，do_when_exit() 是什么时候被调用的呢？ 实际上，它是在 WP_CLI::run() 函数中通过 register_shutdown_function() 注册的。
<?php
namespace WP_CLI;
class WP_CLI {
/**
* Run the WP-CLI application.
*
* @param array $args Command-line arguments.
*/
public static function run( $args ) {
// ... 其他代码 ...
register_shutdown_function( function() {
WP_CLI::get_runner()->do_when_exit();
} );
// ... 其他代码 ...
}
}register_shutdown_function() 是 PHP 的一个内置函数，用于注册一个在脚本执行即将结束时执行的函数。 这意味着，无论 WP-CLI 是正常退出还是因为发生错误而退出，do_when_exit() 都会被执行。 这保证了清理工作能够顺利完成。
do_when_exit() 的局限性
虽然 do_when_exit() 非常有用，但它也有一些局限性：
-
无法访问命令执行结果： 在
do_when_exit()中，无法直接访问命令执行的结果（例如，命令的返回值，输出信息）。 如果需要根据命令执行结果来执行不同的扫尾工作，就需要使用其他方法，例如，在命令内部设置全局变量，然后在do_when_exit()中读取这些变量。 -
可能受到其他代码的影响： 由于
do_action( 'shutdown' );会触发 WordPress 的 shutdown 钩子，因此do_when_exit()的执行可能会受到其他代码的影响。 例如，如果其他代码在 shutdown 钩子中执行了耗时操作，可能会导致 WP-CLI 退出时间延长。
最佳实践：优雅地扫尾
为了更好地利用 do_when_exit() 来完成扫尾工作，可以遵循以下最佳实践：
-
保持简洁：
do_when_exit()中的代码应该尽可能简洁，避免执行耗时操作。 如果需要执行复杂的扫尾工作，可以将这些工作放到后台任务中执行。 -
处理异常： 在
do_when_exit()中，应该对可能发生的异常进行处理，防止异常导致清理工作中断。 可以使用try...catch语句来捕获异常，并记录错误信息。 -
避免依赖全局状态： 尽量避免在
do_when_exit()中依赖全局状态，因为全局状态可能已经被修改或销毁。 如果必须使用全局状态，应该在使用前进行检查，确保其有效性。
总结：幕后英雄的谢幕
WP_CLI::get_runner()->do_when_exit() 就像一个默默无闻的幕后英雄，在 WP-CLI 命令执行完毕后，默默地收拾残局，确保一切安好。 通过理解它的源码和工作原理，我们可以更好地利用它来定制自己的扫尾工作，让 WP-CLI 更加强大和可靠。
表格总结
| 功能 | 描述 |
|---|---|
| 调试信息 | 记录调试信息，方便开发者了解 WP-CLI 的运行过程。 |
| 关闭数据库连接 | 释放数据库资源，防止资源浪费。 |
| 触发钩子 | 允许其他代码在 WP-CLI 退出前执行一些自定义操作，例如发送通知、记录日志、清理缓存等。 |
| 调用时机 | 通过 register_shutdown_function() 注册，在脚本执行即将结束时执行，无论 WP-CLI 是正常退出还是因为发生错误而退出。 |
| 局限性 | 无法访问命令执行结果，可能受到其他代码的影响。 |
| 最佳实践 | 保持简洁，处理异常，避免依赖全局状态。 |
希望今天的讲座对大家有所帮助！ 谢谢大家！