composer可通过配置scripts字段在事件前后执行自定义脚本,如post-install-cmd、post-update-cmd等,支持运行shell命令或调用php静态方法,结合autoload可复用脚本类,实现安装、更新后的自动任务处理,提升开发自动化效率。
Composer 允许你在安装、更新或卸载依赖时自动执行自定义脚本,通过在 composer.json 中配置 scripts
字段实现。你可以在事件发生前后运行 PHP 脚本或 shell 命令。
支持的常用 Composer 事件
Composer 提供多个生命周期事件,你可以绑定脚本到这些事件:
- pre-install-cmd:执行 install 前
- post-install-cmd:install 完成后
- pre-update-cmd:update 前
- post-update-cmd:update 完成后
- pre-autoload-dump:生成自动加载文件前
- post-autoload-dump:自动加载生成后
- post-root-package-install:项目初始化后(如 create-project)
配置自定义脚本的方法
编辑 composer.json 文件,在 scripts
字段中添加对应事件和命令。
示例:在 install 和 update 后输出提示并生成 autoload 文件
{ "scripts": { "post-install-cmd": [ "echo '依赖已安装,正在处理后续任务...'", "php generate-config.php" ], "post-update-cmd": [ "echo '依赖已更新'", "php clear-cache.php" ] } }
也可以调用类中的静态方法:
{ "scripts": { "post-install-cmd": [ "MyScript::runPostInstall" ] } }
确保该类能被自动加载,并且方法为 Static。
编写可复用的 PHP 脚本类
创建一个 PHP 类来集中管理脚本逻辑:
<?php // scripts/Script.php namespace My; use ComposerScriptEvent; class Script { public static function runPostInstall(Event $event) { $io = $event->getIO(); $io->write("<info>执行 post-install 自定义操作...</info>"); // 可在此执行备份、生成配置、清理缓存等 } public static function clearCache(Event $event) { $io->write("清除应用缓存..."); // exec('rm -rf cache/*'); } }
然后在 composer.JSon 中引用:
{ "autoload": { "psr-4": { "My": "scripts/" } }, "scripts": { "post-install-cmd": [ "MyScript::runPostInstall", "MyScript::clearCache" ] } }
注意事项
脚本顺序按配置数组顺序执行。如果某脚本返回非零状态码,Composer 会中断后续操作。调试时可用 composer install --verbose
查看详细输出。
基本上就这些,合理使用脚本能极大提升开发自动化程度。
评论(已关闭)
评论已关闭