CodeIgniter4 CLI控制器使用指南：从浏览器到命令行的无缝切换

CodeIgniter4 CLI控制器使用指南：从浏览器到命令行的无缝切换

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

前言

在Web开发中，我们通常通过浏览器访问控制器(Controller)来执行应用程序逻辑。但CodeIgniter4提供了更灵活的方式——通过命令行接口(CLI)直接调用控制器。这种方式特别适合后台任务、定时脚本等不需要用户界面的场景。

CLI控制器的基本概念

CLI控制器本质上与普通Web控制器相同，但有以下关键区别：

1. 执行环境：在终端而非浏览器中运行
2. 参数传递：通过命令行参数而非URL参数
3. 输出方式：直接输出到控制台而非HTTP响应

创建你的第一个CLI控制器

步骤1：创建控制器文件

在app/Controllers/目录下创建Tools.php文件，内容如下：

<?php namespace App\Controllers;

class Tools extends BaseController
{
    public function message($to = 'World')
    {
        echo "Hello {$to}!" . PHP_EOL;
    }
}

这个简单的控制器定义了一个message方法，接收一个参数并输出问候语。

关于自动路由的注意事项

如果你使用改进版自动路由(auto-routing-improved)，需要将方法名改为cliMessage()，因为改进版路由对CLI访问有特殊命名约定。

配置CLI专用路由

基本路由配置

在app/Config/Routes.php中，可以使用cli()方法定义仅限命令行访问的路由：

$routes->cli('tools/message/(:segment)', 'Tools::message/$1');

这种路由定义方式与普通Web路由类似，但有以下特点：

• 仅能通过命令行访问
• 不会暴露给Web请求
• 参数传递方式与URL路由一致

安全警告

如果使用传统自动路由(auto-routing-legacy)，放置在app/Controllers目录下的控制器文件可能会被HTTP请求访问到，存在安全隐患。建议：

1. 优先使用改进版自动路由
2. 或显式定义CLI专用路由
3. 或在控制器中检查is_cli()函数

执行CLI控制器

基本执行方式

在项目根目录下执行：

php index.php tools message

输出结果：

Hello World!

传递参数

可以像URL参数一样传递命令行参数：

php index.php tools message "John Smith"

输出结果：

Hello John Smith!

高级技巧与最佳实践

1. 使用_remap方法

CLI控制器支持_remap()方法，可以集中处理请求。但需要注意：

• 不兼容改进版自动路由
• 需要手动检查is_cli()

2. 环境检测

在控制器中，可以使用以下方式确保只在CLI环境下运行：

if (! is_cli()) {
    throw new \RuntimeException('仅支持命令行访问');
}

3. 输出格式化

CLI输出与Web输出不同，建议：

• 使用PHP_EOL代替<br>换行
• 避免使用HTML标签
• 考虑使用CLI::write()等专用方法

替代方案：Spark命令

虽然CLI控制器很方便，但CodeIgniter4更推荐使用Spark命令来开发CLI应用，因为：

1. 更清晰的代码组织
2. 内置参数解析功能
3. 更好的帮助系统
4. 更符合CLI应用的设计模式

总结

通过CLI调用控制器是CodeIgniter4提供的一个强大功能，特别适合：

• 后台任务处理
• 定时脚本执行
• 系统维护任务
• 批量数据处理

记住核心原则：保持代码安全（限制CLI访问）、明确区分CLI和Web逻辑、考虑使用更专业的Spark命令替代方案。

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