讲师中心 微信公众号

工具推荐

视频效率加速
AniShort
AniShort

AI短剧协同制作平台

updream

一键生成高质量推广成片

剧云
剧云

中文短剧剧本制作平台

Seko
Seko

AI短剧一键生成成片

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

夜晨姑娘_7984

夜晨姑娘_7984

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

|

576人浏览过

|

来源于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-cmd 或 pre-update-dump,也可以通过 scripts 定义自定义命令供开发者手动调用。

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

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

{
    "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 还支持多种内置事件,可以在对应阶段自动触发脚本:

Expanso yaml-to-json
Expanso yaml-to-json

使用 Expanso Edge 管道将 YAML 输入转换为 JSON 格式。

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

示例:

"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:
<?php
class BuildScript
{
    public static function build($event)
    {
        $composer = $event->getComposer();
        $io = $event->getIO();
        $io->write("<info>开始构建项目...</info>");
        
        // 可以读取配置、操作文件等
        if (file_put_contents('build.lock', date('Y-m-d H:i:s'))) {
            $io->write("构建标记已生成。");
        }
    }
}
  1. 在 composer.json 中注册该类:
"scripts": {
    "build": "BuildScript::build"
}
  1. 确保该文件能被自动加载,可通过 files 或 classmap 加载:
"autoload": {
    "classmap": ["scripts/"]
}

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

常用技巧和注意事项

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

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

热门AI工具

更多
PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

码上飞
码上飞 Hot

一款基于自然语言的AI应用开发平台,可根据用户描述自动生成应用程序,帮助个人和团队快速完成应用原型与开发。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

相关专题

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

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

897

2024.04.09

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

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

875

2024.04.09

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

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

2528

2024.04.09

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

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

4961

2024.04.10

laravel入门教程
laravel入门教程

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

7290

2025.08.05

laravel实战教程
laravel实战教程

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

4776

2025.08.05

laravel面试题
laravel面试题

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

8969

2025.08.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

1536

2026.03.04

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

80

2026.11.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn