post-package-install 是 Composer 在包安装后触发的事件,可用于执行初始化配置、生成文件或提示操作。通过在 composer.json 中定义脚本并编写处理类,可监听该事件,在特定包安装完成后运行自定义逻辑,如生成配置、软链接资源或输出提示信息。需注意仅对目标包执行操作,避免耗时任务,以提升安装体验。
在 Composer 中,post-package-install是一个钩子事件(event),它在某个具体的包被安装完成后自动触发。这个事件属于 Composer 的脚本系统,允许你在特定生命周期节点执行自定义逻辑。什么是 post-package-install 事件?当 Composer 安装一个新包(通过composerrequire vendor/package)时,会在该包写入磁盘并完成安装后,触发一次post-package-install事件。你可以监听这个事件来运行 PHP 函数或命令行脚本。它接收一个参数:一个对象,从中可以获取到刚刚安装的包信息,比如包名、版本、类型等。应用场景举例这个事件适合用于需要对特定包进行初始化配置、生成文件、注册服务或提示用户操作的场景。某个组件包安装后,自动生成配置文件到项目 config 目录前端资源包安装后,自动软链接到 public 目录通知开发者运行额外命令(如发布配置或迁移)记录安装日志或打点监控如何使用?你需要在项目的composer.json中定义脚本,并编写对应的处理类和方法。1. 在 composer.json中注册事件:2. 创建处理类 My/Installer.php:PHP 8.5.5PHP 8.5.5 是 PHP 8.5 分支的维护更新版本。该版本延续了“小步快跑”的迭代逻辑,通过深度错误修复、底层性能微调以及安全加固,旨在为开发者提供一个更健壮、更高效的运行环境。该版本严格遵守语义化版本规范,不包含破坏性变更。下载3. 确保命名空间能被自动加载,通常把类放在或目录,并在 autoload 添加映射:然后运行composer dump-autoload让类可用。注意事项这个事件每次安装一个包都会触发一次,所以建议通过判断包名来限定行为,避免不必要的操作。不建议在此事件中执行耗时或网络请求类操作,会影响整体安装体验。如果你只想在开发环境提示,可以用判断上下文。基本上就这些。用好 post-package-install 能让包更“智能”,提升集成体验。
ComposerScriptEvent"scripts": {
"post-package-install": [
"My\Installer::onPostPackageInstall"
]
}getOperation()->getPackage();
$name = $package->getName(); // 如:monolog/monolog
$version = $package->getPrettyVersion(); // 如:2.8.0
$type = $package->getType(); // 如:library
if ($name === 'your-vendor/your-special-package') {
echo "? 欢迎使用 {$name}!
";
echo "请记得运行 php bin/init.php 来初始化配置。
";
// 可以在这里复制文件、创建目录等
// copy(__DIR__ . '/stubs/config.php', base_path('config/special.php'));
}
}
}
scripts/src/"autoload": {
"psr-4": {
"My\": "scripts/"
}
}$event->getComposer()->getConfig()->get('vendor-dir')