CodeIgniter4基础教程:CLI命令自定义开发

冬伟大大_7937

冬伟大大_7937

2026-08-09

951人浏览

原创

CI4命令类必须继承BaseCommand并置于app/Commands/下,类名以Command结尾,需设置group和description,参数用getArgument()获取,输出用info()/error()方法,crontab调用须用绝对路径。

codeigniter4基础教程:cli命令自定义开发

命令类必须继承 BaseCommand 且放在 app/Commands/ 下

CI4 的 CLI 命令不是独立脚本,不能直接 php mycommand.php 运行。所有自定义命令必须是 PHP 类,继承 CodeIgniter\CLI\BaseCommand,并严格放置在 app/Commands/ 目录下(子目录也允许,但需匹配命名空间)。

常见错误现象:Class 'ConfigServices' not found 或 Call to undefined method CodeIgniter\CLI\CLI::error(),本质是绕过 spark 入口,导致框架服务容器未初始化。

  • 类名必须以 Command 结尾(如 ClearCacheCommand),否则 spark list 不识别
  • $this->group 和 $this->description 必须设置,否则命令不会出现在 spark list 输出中
  • 命名空间应为 App\Commands(或你配置的 PSR-4 前缀),文件路径与命名空间严格对应

参数和选项要用 $this->getArgument() 和 $this->getOption()

别再用 $argv 或全局变量解析输入——CI4 CLI 提供统一、类型安全的访问方式,且自动支持帮助提示(spark help app:clear-cache)。

示例:若定义了 protected $arguments = ['type' => '缓存类型']; 和 protected $options = ['--force' => '强制执行'];,则:

  • 获取位置参数:$this->getArgument('type')(返回字符串或 null)
  • 获取选项值:$this->getOption('force')(返回 bool,有该 flag 就是 true)
  • 未声明的参数/选项会被忽略,不会报错但也不生效

注意:$this->getArgument(0) 这种数字索引写法不推荐,易出错;始终用键名访问更可靠。

输出必须用 $this->info() / $this->error(),不能用 echo

CI4 CLI 内置颜色、换行、进度条等能力,echo 会破坏格式一致性,且在管道或重定向场景下行为不可控(比如 cron 日志里乱码)。

CodeIgniter 4.7.0
CodeIgniter 4.7.0

CodeIgniter下载页提供 CodeIgniter 4.7.0 官方源码包,并整理框架安装、数据库配置与入门开发说明。

下载
  • $this->info('缓存已清空') → 绿色文字 + 换行
  • $this->error('数据库连接失败') → 红色文字 + 换行
  • $this->warn('跳过 config 缓存') → 黄色文字
  • 需要纯文本无样式输出?用 $this->write('raw text')

调试时如果发现输出没刷到终端,检查是否漏了换行符——$this->info() 自带,$this->write() 不带。

crontab 调用 spark 必须用绝对路径和显式 PHP 二进制

本地能跑的命令加进 crontab 就失败,90% 是环境差异问题:crontab 默认 PATH 极简,不加载 shell profile,工作目录也不是项目根目录。

正确写法只有一条路:

  • 在 crontab 里写完整路径:/usr/bin/php /var/www/myapp/spark app:clear-cache --force
  • 绝对禁止用 cd /var/www/myapp && php spark ... —— cron 不保证 shell 解释器一致,cd 可能失效
  • 确认 /usr/bin/php 对应的 PHP 版本和扩展(pdo_mysql、openssl 等)与 Web 环境一致,运行 php -m | grep pdo 核对
  • 务必重定向日志:> /var/log/myapp-cron.log 2>&1,否则失败无声无息

最容易被忽略的是工作目录——spark 依赖当前目录下的 app/、writable/ 等路径,相对路径调用会让 APPPATH 指向错误位置,导致配置加载失败或日志写入权限错误。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
PHP CodeIgniter框架
PHP CodeIgniter框架

本专题专注于 PHP 轻量级框架 CodeIgniter 的学习与应用,系统讲解 MVC 模型、路由与控制器、数据库操作、表单验证、安全机制以及 REST API 开发。通过博客系统、内容管理平台和小型电商等实战项目,帮助学员快速掌握 CodeIgniter 的开发方法与实践技能。

2025.08.28

3739

16

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

2026.10.22

60

11

Gradle Wrapper配置教程
Gradle Wrapper配置教程

本专题介绍Gradle Wrapper的基本作用,涵盖文件组成、生成方法、版本配置和任务调用,帮助你理解项目如何使用指定的Gradle版本,减少不同开发环境带来的构建差异。

2026.10.22

40

10

Golangci-lint检查器使用教程
Golangci-lint检查器使用教程

本专题整理Golangci-lint常用Linters的用途与配置方法,覆盖错误处理、无效代码、安全、复杂度、命名和依赖检查,帮助项目合理选规则。

2026.10.22

40

15

Gradle怎么构建Java项目
Gradle怎么构建Java项目

本专题介绍Gradle Java项目构建方法,涵盖Java插件配置、依赖声明、源码编译、测试执行和打包检查,帮助你理解各阶段的任务关系,逐步完成项目构建。

2026.10.22

20

10

PHP时间戳漏洞修复教程
PHP时间戳漏洞修复教程

本专题汇总PHP常见时间戳漏洞,包括2038年溢出、时区漂移、时间戳伪造、重放攻击、时间盲注与日志审计失效等,并给出升级64位环境、使用 DateTimeImmutable、统一UTC、严格超时校验、预处理绑定、hash_equals 比对等修复方案,帮助开发者快速排查和加固时间相关代码。

2026.10.22

40

25

Golangci-lint配置文件与规则设置
Golangci-lint配置文件与规则设置

本专题聚焦Golangci-lint YAML配置文件,讲清运行参数、规则启停、目录排除、问题过滤及严重级别设置,便于团队统一检查标准。

2026.10.22

20

15

Golangci-lint安装与入门教程
Golangci-lint安装与入门教程

本专题讲解Golangci-lint的安装、初始化、基础命令和首次代码检查,覆盖本地环境、Docker及多平台用法,帮助Go开发者快速上手。

2026.10.22

20

15

PHP2Shell高危漏洞修复教程
PHP2Shell高危漏洞修复教程

PHP2Shell漏洞是什么,哪些PHP版本和运行环境会受到影响,服务器应该如何检测与修复?本专题提供版本自查脚本、Linux与Docker升级命令、PHP-FPM和Apache排查步骤,以及修复验证、临时缓解和应急响应方案。

2026.10.22

220

12

热门下载

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

精品课程

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