流式命令输出进度

Question

我正在编写一个服务，该服务必须将已执行命令的输出流式传输到父级和日志。当过程很长时，问题是cmd.StdoutPipe给了我一个最终的（字符串）结果。

是否可以部分输出正在发生的事情，比如在 shell 中

func main() {
    cmd := exec.Command("sh", "-c", "some long runnig task")

    stdout, _ := cmd.StdoutPipe()
    cmd.Start()

    scanner := bufio.NewScanner(stdout)
    for scanner.Scan() {
        m := scanner.Text()
        fmt.Println(m)
        log.Printf(m)
    }

    cmd.Wait()
}

附：只是输出将是：

cmd.Stdout = os.Stdout

但就我而言，这还不够。

Answer 1

您发布的代码有效（执行了合理的命令）。

这是一个用 Go 编写的简单“一些长时间运行的任务”，供您调用和测试您的代码：

func main() {
    fmt.Println("Child started.")
    time.Sleep(time.Second*2)
    fmt.Println("Tick...")
    time.Sleep(time.Second*2)
    fmt.Println("Child ended.")
}

编译它并调用它作为你的命令。您将看到不同的行立即显示为子进程所写的“流式传输”。

它可能不适合您的原因

bufio.NewScanner() 返回的 Scanner 读取整行，并且仅在遇到换行符时才返回某些内容（由 bufio.ScanLines() 函数定义）。

如果您执行的命令不打印换行符，则不会立即返回其输出（仅在打印换行符时，内部缓冲区已填满或进程结束）。

可能的解决方法

如果您不能保证子进程打印换行符但您仍想流式输出，则无法读取整行。一种解决方案是按单词阅读，甚至按字符（符文）阅读。您可以通过使用Scanner.Split() 方法设置不同的split function 来实现此目的：

scanner := bufio.NewScanner(stdout)
scanner.Split(bufio.ScanRunes)

bufio.ScanRunes 函数通过runes 读取输入，因此只要有新的rune 可用，Scanner.Scan() 就会返回。

或者在没有Scanner 的情况下手动读取（在本例中是逐字节）：

oneByte := make([]byte, 1)
for {
    _, err := stdout.Read(oneByte)
    if err != nil {
        break
    }
    fmt.Printf("%c", oneByte[0])
}

请注意，上面的代码会错误地读取runes UTF-8 编码中的多个字节。要读取多个 UTF-8 字节符文，我们需要更大的缓冲区：

oneRune := make([]byte, utf8.UTFMax)
for {
    count, err := stdout.Read(oneRune)
    if err != nil {
        break
    }
    fmt.Printf("%s", oneRune[:count])
}

注意事项

进程具有标准输出和标准错误的默认缓冲区（通常大小为几 KB）。如果一个进程写入标准输出或标准错误，它会进入相应的缓冲区。如果此缓冲区已满，则进一步写入 将阻塞（在子进程中）。如果不读取子进程的标准输出和标准错误，如果缓冲区已满，您的子进程可能会挂起。

因此建议始终读取子进程的标准输出和错误。即使您知道该命令通常不会写入其标准错误，如果发生某些错误，它可能会开始将错误消息转储到其标准错误。

编辑： 正如 Dave C 提到的，默认情况下，子进程的标准输出和错误流被丢弃，如果不读取也不会导致阻塞/挂起。但是，如果不读取错误流，您可能会错过流程中的一两件事。

Answer 2

我在 Krzysztof Kowalczyk 的 this article 中找到了如何实现进度输出的好例子