0

0

Composer中的scripts脚本如何配置与使用?(自动化任务指南)

裘德小鎮的故事

裘德小鎮的故事

发布时间:2025-12-25 16:29:02

|

382人浏览过

|

来源于php中文网

原创

Composer 的 scripts 是项目级自动化任务的核心机制,支持在 composer.json 中定义自定义命令(如 test、cs-fix)和生命周期事件(如 post-install-cmd),可执行 PHP 回调、Shell 命令或组合操作,提升开发效率与流程一致性。

composer中的scripts脚本如何配置与使用?(自动化任务指南)

Composer 的 scripts 是项目级自动化任务的核心机制,它让你用一行命令就能触发 PHP、Shell 或其他工具操作,比如自动加载类、运行测试、生成文档或清理缓存。

composer.json 中定义 scripts

所有脚本都写在 composer.jsonscripts 字段下,格式为 "脚本名": "命令"。支持 PHP 回调、Shell 命令、多命令组合(用 && 连接)。

示例:

"scripts": {
  "post-install-cmd": [
    "@php -r \"echo '安装完成!\\n';\"",
    "php artisan optimize:clear"
  ],
  "test": "vendor/bin/phpunit",
  "cs-fix": "vendor/bin/php-cs-fixer fix --dry-run",
  "dev-start": [
    "@start-server",
    "@watch-assets"
  ],
  "start-server": "php -S localhost:8000 -t public",
  "watch-assets": "npm run watch"
}

注意:@xxx 表示调用另一个脚本,可复用;数组形式支持多个命令顺序执行;事件钩子(如 post-install-cmd)会自动触发。

常用脚本类型:自定义命令 vs 生命周期事件

两类脚本用途不同,别混用:

  • 自定义命令:手动运行,如 composer testcomposer cs-fix,适合开发日常操作
  • 生命周期事件:Composer 自动触发,如 pre-autoload-dumppost-update-cmd,适合维护一致性(如生成 autoload 文件后自动刷新配置)

完整事件列表见 Composer 官方文档,常用钩子包括:post-root-package-install(首次安装)、post-create-project-cmd(用 create-project 初始化后)。

Img.Upscaler
Img.Upscaler

免费的AI图片放大工具

下载

编写可复用的 PHP 脚本(回调函数)

当 Shell 命令不够用时,可写 PHP 类方法作为回调,更可控、易调试。

步骤如下:

  • 新建一个类,比如 scripts/BuildCommand.php
  • 定义静态方法,接收 Composer\Script\Event 对象
  • composer.json 中注册为 "build": "App\\Scripts\\BuildCommand::run"
  • 确保该类能被自动加载(加进 autoload-dev 或使用 files 加载)

示例方法体:

public static function run(Event $event)
{
    $io = $event->getIO();
    $io->write("正在构建前端资源…");
    exec('npm run build 2>&1', $output, $return);
    if ($return !== 0) {
        $io->error("构建失败!");
        return false;
    }
    $io->success("构建完成 ✅");
}

实用技巧与避坑提醒

  • 脚本中尽量用相对路径或 $COMPOSER_HOME 环境变量,避免硬编码绝对路径
  • Windows 下慎用 &&,推荐拆成数组或改用 PowerShell / Bash 子进程
  • 调试脚本加 -v(verbose)参数:如 composer run test -v
  • 想跳过某个事件?加 --no-scripts 参数,比如 composer install --no-scripts
  • 全局脚本不可用 —— Composer 的 scripts 只作用于当前项目,不支持跨项目复用(需靠插件或外部工具)

基本上就这些。合理组织 scripts 能大幅减少重复操作,让团队协作更一致,也更容易把本地流程沉淀为项目标准。

相关专题

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

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

1672

2023.09.01

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

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

1112

2023.10.11

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

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

1015

2023.10.11

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

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

948

2023.10.23

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

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

1396

2023.10.23

html怎么上传
html怎么上传

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

1227

2023.11.03

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

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

1438

2023.11.09

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

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

1302

2023.11.13

苹果官网入口直接访问
苹果官网入口直接访问

苹果官网直接访问入口是https://www.apple.com/cn/,该页面具备0.8秒首屏渲染、HTTP/3与Brotli加速、WebP+AVIF双格式图片、免登录浏览全参数等特性。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

147

2025.12.24

热门下载

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

精品课程

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

共137课时 | 7.8万人学习

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

共6课时 | 6.9万人学习

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

共13课时 | 0.8万人学习

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

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