Composer如何配置pre-install-cmd钩子_Composer pre-install-cmd钩子配置详解

浅丽小哥_7885

浅丽小哥_7885

2026-04-11

1031人浏览

原创

pre-install-cmd 是 Composer 在真正执行依赖安装前触发的生命周期钩子,仅当 vendor 不存在或 composer.lock 变更时运行;需置于 composer.json 顶层 scripts 下、值为数组,且不启用 --no-scripts 才生效。

composer如何配置pre-install-cmd钩子_composer pre-install-cmd钩子配置详解

pre-install-cmd 是什么,它到底在什么时候执行

pre-install-cmd 是 Composer 内置的生命周期事件钩子,不是命令也不是插件,它会在 composer install 命令真正开始解析依赖、下载或解包前触发——但仅当本次 install 实际要执行安装动作时才运行。如果 vendor/ 已存在且 composer.lock 未变更,Composer 会跳过整个安装流程,连 pre-install-cmd 都不会执行。

  • 它不等同于“每次敲下 composer install 就跑”,而是“每次真正装包前才跑”
  • 触发前提是:没加 --no-scripts,Composer 版本 ≥ 1.10(推荐 ≥ 2.2)
  • 它和 pre-update-cmd 是对称设计,但两者触发条件不同:pre-install-cmd 关注 vendor 是否缺失/lock 是否变化;pre-update-cmd 只要看 lock 是否需重算
  • 常见误判场景:本地反复运行 composer install,输出里没看到脚本执行日志 → 其实是被 Composer 静默跳过了,不是配置失效

怎么写才有效:scripts 字段位置和值格式要求

pre-install-cmd 必须直接写在项目根目录 composer.json 的顶层 scripts 字段下,和 autoload、require 同级;不能塞进 extra、config 或任何嵌套对象里。

  • 值必须是数组(从 Composer 5.6+ 起强制要求),例如:["php scripts/check-php-version.php", "@php -r "echo 'pre-install OK\n';""]
  • 字符串单值写法(如 "php check.php")会被静默忽略,不报错也不执行
  • 数组中每项顺序执行;任意一项 exit code ≠ 0,后续全部中止,composer install 整体失败退出
  • 以 @ 开头的命令(如 @php)由 Composer 自行解析为当前 PHP 可执行路径,比硬写 php 更可靠,尤其在多 PHP 版本环境

为什么脚本没运行?常见失效原因和验证方法

最常被忽略的是“根本没走到触发点”,而不是配置写错了。先确认是否真该触发,再查配置。

Academic Composer Upload
Academic Composer Upload

辅助学术写作,包括查找资料、生成大纲、引用扩写及润色风格,同时确保引用规范。

下载
  • 运行 composer install -v,观察输出里有没有 Executing script 行;没有就说明跳过了整个流程
  • 检查是否启用了 --no-scripts,或设置了环境变量 COMPOSER_NO_INTERACTION=1(某些 CI 环境默认启用)
  • 脚本里调用的 PHP 类(如 MyToolChecker::run)必须能被自动加载——即类文件已在 autoload 中声明,否则报 Class not found 且无明确提示
  • 拼写错误:写成 pre-install、preinstall-cmd、post-install-cmd 都不会触发;必须严格匹配 pre-install-cmd
  • Windows 下路径分隔符写死为 可能导致脚本找不到文件;统一用 / 或 DIRECTORY_SEPARATOR

适合放什么逻辑?别踩的典型坑

pre-install-cmd 的定位是“前置校验与准备”,不是部署或生成任务。它的执行时机早于 autoload 生成、vendor 解包,所以不能依赖 vendor/autoload.php,也不能假设 config/ 或 storage/ 目录已存在。

  • 适合做:PHP 版本/扩展检查、环境变量是否存在、.env 文件模板复制、清理旧缓存目录(如 rm -rf bootstrap/cache/*)
  • 不适合做:调用 php artisan migrate(Laravel 命令依赖 autoload)、生成前端资源(此时 node_modules 可能还没装)、写入数据库
  • 如果脚本本身需要 Composer 自动加载能力,必须手动引入:require __DIR__ . '/vendor/autoload.php'; ——但注意:此时 vendor/ 可能还不存在或不完整,风险高
  • CI/CD 流水线里慎用耗时操作(如下载远程配置),它卡在 install 最前面,会拖慢整个构建链路

实际生效的关键不在“写得有多全”,而在于理解 Composer 的跳过逻辑——它宁可不跑,也不愿重复跑。很多团队以为钩子失效,其实是自己没触发它的前提条件。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

composer

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2024.04.09

877

10

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

2024.04.09

855

9

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2024.04.09

2508

10

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.10

4581

7

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

2025.08.05

6670

22

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

2025.08.05

4396

13

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

2025.08.05

8229

7

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

2026.03.04

1516

29

Laravel 框架安装指南
Laravel 框架安装指南

本指南详解 Laravel 框架安装全流程,涵盖 PHP 8.1+ 环境配置、Composer 依赖管理工具安装及国内镜像源优化。重点演示使用 composer create-project 命令创建 Laravel 10/11 项目,解决常见安装错误与依赖冲突。从环境搭建到项目初始化,助您快速完成 Laravel 开发环境部署,为后续 Web 应用开发奠定基础。适合 PHP 初学者与框架迁移开发者参考。

2026.04.09

215

6

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpMyAdmin 安装文档
phpMyAdmin 安装文档

共0课时 | 0人学习

phpEnv手册
phpEnv手册

共0课时 | 0人学习