webman自定义command必须继承symfony command类并注册到框架,用php webman make:command生成骨架最稳妥;需设唯一$defaultname,configure()和execute()不可省略,且须调用bootstrap::init()初始化才能使用config()等服务。

Webman 的自定义 Command 工具必须继承 Symfony\Component\Console\Command\Command,且需注册到框架命令系统中才能被 php webman 识别并执行——不注册就等于没写。
如何创建一个可运行的 Command 类
用 php webman make:command 命令生成骨架是最稳妥的方式,它会自动处理命名空间、目录位置和基础结构:
- 生成命令:
php webman make:command StatMonthCommand,会在app/command/下创建StatMonthCommand.php - 类名必须与文件名一致(如
StatMonthCommand),且继承Command -
protected static $defaultName必须设为唯一字符串,这是命令行调用时的标识符(如php webman stat:month) - 若未显式设置
$defaultName,Symfony 会尝试从类名推导,但容易出错(比如带大小写或下划线时推导失败)
为什么 configure() 和 execute() 不能省略
configure() 是命令元信息入口,execute() 是实际逻辑执行点——两者缺一不可,否则运行时报错 Call to undefined method ...::configure() 或直接拒绝加载:
Webman 2.2.0版本强化了 TCP/UDP 服务支持,优化路由组管理,并增强异步任务处理能力。结合协程与连接池技术,Webman 能轻松应对高并发场景,适用于网站、接口服务、即时通讯、物联网及游戏开发,兼具高性能、灵活扩展与稳定可靠,是多场景 PHP 服务开发的理想选择。
-
configure()中必须调用$this->addArgument()或$this->addOption()(哪怕只加一个空参数),否则 Symfony 认为该命令“未配置”,跳过注册 -
execute()返回值必须是整数:self::SUCCESS(0)或self::FAILURE(1),返回其他类型(如void或字符串)会导致命令静默退出或报Return value of ...::execute() must be of the type int - 输入参数通过
$input->getArgument('name')获取,选项通过$input->getOption('force')获取,别直接读$argv
常见错误:命令不显示在 php webman list 中
即使类文件存在、语法无误,命令仍可能“隐身”。排查顺序如下:
- 确认类文件路径是
app/command/xxx.php(不是app/commands/或app/console/) - 检查命名空间是否为
app\command(注意反斜杠,不是正斜杠或小写command) - 运行
composer dump-autoload—— Webman 不自动重载新命令类,必须刷新 autoloader - 确认
$defaultName不含非法字符(如空格、中文、开头数字),推荐全小写+冒号分隔,例如stat:month - 如果用了插件(如
webman/console),确保其已启用:检查config/plugin/webman/console/app.php中'enable' => true
执行时读不到项目配置或辅助函数?
Webman 的命令行环境默认不加载 HTTP 生命周期中的服务(如 config()、db()、中间件等),需手动触发初始化:
- 在
execute()开头加\support\Bootstrap::init();(Webman 1.x)或\Webman\App::init();(Webman 2.x+) - 之后才能安全调用
config('database.default')、app()->make(SomeService::class)等 - 避免在
configure()中调用config()—— 此时容器尚未初始化,会报Call to a member function get() on null - 日志写入需注意:命令行下
logger()->info()默认输出到 console,若想写入文件,得显式指定 channel,如logger('file')->info()
最易忽略的是 autoloader 没刷新和 Bootstrap::init() 漏调用——这两个点卡住的人最多,其他问题基本靠看报错信息就能定位。










