0

0

如何让Composer在安装包之后自动执行清理工作?(脚本配置)

穿越時空

穿越時空

发布时间:2026-01-09 14:53:02

|

260人浏览过

|

来源于php中文网

原创

Composer 无内置自动清理机制,但可通过配置 post-install-cmd 或 post-update-cmd 脚本实现:支持 shell 命令、PHP 回调或自定义类方法,推荐幂等的内联 PHP 脚本或 ScriptHandler 类,也可开发插件精细控制;需避免误删核心文件、注意跨平台兼容性及错误处理。

如何让composer在安装包之后自动执行清理工作?(脚本配置)

Composer 本身不提供“安装后自动清理”的内置机制,但可以通过配置 scripts 钩子,在包安装完成(post-install-cmd)或更新完成(post-update-cmd)时触发自定义清理逻辑。

composer.json 中定义 post-install-cmd 脚本

这是最常用的方式。你可以在项目根目录的 composer.json 文件中添加脚本,让 Composer 在每次 composer install 执行完毕后运行清理命令。

  • 支持 shell 命令、PHP 回调函数或可执行脚本文件
  • 推荐使用内联 PHP 脚本,便于跨平台且无需额外依赖
  • 确保脚本具备幂等性(重复执行无副作用)

示例:清理 vendor/bin 下的冗余软链接和临时文件

(将以下内容加入 composer.json"scripts" 字段)
"scripts": {
  "post-install-cmd": [
    "@php -r \"array_map('unlink', glob('vendor/bin/*.bat'));\"",
    "@php -r \"array_map('unlink', glob('vendor/bin/*~'));\"",
    "@php -r \"if (is_dir('vendor/composer/installed.json')) { unlink('vendor/composer/installed.json'); }\""
  ]
}

使用自定义 PHP 类方法作为钩子

适合较复杂的清理逻辑,比如扫描特定目录、删除过期缓存、校验文件完整性等。

  • 创建一个类(如 ScriptHandler),放在 scripts/src/ 目录下
  • composer.json 中引用该类的静态方法
  • 方法接收 Composer\Script\Event 对象,可获取 IO、Composer 实例等上下文

示例:

Speech Studio
Speech Studio

微软语音服务,提供语音到文本、文本到语音和语音翻译功能。

下载
"scripts": {
  "post-install-cmd": [
    "MyVendor\\MyPackage\\ScriptHandler::cleanupVendorBin"
  ]
}

对应 PHP 类(需确保自动加载已配置):

namespace MyVendor\MyPackage;
use Composer\Script\Event;

class ScriptHandler
{
    public static function cleanupVendorBin(Event $event)
    {
        $io = $event->getIO();
        $vendorBin = __DIR__ . '/../vendor/bin';
        if (is_dir($vendorBin)) {
            foreach (glob($vendorBin . '/*.sh') as $file) {
                @unlink($file);
            }
        }
        $io->write("✓ 清理 vendor/bin 中的 shell 脚本完成");
    }
}

结合 Composer 插件实现更精细控制

如果清理逻辑需要深度介入 Composer 生命周期(例如只清理某类包、跳过开发依赖),可考虑编写轻量插件。

  • 插件可监听 PostInstallEventPostUpdateEvent
  • 通过 $event->getComposer()->getPackage() 获取当前安装的包信息
  • 适合构建工具链或团队统一规范场景

注意:插件需声明为 composer-plugin 类型,并在 composer.json 中启用。

避免常见陷阱

脚本看似简单,但容易引发意外问题:

  • 不要在清理中误删 vendor/autoload.php 或核心 bin 文件(如 vendor/bin/phpunit
  • Windows 下慎用 rm -rf,优先用 PHP 内置函数(unlinkrmdirarray_map
  • 若脚本失败(返回非零退出码),整个 composer install 会中断;加 @ 抑制错误或显式 return 0; 可规避
  • CI 环境中建议加上日志输出(用 $event->getIO()->write()),方便排查

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2307

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1518

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1411

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

951

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1413

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1233

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1444

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1304

2023.11.13

c++主流开发框架汇总
c++主流开发框架汇总

本专题整合了c++开发框架推荐,阅读专题下面的文章了解更多详细内容。

3

2026.01.09

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 8.5万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 6.9万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号