在Go语言开发场景中,我们经常会遇到需要和交互式命令行程序自动交互的需求,比如自动触发需要输入密码的sftp连接、自动执行需要逐步确认的交互式shell脚本等。这类交互式程序的特点是在运行时会动态输出提示信息,同时等待用户输入对应内容后才能继续往下执行,传统的标准输入输出操作很难满足这类复杂的交互需求。

核心实现思路
实现交互式程序自动化交互的核心是能够同时捕获子进程的标准输出、标准错误输出,并且能向子进程的标准输入写入内容。Go语言标准库的os/exec包可以启动子进程,但是本身没有提供匹配输出内容再输入的交互能力,因此我们需要借助第三方库来完成这类操作,其中比较常用的是github.com/ThomasRooney/gexpect和github.com/hinshun/vt10x配合os/exec的方案,下面以更常用的gexpect库为例讲解实现方法。
环境准备
首先需要安装对应的第三方依赖,执行以下命令完成安装:
go get github.com/ThomasRooney/gexpect
基础交互示例
下面以和一个简单的交互式脚本交互为例,先编写一个模拟交互式程序的脚本interactive.sh,内容如下:
#!/bin/bash echo "请输入你的姓名:" read name echo "请输入你的年龄:" read age echo "你好 $name,你的年龄是 $age 岁"
接下来编写Go语言代码,实现自动和这个脚本交互,完整代码如下:
package main
import (
"fmt"
"log"
"github.com/ThomasRooney/gexpect"
)
func main() {
// 启动交互式脚本作为子进程
child, err := gexpect.Spawn("bash interactive.sh")
if err != nil {
log.Fatalf("启动子进程失败:%v", err)
}
// 等待脚本输出姓名输入提示
err = child.Expect("请输入你的姓名:")
if err != nil {
log.Fatalf("等待姓名提示失败:%v", err)
}
// 向子进程输入姓名
err = child.SendLine("张三")
if err != nil {
log.Fatalf("输入姓名失败:%v", err)
}
// 等待年龄输入提示
err = child.Expect("请输入你的年龄:")
if err != nil {
log.Fatalf("等待年龄提示失败:%v", err)
}
// 向子进程输入年龄
err = child.SendLine("25")
if err != nil {
log.Fatalf("输入年龄失败:%v", err)
}
// 等待最终的输出结果
result, err := child.Expect("你好 张三,你的年龄是 25 岁")
if err != nil {
log.Fatalf("等待最终结果失败:%v", err)
}
fmt.Printf("交互结果:%s\n", result)
// 关闭子进程
child.Close()
}关键方法说明
- Spawn:启动指定的命令行程序作为子进程,返回子进程的交互对象。
- Expect:阻塞等待子进程输出匹配指定字符串的内容,匹配成功则返回匹配到的内容,超时或者匹配失败会返回错误。
- SendLine:向子进程的标准输入写入指定内容,并且自动追加换行符,模拟用户按下回车的操作。
- Send:向子进程的标准输入写入指定内容,不会自动追加换行符,适合需要输入特殊字符的场景。
常见问题与注意事项
超时问题处理
默认情况下Expect方法的等待时间是30秒,如果交互程序的响应时间比较长,可以通过ExpectWithTimeout方法自定义超时时间,示例代码如下:
// 设置等待超时为60秒
err = child.ExpectWithTimeout("请输入你的姓名:", 60*time.Second)
if err != nil {
log.Fatalf("等待超时:%v", err)
}特殊输出匹配
如果交互程序的输出包含正则特殊字符,或者需要按正则规则匹配,可以使用ExpectRegex方法,支持正则表达式匹配,示例代码如下:
// 使用正则匹配年龄提示,支持前后有其他无关输出的情况
err = child.ExpectRegex(`请输入你的年龄:`)
if err != nil {
log.Fatalf("正则匹配失败:%v", err)
}子进程残留问题
交互完成后一定要调用Close方法关闭子进程,避免子进程变成僵尸进程占用系统资源,如果子进程有长期运行的场景,还需要做好错误兜底,确保异常情况下也能正确关闭子进程。
适用场景说明
这种交互方式适合所有需要和交互式命令行程序自动交互的场景,比如自动化测试需要交互的CLI工具、自动登录需要密码的远程服务、批量执行需要交互确认的运维脚本等,相比手动编写输入输出捕获逻辑,使用成熟的第三方库可以大幅降低开发成本,也减少了边界场景的处理问题。