Consolidation/Robo 项目入门指南：PHP 任务自动化利器-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01174/article/details/148784057

Consolidation/Robo 项目入门指南：PHP 任务自动化利器

robo Modern task runner for PHP 项目地址: https://gitcode.com/gh_mirrors/ro/robo

项目概述

Consolidation/Robo 是一个现代化的 PHP 任务运行器和自动化工具，它允许开发者通过简单的 PHP 类和方法来定义复杂的自动化任务。与传统的 shell 脚本或 Makefile 不同，Robo 提供了完整的 PHP 环境，让开发者能够利用熟悉的 PHP 语法和丰富的生态系统来完成各种自动化工作。

环境准备

在开始使用 Robo 之前，请确保您的系统满足以下要求：

PHP 7.2 或更高版本
Composer 工具（用于依赖管理）
基本的 PHP 开发知识

初始化项目

要开始使用 Robo，首先需要在项目目录中创建 RoboFile：

cd myproject
robo init

这个命令会在当前目录下生成一个 RoboFile.php 文件，其中包含一个基础类结构：

<?php
class RoboFile extends \Robo\Tasks
{
    // 这里将添加您的自定义命令
}

命令基础

在 Robo 中，每个公共方法都被视为一个可执行的命令。让我们创建一个简单的示例：

public function greet(ConsoleIO $io, $name = 'World')
{
    $io->say("Hello, $name!");
}

执行这个命令非常简单：

robo greet
# 输出: Hello, World!

robo greet PHP开发者
# 输出: Hello, PHP开发者!

命令命名规则

Robo 会自动转换方法名为更友好的命令行格式：

camelCase 方法 → camel:case 命令
longCamelCase 方法 → long:camel-case 命令

参数处理

必需参数

没有默认值的参数会被视为必需参数：

public function deploy(ConsoleIO $io, $environment)
{
    $io->say("部署到 $environment 环境");
}

可选参数

带默认值的参数会成为可选参数：

public function deploy(ConsoleIO $io, $environment = 'production')
{
    $io->say("部署到 $environment 环境");
}

可变参数

使用数组类型提示可以接受多个参数：

public function deploy(ConsoleIO $io, array $servers)
{
    $io->say("部署到服务器: " . implode(', ', $servers));
}

选项配置

选项通过关联数组定义，其中键是选项名，值是默认值：

public function build(ConsoleIO $io, $opts = ['minify' => false, 'sourcemap' => true])
{
    if ($opts['minify']) {
        $io->say("启用代码压缩");
    }
    // ...
}

使用方式：

robo build --minify

可以为选项添加简写形式：

$opts = ['minify|m' => false]

任务系统

Robo 的核心是它的任务系统，允许将复杂操作分解为可重用的组件。

基本任务示例

public function testAll(ConsoleIO $io)
{
    $this->taskExec('phpunit')
        ->arg('tests/unit')
        ->run();
    
    $this->taskExec('phpunit')
        ->arg('tests/integration')
        ->run();
}

任务结果处理

每个任务都应返回一个 Robo\Result 对象：

public function compileAssets(ConsoleIO $io)
{
    $result = $this->taskExec('webpack')->run();
    
    if ($result->wasSuccessful()) {
        $io->success("资源编译成功");
    } else {
        $io->error("资源编译失败");
    }
    
    return $result;
}

配置管理

Robo 支持通过多种方式配置任务：

robo.yml 文件：可以放在项目目录或用户主目录
环境变量：以 ROBO_ 开头
命令行参数：使用 -D 选项

配置示例

在 robo.yml 中：

command:
  deploy:
    options:
      environment: staging

或者在代码中设置默认值：

public function __construct()
{
    \Robo\Task\Remote\Ssh::configure('remoteDir', '/var/www');
}

高级特性

进度指示器

对于长时间运行的任务，可以添加进度显示：

public function processFiles(ConsoleIO $io)
{
    $this->startProgressIndicator();
    // 处理文件...
    $this->advanceProgressIndicator();
    // 更多处理...
    $this->stopProgressIndicator();
}

错误处理

使用 stopOnFail 可以在任务失败时立即停止：

public function buildAll(ConsoleIO $io)
{
    $this->stopOnFail(true);
    
    $this->taskExec('composer install')->run();
    $this->taskExec('npm install')->run();
    // 如果前面任何任务失败，这里不会执行
    $this->taskExec('webpack')->run();
}