0

0

composer scripts 是什么?如何自定义 composer 命令?

尼克

尼克

发布时间:2025-12-01 17:47:02

|

481人浏览过

|

来源于php中文网

原创

Composer scripts 是 Composer 提供的自动化机制,用于在安装、更新等生命周期执行 PHP 函数或命令。通过在 composer.json 的 scripts 字段定义内置事件(如 post-install-cmd)或自定义脚本(如 hello),可绑定闭包、静态方法或外部命令。例如:"scripts": { "hello": ["php script/hello.php"] },运行 composer run hello 即可触发。PHP 类方法需注册并确保自动加载,如 "greet": "MyScript::hello",配合 autoload.files 加载脚本文件。还可模拟自定义命令,如 setup、clear-cache,实现项目初始化、缓存清理等统一操作,提升开发流程一致性。

composer scripts 是什么?如何自定义 composer 命令?

Composer scripts 是 Composer 提供的一种机制,允许你在特定生命周期事件(如安装、更新、加载时)自动执行 PHP 函数或外部命令。它们通常用于自动化项目初始化、清理缓存、生成文件等任务。你也可以通过自定义脚本创建类似“自定义命令”的功能,虽然 Composer 本身不是命令行工具框架,但能通过 scripts 模拟出命令行为。

composer scripts 是什么?

composer.json 中,scripts 字段定义了一组命名的脚本钩子,这些钩子会在 Composer 执行某些操作时被触发。常见的内置事件包括:

  • post-install-cmd:运行 composer install 后触发
  • post-update-cmd:运行 composer update 后触发
  • pre-autoload-dump:生成自动加载文件前触发
  • post-autoload-dump:自动加载文件生成后触发
  • post-create-project-cmd:使用 create-project 创建项目后触发

你可以绑定这些事件到闭包函数、类的静态方法或外部可执行命令。

如何定义和运行 scripts?

composer.json 中添加 scripts 配置:

{
    "scripts": {
        "post-install-cmd": [
            "echo '项目已安装!'"
        ],
        "hello": [
            "php script/hello.php"
        ]
    }
}

然后运行:

composer run hello

这里的 hello 不是内置事件,而是一个自定义脚本名称,可以通过 composer run 脚本名 手动调用。

如何编写 PHP 函数作为脚本?

你可以定义一个类来处理脚本逻辑:

// scripts/MyScript.php
class MyScript {
    public static function hello($event) {
        $name = $event->getArguments()[0] ?? 'World';
        echo "Hello, $name!\n";
    }
}

在 composer.json 中注册:

{
    "scripts": {
        "greet": "MyScript::hello"
    }
}

确保该文件能被自动加载,或者放在 composer 的 files 自动加载中:

Facet
Facet

Facet.ai是一款AI图像生成和编辑工具,具备实时图像生成和编辑功能

下载
"autoload": {
    "files": ["scripts/MyScript.php"]
}

运行命令:

composer run greet John

输出:Hello, John!

如何模拟自定义 composer 命令?

虽然 Composer 不支持像 Artisan 那样定义完整命令,但你可以把 scripts 当作轻量级命令使用:

  • 命名脚本为动词形式,如 build, clear-cache, setup
  • 指向可执行 PHP 脚本或 shell 脚本
  • 通过 composer run xxx 调用

示例:

{
    "scripts": {
        "setup": "php bin/setup.php",
        "clear-cache": "rm -rf cache/*",
        "test": "phpunit"
    }
}

这样团队成员只需运行:

composer run setup

就能统一执行项目初始化流程。

基本上就这些。Composer scripts 适合轻量自动化,不复杂但容易忽略其灵活性。只要合理组织脚本,就能实现类似“自定义命令”的体验。

相关专题

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

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

2788

2023.09.01

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

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

1686

2023.10.11

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

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

1548

2023.10.11

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

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

1016

2023.10.23

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

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

1485

2023.10.23

html怎么上传
html怎么上传

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

1256

2023.11.03

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

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

1569

2023.11.09

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

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

1307

2023.11.13

菜鸟裹裹入口以及教程汇总
菜鸟裹裹入口以及教程汇总

本专题整合了菜鸟裹裹入口地址及教程分享,阅读专题下面的文章了解更多详细内容。

0

2026.01.22

热门下载

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

精品课程

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

共137课时 | 9.1万人学习

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

共6课时 | 9.9万人学习

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

共13课时 | 0.9万人学习

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

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