Webman自定义命令行脚本教程

本文深入解析了Webman框架下自定义命令行脚本的正确实现方式，强调必须严格遵循webman/console插件机制——而非简单执行php script.php或手动引入bootstrap文件，否则将因跳过框架初始化而导致config()、数据库操作等核心功能全面失效；文章系统梳理了命令创建（./webman make:command）、上下文自动注入、环境变量隔离、数据库连接管理、交互式输入处理及生产级稳定性保障（如crontab/systemd适配）等关键实践，并直击常见报错根源与隐蔽坑点，帮助开发者写出真正可靠、可维护、能落地线上环境的高质量命令行工具。

Webman 的自定义命令行脚本不是靠手动写 php 文件 + require_once 拼凑出来的，而是必须走 webman/console 插件机制——否则无法自动加载框架上下文、配置、数据库连接等核心能力，连 config() 都会报错。

为什么不能直接用 php script.php 运行？

Webman 项目启动依赖 support/bootstrap.php 初始化容器、配置、数据库连接器等。裸跑 PHP 脚本跳过了这一步，config('database') 返回 null，Db::table() 报 Call to a member function table() on null，所有依赖 DI 容器的类都无法使用。

• 常见错误现象：PHP Fatal error: Uncaught Error: Call to a member function get() on null（来自 Container::get()）
• 即使加了 require_once __DIR__.'/../vendor/autoload.php' 和 require_once __DIR__.'/../support/bootstrap.php'，也大概率失败——因为 bootstrap.php 本身依赖 start.php 的执行上下文
• 正确路径只有一条：通过 webman/console 提供的 Command 基类创建命令类，由 ./webman 入口统一调度

如何用 ./webman make:command 创建可用命令？

运行命令生成骨架类，然后在 handle() 中写业务逻辑，框架自动注入上下文。

• 执行：./webman make:command db:backup → 生成 app/command/DbBackupCommand.php
• 关键点：类必须继承 Symfony\Component\Console\Command\Command，且 static $defaultName 必须是字符串字面量（不能拼接），否则 ./webman list 不识别
• execute() 方法内可直接调用 config()、Db::table()、Log::info() 等，无需手动初始化
• 参数获取用 $input->getArgument('name') 或 $input->getOption('force')，不要碰 $argv —— Symfony Console 已封装好解析逻辑

命令中访问数据库或配置时容易踩的坑

看似能跑通，但实际执行可能静默失败或读到错误配置，根源常在环境隔离和连接复用上。

• 开发环境配置（config/database.php）默认用 mysql 连接，但命令行运行时若未指定 APP_ENV=console，可能误读 .env 里的 DB_DATABASE=homestead，而该库在生产服务器上根本不存在
• 长命令（如导出百万行数据）未关闭 PDO 连接，导致后续命令报 Too many connections —— 应在 handle() 结尾显式调用 Db::close()
• 使用 config('plugin.xxx.yyy') 时，插件配置文件必须放在 config/plugin/xxx/yyy.php，且路径大小写敏感（Linux 下 Plugin ≠ plugin）
• 输出中文乱码？在 execute() 开头加 $output->setDecorated(true); 并确保终端编码为 UTF-8

如何让命令支持 --force 或交互确认？

别手写 fgets(STDIN)，用 Symfony Console 内置方法更可靠。

• 在 $signature 中声明选项：protected $signature = 'db:backup {--force : Force overwrite without confirmation}'
• 判断是否强制执行：if (!$input->getOption('force') && !$this->confirm('Confirm backup?')) { return Command::FAILURE; }
• 需要用户输入时用 $name = $this->ask('Enter backup name');，带默认值：$name = $this->ask('Enter backup name', date('Y-m-d'));
• 注意：$this->confirm() 和 $this->ask() 在非 TTY 环境（如 cron）会直接返回 false 或空字符串，需提前检测：if (!$input->isInteractive()) { $this->warn('Non-interactive mode, skipping prompt'); }

真正难的不是写命令，而是让命令在 crontab、systemd、CI/CD 流水线里稳定执行——环境变量隔离、工作目录切换、错误退出码传递、日志归档路径权限，这些细节不处理，再漂亮的 handle() 也会在线上静默失效。

今天关于《Webman自定义命令行脚本教程》的内容就介绍到这里了，是不是学起来一目了然！想要了解更多关于Webman的内容请关注golang学习网公众号！