TP5自定义命令行任务必须继承think\console\Command类、在application/command.php中注册全限定类名、通过php think调用;普通函数无法被识别,未声明参数将返回null,crontab需用绝对路径并注意CLI环境差异。

TP5 自定义命令行任务不是靠“写函数”实现的,而是通过继承 think\console\Command 类、注册到 application/command.php、再由 php think 调用执行的。直接在 common.php 里写个普通函数,是无法被命令行识别或触发定时执行的。
自定义命令类必须继承 Command 类
ThinkPHP 5 的命令行机制依赖框架的控制台组件,所有可执行命令都得是 think\console\Command 的子类。否则 php think xxx 会报错:Command "xxx" is not defined.
- 命名空间必须匹配实际路径(比如文件在
application/command/Test.php,命名空间就得是app\command或对应目录结构) -
configure()中必须调用setName(),且名称不能含空格或特殊字符(如Test可以,my task不行) -
execute()是唯一入口,逻辑写在这里;不能只写个普通函数然后指望它被自动调用
command.php 配置项必须是类的完整命名空间字符串
application/command.php 是一个返回数组的配置文件,每一项都必须是「可实例化的命令类全限定名」,例如:
return [
'app\command\Test',
'app\command\SyncData',
];
常见错误包括:
- 写成相对路径或文件名(如
'Test'或'Test.php')→ 加载失败 - 类名拼写错误或大小写不一致(PHP 对类名大小写敏感)→
Class not found - 忘记加单引号,写成
app\command\Test(无引号会被当常量解析)→ 致命错误
命令行参数和选项要显式声明才能获取
想让命令支持 php think test --env=prod 或 php think calculate 10 20 --add,必须在 configure() 里用 addOption() 或 addArgument() 注册,否则 $input->getOption('env') 永远返回 null。
- 位置参数(如
php think backup users中的users)要用addArgument('name') - 选项参数(如
--force、--limit=100)要用addOption('force')或addOption('limit', null, InputOption::VALUE_REQUIRED) - 没声明就直接
getArgument()或getOption()→ 返回空,不会报错但逻辑失效
宝塔/系统 crontab 调用时路径和环境容易出错
服务器上用宝塔或 crontab 执行定时任务,本质是 shell 环境下运行 php /www/wwwroot/yourproject/think test,这时:
- 务必写绝对路径,不能用
cd /path && php think test(crontab 不一定加载你的 shell profile) - PHP CLI 版本可能和 Web 不同(如宝塔默认用 PHP 7.4,而网站跑在 8.1)→ 导致扩展缺失或语法报错
- 当前工作目录不是项目根目录 →
think命令找不到application/目录,报Application not found - 建议在 crontab 里显式指定:
/usr/bin/php /www/wwwroot/yourproject/think test >> /www/wwwroot/yourproject/runtime/log/cron.log 2>&1
真正容易被忽略的是:命令类中调用模型、Db 或助手函数时,如果用了未初始化的容器服务(比如直接 new Model() 而非 model('User')),在命令行环境下可能因容器未完全启动而失败——这不是语法问题,是生命周期问题。

















