欢迎您访问新疆栾骏商贸有限公司,公司主营电子五金轴承产品批发业务!
全国咨询热线: 400-8878-609

新闻资讯

技术百科

Laravel Prompts如何构建优雅的命令行交互? (表单与选择)

作者:裘德小鎮的故事2026-01-14 00:00:00
Laravel Prompts 通过语义化函数(如 text()、password()、select()、confirm()、search())封装终端控制逻辑,实现专业 CLI 交互;text() 支持验证回调返回错误字符串,password() 隐藏输入且无 default;select() 和 multiselect() 依赖稳定 value 标识符;confirm() 返回布尔值用于流程分支,search() 基于 str_contains() 客户端过滤,需预载完整选项列表。

Laravel Prompts 构建命令行表单与选择交互,核心在于:它不是「模拟 GUI」,而是通过语义化函数封装底层终端控制逻辑,让你专注数据流而非光标位置。直接上手即可产出专业级 CLI 体验,无需手动处理 ANSI 转义或按键监听。

如何用 text()password() 实现带

验证的表单输入

这两个函数本质是阻塞式读取,但关键区别在于 password() 会隐藏输入字符(用 * 替代),且默认不支持退格以外的编辑操作。实际使用中容易忽略校验时机和错误反馈方式:

  • text()validate 回调在每次回车后触发,返回 string 表示通过,返回 string(非空)表示错误提示
  • 不要在 validate 中抛异常——它会中断整个命令流程;应返回错误消息字符串
  • password() 不支持 default 值(安全限制),若需预设值,请改用 text() + 手动掩码逻辑
use Laravel\Octane\Facades\Octane;
use Laravel\Prompts\Prompt;

$name = text(
    label: 'Your name',
    validate: fn (string $value) => match(true) {
        strlen($value) < 2 => 'Name must be at least 2 characters.',
        !ctype_alpha(str_replace(' ', '', $value)) => 'Name may only contain letters and spaces.',
        default => null
    }
);

$pwd = password(
    label: 'Password',
    validate: fn (string $value) => strlen($value) < 8 ? 'Too short.' : null
);

select()multiselect() 处理选项逻辑时的常见陷阱

这两个函数返回的是选项的「值」(value),不是标签(label)。如果你传入的是关联数组,键是 value,值是 label,那返回的就是键;如果传入索引数组,则返回对应元素本身。这点极易混淆:

  • 避免用数字索引数组直接传给 select(),否则用户选中「第二项」,你拿到的是 1 还是 item2?语义不清
  • multiselect() 返回数组,但空选择时返回空数组 [],不是 null;判断是否选中要用 count($choices) > 0
  • 当选项动态生成(如从数据库查出),确保 value 是稳定标识符(如 ID),而非易变字段(如名称)
$env = select(
    label: 'Environment',
    options: [
        'local' => 'Local (for development)',
        'staging' => 'Staging (pre-production)',
        'production' => 'Production (live)',
    ],
    default: 'local'
);

$roles = multiselect(
    label: 'Assign roles',
    options: [
        'admin' => 'Administrator',
        'editor' => 'Content Editor',
        'viewer' => 'Read-only Viewer',
    ],
    default: ['editor']
);

confirm()search() 在流程控制中的真实作用

confirm() 看似简单,但它返回的是布尔值,常被误用于「跳过后续步骤」的分支判断——这没问题,但要注意它不支持自定义 yes/no 提示文本(Laravel Prompts v0.1.x 尚未开放该参数)。而 search() 更容易被当成「模糊查找框」,其实它是基于 PHP 的 str_contains() 做客户端过滤,不发请求、不支持正则、不支持异步加载:

  • confirm() 的提示文案固定为「Do you wish to continue?」,如需定制,目前只能 fork 或等后续版本;临时方案是用 select() 模拟
  • search()options 必须是完整列表(不能是闭包或 Generator),否则无法实时过滤;大数据集(>500 项)会导致卡顿
  • 两者都支持 required: false,但 confirm() 设为 false 时,按 Ctrl+C 会抛 Exception,需 try/catch
$continue = confirm('Deploy to production?');

if (! $continue) {
    exit("Aborted.\n");
}

$users = search(
    label: 'Find user by name',
    options: User::pluck('name', 'id')->toArray(),
    placeholder: 'Type to filter...'
);

真正难的不是调用哪个函数,而是决定何时用 search() 替代 select()、何时把多个 text() 合并进一个表单对象、以及怎么让错误提示不打断用户节奏——这些没有 API 文档会写,得靠终端交互直觉和反复测试。