0

0

composer中的scripts脚本怎么编写和使用

穿越時空

穿越時空

发布时间:2025-10-03 20:14:02

|

863人浏览过

|

来源于php中文网

原创

Composer scripts可在特定生命周期自动执行任务,如数据库迁移、缓存清理;通过composer.json的"scripts"配置,支持命令行或PHP方法调用,可自定义脚本并通过composer run执行,需注意事件时机与执行上下文。

composer中的scripts脚本怎么编写和使用

在 Composer 中,scripts 是一种强大的功能,允许你在特定生命周期事件(如安装、更新、卸载等)触发时自动执行自定义脚本。这些脚本可以是 PHP 脚本、命令行指令或外部程序。

scripts 的作用和常见场景

Composer 的 scripts 主要用于自动化项目中的常规任务。典型用途包括:

  • 自动执行数据库迁移
  • 清理缓存文件
  • 生成代码或配置文件
  • 运行测试或静态分析工具
  • 通知构建完成

如何编写 scripts

scripts 定义在项目的 composer.json 文件中,通过 "scripts" 键来配置。每个脚本对应一个事件名,值是一个命令数组。

示例:基本 scripts 配置
{
  "scripts": {
    "post-install-cmd": [
      "php artisan clear-compiled",
      "php artisan optimize"
    ],
    "post-update-cmd": [
      "php artisan migrate --force",
      "php artisan config:cache"
    ],
    "pre-update-cmd": [
      "echo '即将开始更新依赖'"
    ]
  }
}

支持的常用事件包括:

  • pre-install-cmd:install 命令执行前
  • post-install-cmd:install 命令执行后
  • pre-update-cmd:update 命令执行前
  • post-update-cmd:update 命令执行后
  • post-autoload-dump:自动加载重建后
  • post-create-project-cmd:项目创建完成后

使用 PHP 类方法作为脚本

除了命令行语句,你还可以调用 PHP 类的静态方法。这类方法必须接受一个 Composer\Script\Event 参数。

示例:定义类方法脚本
{
  "scripts": {
    "post-update-cmd": "App\\Console\\ComposerScripts::postUpdate"
  }
}

对应的 PHP 类文件:

namespace App\Console;

use Composer\Script\Event;

class ComposerScripts
{
    public static function postUpdate(Event $event)
    {
        echo "依赖已更新,正在执行清理...\n";
        // 执行一些逻辑,比如删除临时文件
        if (is_dir('bootstrap/cache')) {
            unlink('bootstrap/cache/config.php');
        }
    }
}

确保该类能被自动加载(通常放在 composer autoload 路径中)。

mPDF
mPDF

mPDF是一个PHP库,可以从UTF-8编码的HTML生成PDF文件。原作者Ian Back编写mPDF以从他的网站上“即时”输出PDF文件,并处理不同的语言。与原始脚本如HTML2FPDF相比,它的速度较慢,并且在使用Unicode字体时生成的文件较大,但支持CSS样式等,并进行了大量增强。支持几乎所有语言,包括RTL(阿拉伯语和希伯来语)和CJK(中日韩)。支持嵌套的块级元素(如P、DIV),包括边距、边框、填充、行高、背景颜色等。支持从右到左的语言,并自动检测文档中的RTL字符。转置表格、列表、文本

下载

自定义脚本并手动运行

你可以定义自己的脚本名称,并通过 composer run 来执行。

{
  "scripts": {
    "clear-cache": [
      "php artisan cache:clear",
      "php artisan route:clear"
    ],
    "build": [
      "@composer install",
      "@composer run clear-cache",
      "echo '构建完成'"
    ]
  }
}

运行方式:

composer run clear-cache

或者链式执行:

composer run build

注意:@composer 可以在脚本中调用其他 Composer 命令。

注意事项和最佳实践

  • 脚本按顺序执行,遇到错误默认会停止(除非命令用 || true 忽略错误)
  • 生产环境中避免运行耗时或交互式脚本
  • 尽量使用相对路径或环境变量保证可移植性
  • 调试脚本时可加 -v 参数查看详细输出:composer install -v

基本上就这些。合理使用 Composer scripts 能显著提升项目自动化程度,减少重复操作。关键是根据项目流程设计合适的钩子和命令。不复杂但容易忽略的是事件触发时机和脚本执行上下文。

相关专题

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

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

2773

2023.09.01

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

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

1679

2023.10.11

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

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

1538

2023.10.11

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

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

1015

2023.10.23

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

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

1464

2023.10.23

html怎么上传
html怎么上传

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

1235

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

Golang 性能分析与pprof调优实战
Golang 性能分析与pprof调优实战

本专题系统讲解 Golang 应用的性能分析与调优方法,重点覆盖 pprof 的使用方式,包括 CPU、内存、阻塞与 goroutine 分析,火焰图解读,常见性能瓶颈定位思路,以及在真实项目中进行针对性优化的实践技巧。通过案例讲解,帮助开发者掌握 用数据驱动的方式持续提升 Go 程序性能与稳定性。

6

2026.01.22

热门下载

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

相关下载

更多

精品课程

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

共137课时 | 9.1万人学习

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

共6课时 | 9.6万人学习

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

共13课时 | 0.9万人学习

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

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