如何编写PHP命令行交互工具-php教程-PHP中文网

php命令行交互需用fgets()配合stream_set_blocking()实现非阻塞输入，单键响应须禁用行缓冲；readline()需手动安装扩展并运行时检测；参数解析推荐symfony/console；输出须区分stdout/stderr并检查颜色支持。

如何编写php命令行交互工具

PHP命令行交互工具的核心是 `fgets()` 和 `stream_set_blocking()`

命令行交互不是 Web 请求，没有自动的输入缓冲和回车触发机制。PHP 默认以阻塞方式读取 STDIN，但用户按一个键就响应（比如方向键、Ctrl+C）或实时监听按键，必须手动控制流行为。fgets(STDIN) 是最常用入口，但它会等到用户敲回车才返回整行——这对“按 Y 继续”或“上下键切换菜单”类交互完全不够用。

真正可控的交互依赖底层流操作：stream_set_blocking(STDIN, false) 可让 fgets() 或 fread() 立即返回（哪怕没输完），再配合 stream_select() 做超时等待，才能实现非阻塞轮询。很多脚本直接卡死，就是因为忽略了这一步。

简单确认交互（Y/N）用 fgets(STDIN) 足够，但记得 trim() 去掉换行符
需要单字符响应（如菜单快捷键）时，必须先执行 system('stty -icanon -echo')（Linux/macOS）禁用行缓冲，否则按键不即时生效
Windows 下需用 php_win32service 扩展或调用 conio.h 等原生接口，纯 PHP 无法跨平台实现单键捕获

避免 `readline()` 扩展缺失导致的 `Call to undefined function readline()`

readline() 函数能提供历史记录、行内编辑、Tab 补全等高级功能，但它不是 PHP 默认启用的扩展。Ubuntu/Debian 上需额外安装 php-readline 包；CentOS/RHEL 需装 php-process；macOS 用 Homebrew 安装 PHP 时默认不含该扩展，得重编译或换用 phpbrew。

更现实的做法是做运行时兜底：检测函数是否存在，不存在则降级为朴素 fgets() 输入，并提示用户补全能力受限。

btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理：站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载

检查方式：function_exists('readline')，而非依赖 extension_loaded('readline')（因部分系统动态加载但未导出函数）
readline_add_history() 必须在每次成功读取后显式调用，否则历史记录不会累积
使用 readline_completion_function() 自定义补全逻辑时，回调函数接收的是当前光标前的完整字符串，不是单词片段

参数解析别硬写，优先用 `symfony/console` 的 `InputDefinition`

手写 $argv 解析容易漏掉短选项合并（-vf）、长选项带值（--file=conf.php）、子命令嵌套等边界情况。Composer 生态里 symfony/console 是事实标准，它把参数声明和校验分离，还能自动生成帮助文本。

关键不是“用不用框架”，而是“是否把参数契约提前定义清楚”。哪怕只引入一个组件，也比用一堆 if (isset($argv[1])) 更可靠。

定义选项用 new InputOption('force', 'f', InputOption::VALUE_NONE)，注意第三个参数决定是否接受值
位置参数（如 php tool.php install vendor/name 中的 vendor/name）需用 InputArgument 显式声明 REQUIRED 或 OPTIONAL
console 命令类的 execute() 方法里，通过 $input->getOption('verbose') 取值，比直接操作 $argv 更易测、更少副作用

输出控制要区分 `STDOUT` 和 `STDERR`，别混用 `echo`

命令行工具的输出流有明确语义：STDOUT 是正常结果，可被管道传递或重定向；STDERR 是错误、警告、进度提示，应始终显示在终端上。用 echo 或 print 默认写入 STDOUT，一旦用户执行 php tool.php > output.txt，错误信息就消失了。

更隐蔽的问题是颜色支持：有些终端不识别 ANSI 转义序列，或用户设置了 NO_COLOR=1 环境变量。盲目输出彩色文字会导致日志文件里出现乱码。

错误输出统一走 fwrite(STDERR, "Error: ...\n")
检测是否支持颜色：function_exists('posix_isatty') && posix_isatty(STDOUT)，且 getenv('NO_COLOR') !== '1'
进度条类输出需用 \r 回车覆盖同一行，结尾加 \n 换行，避免多行堆叠

实际交互逻辑越复杂，越容易在信号处理（Ctrl+C）、编码（UTF-8 输入截断）、跨平台终端能力（Windows CMD vs PowerShell）上翻车。这些点没法靠一个函数解决，得在每处输入/输出节点做显式判断和降级。