Composer脚本在composer.json中的配置方法

浅伟吖_2727

浅伟吖_2727

2026-11-10

506人浏览

原创

scripts字段必须位于composer.json顶层,嵌套在extra、config或子目录中均无效;值支持字符串、数组、关联数组三种写法;生命周期事件名大小写敏感且须拼写准确;生产环境需显式启用脚本执行。

composer脚本在composer.json中的配置方法

scripts字段必须写在composer.json顶层,不能嵌套

Composer只认项目根目录下composer.json最外层的scripts对象。写在extra、config或子目录的composer.json里,完全无效——脚本不会注册,composer run xxx会报Script xxx is not defined。

常见错误包括:

  • 把"scripts": {...}塞进"extra": {...}里
  • 在vendor包自己的composer.json中加scripts,指望它影响主项目
  • 用IDE自动生成配置时,误套了多层JSON结构

正确位置示例:

{
  "name": "my/app",
  "type": "project",
  "scripts": {
    "hello": "echo 'Hi'"
  }
}

脚本值支持字符串、数组、关联数组三种写法

值类型决定执行逻辑和容错能力,选错容易导致命令中途退出或静默失败。

  • 单字符串(如"clear-cache": "php artisan cache:clear"):适合简单命令,但任一环节出错就终止,不继续后续步骤
  • 字符串数组(如"clear-cache": ["php artisan cache:clear", "php artisan config:clear"]):顺序执行,前一条失败后默认仍会执行下一条(除非shell本身用&&连接)
  • 关联数组(如"deploy:check": {"script": "php -r \"exit(extension_loaded('opcache') ? 0 : 1);\"", "description": "Check OPcache is enabled"}):可加description用于composer list展示,也方便CI中做条件判断

注意:@xxx语法只能用于数组内调用其他脚本,比如["@clear-cache", "@migrate"];单独字符串里写@clear-cache会报错。

Expanso yaml-to-json
Expanso yaml-to-json

使用 Expanso Edge 管道将 YAML 输入转换为 JSON 格式。

下载

生命周期事件名必须拼写准确,大小写敏感

Composer对事件名是硬匹配,post-install-cmd少个-、多一个s,或者写成PostInstallCmd,都不会触发。

  • 常用有效事件只有四个真正可用于部署:post-install-cmd、post-update-cmd、post-root-package-install、post-create-project-cmd
  • pre-*类事件一旦失败,整个composer install流程中断,不建议放关键逻辑
  • post-autoload-dump只在dump-autoload时触发,跟文件复制、权限设置等部署动作无关,别指望它清缓存或改目录权限

验证是否生效:加--verbose运行composer install,看到Executing script ...日志才算绑定成功。

生产环境部署时scripts默认不执行,必须显式控制

CI/CD上线时composer install常“看起来成功”,但post-install-cmd根本没跑——因为生产模式默认禁用脚本,尤其当用了--no-dev或--no-scripts时。

  • 安全起见,部署命令应显式启用:composer install --no-dev --optimize-autoloader --no-interaction(默认仍执行post-*)
  • 若担心误触发开发脚本,改用composer run-script deploy:post-install --no-dev,把关键逻辑拆成独立命名脚本
  • 绝对避免在scripts里写sudo chmod或chown——部署用户通常无权提权,且权限应由部署工具(如Ansible)统一管理

最容易被忽略的一点:本地测试用composer install能跑通,不代表上线就能跑;必须在目标环境用相同参数组合实测一次post-install-cmd是否真执行了。

相关文章

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

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

下载

相关标签:

composer脚本 js json composer

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

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2023.12.25

364

5

Composer 安装与快速入门指南
Composer 安装与快速入门指南

面向 PHP 开发新手,详细介绍 Composer 的下载安装方式(本地安装与全局安装)、国内镜像源(阿里云/腾讯云)加速配置、composer.json 与 composer.lock 文件的作用解析、require/install/update 等核心命令的使用方法,帮助开发者快速掌握 PHP 依赖管理的基本工作流。

