如何在composer.json中定义和使用scripts脚本?

composer Scripts是在composer.json中定义的自动化脚本,用于在安装、更新等生命周期事件触发时执行php函数或命令。1. 它们通过”scripts”字段配置,支持pre-install-cmd、post-update-cmd等事件;2. 可执行shell命令、PHP回调或类的静态方法,如”echo ‘完成’”或”MyScript::postUpdate”;3. 自定义PHP类需通过autoload机制加载,确保可被调用;4. 脚本可手动运行composer run-script post-update-cmd执行,提升项目自动化效率。

如何在composer.json中定义和使用scripts脚本?

composer.json 中定义和使用 scripts 脚本,可以让你在 Composer 执行某些生命周期事件时自动运行自定义命令。这些脚本常用于自动化项目初始化、代码检查、测试运行、清理缓存等任务。

1. 什么是 Composer Scripts?

Composer 支持在特定操作(如安装、更新、卸载包)前后执行自定义脚本。这些脚本被定义在 composer.json 文件的 “scripts” 字段中。它们不是任意 Shell 命令,而是 php 函数或可执行命令的封装

支持的常见事件包括:

  • pre-install-cmd:执行 install 前触发
  • post-install-cmd:install 完成后触发
  • pre-update-cmd:update 前触发
  • post-update-cmd:update 后触发
  • post-autoload-dump:自动加载生成后触发
  • post-create-project-cmd:项目创建完成后触发(如用 create-project 创建)

2. 如何定义 scripts

composer.json 的根层级添加 “scripts” 键,其值是一个对象,键为事件名,值为要执行的命令或脚本数组。

示例:

{     "name": "your/project",     "require": {         "php": "^8.0"     },     "scripts": {         "post-install-cmd": [             "echo '项目已安装!'",             "php bin/init.php"         ],         "post-update-cmd": [             "echo '依赖已更新!'"         ],         "post-autoload-dump": [             "IlluminateFoundationComposerScripts::postAutoloadDump"         ],         "post-create-project-cmd": [             "php artisan key:generate",             "chmod -R 755 bootstrap/cache"         ]     } } 

说明:

  • 每个事件可以绑定一个字符串字符串数组
  • 数组中的命令会按顺序执行
  • 支持调用类的静态方法(格式:ClassName::methodName),前提是该类能被自动加载
  • 也可以执行外部命令(如 shell 脚本、PHP CLI 脚本等)

3. 自定义脚本函数(PHP 回调)

除了执行命令,你还可以编写自己的 PHP 类来处理逻辑。

如何在composer.json中定义和使用scripts脚本?

百度文心百中

百度大模型语义搜索体验中心

如何在composer.json中定义和使用scripts脚本? 22

查看详情 如何在composer.json中定义和使用scripts脚本?

示例类:

<?php // scripts/MyScript.php class MyScript {     public static function postUpdate($event)     {         $composer = $event->getComposer();         echo "Hello from custom script after update! ";     } } 

然后在 composer.json 中引用:

"scripts": {     "post-update-cmd": [         "MyScript::postUpdate"     ] } 

确保该类能被自动加载,比如通过 files 或 classmap 加载:

"autoload": {     "classmap": ["scripts/"] } 

4. 手动触发脚本

你可以手动运行某个事件的所有脚本:

composer run-script post-update-cmd 

列出所有可用脚本:

composer run-script 

查看某个脚本的具体内容:

composer run-script --list 

基本上就这些。合理使用 scripts 可以极大提升项目的自动化程度,减少重复操作。注意避免在脚本中执行危险操作,尤其是涉及文件删除或权限修改时。

以上就是如何在composer.json中定义和使用scripts脚本?的详细内容,更多请关注php中文网其它相关文章!

上一篇
下一篇
text=ZqhQzanResources