0

0

composer scripts脚本怎么编写和使用_Composer Scripts脚本编写与使用方法

尼克

尼克

发布时间:2025-09-28 19:21:01

|

222人浏览过

|

来源于php中文网

原创

Composer Scripts 是在 composer.json 中定义的自动化钩子,用于在安装、更新等事件前后执行 PHP 函数或命令行脚本,支持闭包、类方法和外部命令,可实现项目初始化、缓存清理等任务,提升开发效率。

composer scripts脚本怎么编写和使用_composer scripts脚本编写与使用方法

Composer Scripts 是 Composer 提供的一个强大功能,允许你在 Composer 执行某些生命周期事件时自动运行自定义脚本。这些脚本可以是 PHP 函数、命令行指令或外部脚本文件,常用于自动化项目初始化、测试、构建、部署等任务。

什么是 Composer Scripts

Composer Scripts 是在 composer.json 文件中通过 "scripts" 字段定义的钩子函数。它们会在特定的 Composer 命令执行前后被触发,例如安装依赖(install)、更新包(update)或自动加载生成后。

常见的内置事件包括:

  • 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 创建项目后运行

如何编写 Composer 脚本

脚本支持三种类型:闭包函数、类静态方法、可执行命令。

1. 使用闭包函数(推荐用于简单逻辑)

composer.json 中注册闭包:

"scripts": {
    "post-install-cmd": [
        "echo '安装完成!'"
    ]
}

更复杂的逻辑可以用 PHP 闭包(需放在独立的文件中并通过 autoload 加载):

"scripts": {
    "post-install-cmd": [
        "My\\Scripts::onPostInstall"
    ]
}

然后创建对应的 PHP 类文件:

getIO();
        $io->write("恭喜,项目已成功安装!");
    }
}

2. 使用外部命令(如 shell 脚本、Node.js 等)

你可以调用系统命令或脚本:

万兴爱画
万兴爱画

万兴爱画AI绘画生成工具

下载
"scripts": {
    "post-update-cmd": "php artisan optimize",
    "post-create-project-cmd": [
        "chmod -R 755 bootstrap/cache",
        "npm install && npm run build"
    ]
}

3. 定义自定义脚本命令

除了监听内置事件,你也可以定义自己的脚本别名:

"scripts": {
    "dev-setup": [
        "composer install",
        "php artisan key:generate",
        "php artisan migrate --seed"
    ],
    "build": "npm run production"
}

然后通过以下方式运行:

composer run dev-setup
composer run build

脚本使用技巧与注意事项

编写和使用脚本时需要注意以下几点:

  • 确保脚本路径正确,特别是引用 PHP 类时要能被自动加载(建议将脚本类放在 scripts/app/Console 目录并配置 autoload)
  • 多行命令用数组形式列出,按顺序执行
  • 脚本失败会中断 Composer 流程,除非使用 || true 忽略错误
  • 调试脚本时可加 -v 参数查看详细输出:composer install -v
  • 避免在脚本中阻塞用户输入,除非明确需要交互

示例:结合 Laravel 项目的常见脚本配置

{
    "scripts": {
        "post-autoload-dump": "Illuminate\\Foundation\\ComposerScripts::postAutoloadDump",
        "post-create-project-cmd": [
            "php -r \"file_exists('.env') || copy('.env.example', '.env');\"",
            "php artisan key:generate"
        ],
        "post-update-cmd": [
            "php artisan config:clear",
            "php artisan route:clear"
        ],
        "test": "phpunit"
    }
}

这样就可以在每次更新依赖后自动清理缓存,提升开发效率。

基本上就这些。Composer Scripts 让项目初始化和维护变得更自动化,合理使用能显著减少重复操作。关键是写清楚脚本逻辑,并确保跨平台兼容性(比如 Windows 和 Linux 路径差异)。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

320

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

278

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

373

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

374

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

86

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

67

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

68

2025.08.05

composer是什么插件
composer是什么插件

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

154

2023.12.25

C++ 设计模式与软件架构
C++ 设计模式与软件架构

本专题深入讲解 C++ 中的常见设计模式与架构优化,包括单例模式、工厂模式、观察者模式、策略模式、命令模式等,结合实际案例展示如何在 C++ 项目中应用这些模式提升代码可维护性与扩展性。通过案例分析,帮助开发者掌握 如何运用设计模式构建高质量的软件架构,提升系统的灵活性与可扩展性。

14

2026.01.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二十四期_PHP8编程
第二十四期_PHP8编程

共86课时 | 3.4万人学习

成为PHP架构师-自制PHP框架
成为PHP架构师-自制PHP框架

共28课时 | 2.5万人学习

第二十三期_PHP编程
第二十三期_PHP编程

共93课时 | 6.9万人学习

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

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