0

0

composer scripts 使用详解:如何定义自己的命令脚本?

冰火之心

冰火之心

发布时间:2025-11-23 17:30:59

|

556人浏览过

|

来源于php中文网

原创

Composer Scripts 是 composer.json 中定义的自定义脚本或事件钩子,用于在特定生命周期执行命令。例如 "hello" 是自定义命令,运行 composer run hello 输出 Hello World;"build" 为复合脚本,依次执行 composer install --optimize-autoloader 和 php bin/build.php;"test" 调用 PHPUnit。支持事件如 post-install-cmd(安装后清除缓存)、post-update-cmd(更新后检查代码)等。还可通过 PHP 类处理复杂逻辑,如 BuildScript::build 在 build 时生成构建标记。需确保脚本可加载且命令在 PATH 中,推荐使用 composer run 执行脚本,提升自动化效率。

composer scripts 使用详解:如何定义自己的命令脚本?

在使用 Composer 管理 PHP 项目时,scripts 是一个非常实用的功能。它允许你在 Composer 执行特定生命周期事件时运行自定义脚本,比如安装依赖后自动执行某些操作,或者定义可调用的命令来简化开发流程。

什么是 Composer Scripts?

Composer 支持在 composer.json 中定义 scripts(脚本),这些脚本可以是 PHP 脚本、命令行指令,也可以是外部脚本文件。它们通常与 Composer 的事件挂钩,例如 post-install-cmdpre-update-dump,也可以通过 scripts 定义自定义命令供开发者手动调用。

如何定义自定义命令脚本?

你可以通过在 composer.jsonscripts 字段中添加条目来定义自己的命令。下面是一个常见结构:

{
    "scripts": {
        "hello": "echo 'Hello, World!'",
        "build": [
            "@composer install --optimize-autoloader",
            "php bin/build.php"
        ],
        "test": "phpunit"
    }
}

在这个例子中:

  • hello 是一个简单的自定义命令,运行 composer hello 就会输出 Hello, World!
  • build 是一个复合脚本,包含多个命令,按顺序执行。其中 @composer 表示调用 Composer 自身的命令。
  • test 直接调用 PHPUnit 测试工具

支持的事件类型

除了自定义命名命令,Composer 还支持多种内置事件,可以在对应阶段自动触发脚本:

  • pre-install-cmd:在 install 命令执行前运行
  • post-install-cmd:在 install 后运行(常用于生成 autoload 文件或清除缓存)
  • pre-update-cmd:更新前执行
  • post-update-cmd:更新依赖后执行
  • post-autoload-dump:自动加载器生成后执行,适合重新生成缓存
  • post-create-project-cmd:项目创建完成后运行(如 Laravel 安装后设置密钥)

示例:

文心大模型
文心大模型

百度飞桨-文心大模型 ERNIE 3.0 文本理解与创作

下载
"scripts": {
    "post-install-cmd": [
        "php artisan optimize",
        "chmod -R 755 bootstrap/cache"
    ],
    "post-update-cmd": "php bin/check-codes.php"
}

编写 PHP 脚本类(更高级用法)

如果你需要更复杂的逻辑,可以编写 PHP 类来处理脚本。Composer 支持调用静态方法作为脚本处理器

步骤如下:

  1. 创建一个 PHP 类文件,例如 scripts/BuildScript.php
getComposer();
        $io = $event->getIO();
        $io->write("开始构建项目...");
        
        // 可以读取配置、操作文件等
        if (file_put_contents('build.lock', date('Y-m-d H:i:s'))) {
            $io->write("构建标记已生成。");
        }
    }
}
  1. composer.json 中注册该类:
"scripts": {
    "build": "BuildScript::build"
}
  1. 确保该文件能被自动加载,可通过 filesclassmap 加载:
"autoload": {
    "classmap": ["scripts/"]
}

然后运行 composer dump-autoload 更新自动加载映射。

常用技巧和注意事项

  • 脚本支持数组形式,按顺序执行,推荐将相关命令组合在一起。
  • 使用 @composer 可以调用其他 Composer 脚本或命令,避免重复路径问题。
  • 脚本中的命令必须在系统 PATH 中可用,否则需指定完整路径。
  • 调试脚本时,可加上 -v 参数查看详细输出:composer run hello -v
  • 从 Composer 2.0 开始,推荐使用 run 命令来执行自定义脚本:composer run build

基本上就这些。合理使用 Composer scripts 能极大提升项目自动化程度,减少重复操作。关键是根据项目需求设计清晰的脚本结构,避免过度复杂化。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

2918

2023.09.01

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

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

1740

2023.10.11

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

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

1568

2023.10.11

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

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

1120

2023.10.23

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

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

1566

2023.10.23

html怎么上传
html怎么上传

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

1297

2023.11.03

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

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

1689

2023.11.09

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

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

1310

2023.11.13

Python 自然语言处理(NLP)基础与实战
Python 自然语言处理(NLP)基础与实战

本专题系统讲解 Python 在自然语言处理(NLP)领域的基础方法与实战应用,涵盖文本预处理(分词、去停用词)、词性标注、命名实体识别、关键词提取、情感分析,以及常用 NLP 库(NLTK、spaCy)的核心用法。通过真实文本案例,帮助学习者掌握 使用 Python 进行文本分析与语言数据处理的完整流程,适用于内容分析、舆情监测与智能文本应用场景。

9

2026.01.27

热门下载

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

精品课程

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

共137课时 | 9.7万人学习

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

共6课时 | 11.2万人学习

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

共13课时 | 0.9万人学习

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

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