2026.04.10

623

36

Composer 依赖管理与版本控制实战
Composer 依赖管理与版本控制实战

深入讲解 Composer 的依赖管理机制,涵盖语义化版本号规范、版本约束符(^、~、*、>=)的区别与最佳实践、composer.lock 在团队协作中的锁定策略、依赖冲突的排查与解决方法、require-dev 与生产依赖的分离管理、平台依赖检查(platform-check)等进阶内容,帮助开发者在项目中精准控制依赖版本、避免"依赖地狱"。

2026.04.10

367

29

Composer 自定义包开发与发布教程合集
Composer 自定义包开发与发布教程合集

以实际项目为导向,讲解如何从零创建一个符合规范的 Composer 包,涵盖 composer.json 元信息配置、PSR-4 自动加载规则设置、命名空间规划、单元测试集成、README 与 LICENSE 编写规范,以及将包提交到 Packagist 公共仓库或搭建 Satis/Private Packagist 私有仓库的完整发布流程,帮助开发者将可复用代码封装为标准化的 Composer 包。

2026.04.10

389

15

Composer 自动加载机制与性能优化
Composer 自动加载机制与性能优化

系统剖析 Composer 的自动加载体系,讲解 PSR-0 与 PSR-4 自动加载标准的区别与演进、classmap 与 files 加载方式的适用场景、autoload_real.php 源码级加载流程解析,同时介绍 composer dump-autoload -o 优化加载映射、APCu 缓存加速、authoritative-classmap 配置等生产环境性能优化手段,帮助开发者深入理解自动加载原理并提升项目启动速度。

2026.04.13

340

21

Composer 在主流 PHP 框架中的应用实践
Composer 在主流 PHP 框架中的应用实践

结合 Laravel、ThinkPHP、Symfony 等主流 PHP 框架的实际场景,讲解 Composer 在框架项目中的典型应用,包括通过 create-project 初始化框架项目、安装与管理第三方扩展包、scripts 钩子(post-install/post-update)自动执行部署任务、自定义 Installer 插件开发、多项目共享 vendor 依赖的 Monorepo 工作流管理,帮助开发者在真实框架项目中充分发

2026.04.13

543

14

Composer 镜像源配置与网络问题排查
Composer 镜像源配置与网络问题排查

针对国内开发者常遇到的 Composer 网络问题,详细讲解阿里云、腾讯云、华为云等国内镜像源的全局与项目级切换方法、多镜像源优先级配置策略、composer config 命令行快速设置技巧,同时涵盖 SSL 证书错误、连接超时、下载中断等常见网络报错的排查与修复方案,以及利用 artifact / path 仓库实现完全离线环境下的依赖安装。

2026.04.14

351

24

Composer Scripts 脚本与自动化工作流
Composer Scripts 脚本与自动化工作流

系统讲解 Composer Scripts 机制的完整用法,涵盖 pre-install、post-update、post-autoload-dump 等内置事件钩子的触发时机与应用场景、自定义脚本命令的定义与参数传递、调用外部 Shell 命令与 PHP 静态方法、多脚本串联执行与条件判断,以及结合代码检查(PHPStan/PHP-CS-Fixer)、数据库迁移、缓存清理等任务构建一键部署自动化工作流。

2026.04.14

430

18

Composer 私有仓库搭建与企业级管理
Composer 私有仓库搭建与企业级管理

面向团队与企业开发场景,讲解如何使用 Satis 搭建轻量级静态私有仓库、通过 Toran Proxy / Private Packagist 构建功能完善的企业级私有包管理平台,涵盖 Git/SVN 仓库类型接入、Token 鉴权与访问权限控制、Webhook 自动触发包更新、内网部署方案以及与 GitLab CI/CD 流水线的集成配置,帮助企业安全高效地管理内部 PHP 组件资产。

2026.04.14

460

26

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21.3万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习