CodeIgniter4 CLI命令开发指南：创建自定义Spark命令-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00526/article/details/148490904

CodeIgniter4 CLI命令开发指南：创建自定义Spark命令

CodeIgniter4 Open Source PHP Framework (originally from EllisLab) 项目地址: https://gitcode.com/gh_mirrors/co/CodeIgniter4

什么是Spark命令

在CodeIgniter4框架中，Spark命令是一种强大的命令行工具开发方式。与常规控制器不同，Spark命令专为命令行环境设计，无需定义路由即可直接使用。这种特性使其成为开发辅助工具的理想选择，例如：

数据库迁移和种子数据填充
定时任务状态检查
自定义代码生成器
系统维护和监控工具
批量数据处理任务

Spark命令继承了CodeIgniter的全部功能，可以访问框架的所有组件和服务，同时提供了专门的CLI交互方法。

创建新命令的基本步骤

1. 命令类结构

每个Spark命令都是一个独立的类，必须满足以下要求：

<?php

namespace App\Commands;

use CodeIgniter\CLI\BaseCommand;

class MyCommand extends BaseCommand
{
    // 必须实现的run方法
    public function run(array $params)
    {
        // 命令逻辑
    }
}

2. 命令元数据属性

为了使命令能够被正确识别和使用，需要定义以下属性：

protected $group = 'Demo';          // 命令分组
protected $name = 'demo:info';      // 命令名称(使用冒号分隔层级)
protected $description = '显示应用基础信息'; // 命令描述
protected $usage = 'demo:info [options]'; // 使用说明
protected $arguments = [            // 参数说明
    'name' => '要显示的信息类型'
];
protected $options = [              // 选项说明
    '--format' => '输出格式(json/text)'
];

这些元数据会被自动用于生成帮助信息，当用户执行php spark help demo:info时就会显示这些信息。

命令文件位置规范

CodeIgniter4遵循PSR-4自动加载规范，命令类文件应放置在以下位置之一：

app/Commands/ - 应用专用命令
自定义命名空间下的Commands目录 - 跨项目共享命令

例如，公司级别的共享命令可以放在Acme/Commands目录下。

完整示例：应用信息命令

让我们创建一个完整的示例命令，用于显示应用基本信息：

<?php

namespace App\Commands;

use CodeIgniter\CLI\BaseCommand;

class AppInfo extends BaseCommand
{
    protected $group = 'Demo';
    protected $name = 'app:info';
    protected $description = '显示CodeIgniter应用基础信息';
    
    public function run(array $params)
    {
        $this->cli->write('应用名称: '. config('App')->appName);
        $this->cli->write('环境: '. ENVIRONMENT);
        $this->cli->write('基准URL: '. config('App')->baseURL);
        $this->cli->write('时区: '. config('App')->appTimezone);
        
        return EXIT_SUCCESS;
    }
}

使用方式：

php spark app:info

命令参数处理

Spark命令可以接收参数和选项：

public function run(array $params)
{
    // 处理参数
    $name = $params[0] ?? 'default';
    
    // 处理选项
    $force = $this->cli->getOption('force');
    
    // 业务逻辑...
}

调用示例：

php spark user:create admin --force

命令终止与错误处理

命令应返回适当的退出码：

public function run(array $params)
{
    try {
        // 业务逻辑...
        return EXIT_SUCCESS; // 成功
    } catch (\Exception $e) {
        $this->showError($e);
        return EXIT_ERROR; // 失败
    }
}

CodeIgniter4提供了以下标准退出码常量：