如何在Golang中克隆Git仓库时显示动画Spinner并展示实时输出

核心思路 #

通过自定义io.Writer结合yacspin的Spinner，利用ANSI终端控制序列调整光标位置，实现Spinner固定在顶部动态更新、克隆进度在下方实时追加输出的效果，避免两者输出互相干扰。

分步实现 #

1. 自定义ProgressWriter
   创建实现io.Writer接口的结构体，持有Spinner实例，在Write方法中处理光标移动和输出逻辑：

import (
    "fmt"
    "os"

    "github.com/theckman/yacspin"
)

type ProgressWriter struct {
    spinner *yacspin.Spinner
}

func (pw *ProgressWriter) Write(p []byte) (n int, err error) {
    // 暂停Spinner防止输出冲突
    pw.spinner.Pause()
    defer pw.spinner.Resume()

    // 换行到Spinner下方写入进度
    fmt.Println()
    // 输出克隆进度内容
    n, err = os.Stdout.Write(p)
    // 回到Spinner所在行的开头
    fmt.Print("\033[A")
    // 清除当前行残留内容，确保Spinner正常渲染
    fmt.Print("\033[K")

    return n, err
}

2. 初始化并启动Spinner
   配置yacspin参数，启动Spinner并确保程序结束时停止：

import (
    "log"
    "time"

    "github.com/theckman/yacspin"
)

func main() {
    // 配置Spinner样式
    cfg := yacspin.Config{
        FadeIn:           true,
        FadeOut:          true,
        CharSet:          yacspin.CharSets[11], // 选择动态旋转字符集
        Message:          "Cloning Remote",
        StopMessage:      "Cloning Done!",
        Speed:            100 * time.Millisecond,
        Color:            "cyan",
        Suffix:           " ",
        MessageColor:     "white",
        ShowTimer:        false,
        ShowCursor:       false, // 隐藏光标减少闪烁
    }

    spinner, err := yacspin.New(cfg)
    if err != nil {
        log.Fatal(err)
    }

    spinner.Start()
    defer spinner.Stop()

3. 整合go-git克隆逻辑
   将自定义的ProgressWriter传入CloneOptions的Progress字段：

import "github.com/go-git/go-git/v5"

    pw := &ProgressWriter{spinner: spinner}

    // 执行克隆操作
    _, err = git.PlainClone("./clone/", false, &git.CloneOptions{
        URL:      "https://github.com/go-git/go-git",
        Progress: pw,
    })

    if err != nil {
        spinner.StopFail("Cloning Failed!")
        log.Fatal(err)
    }

    spinner.StopSuccess()
}

关键说明 #

• ANSI控制序列：\033[A实现光标上移一行，\033[K清除当前行内容，保证Spinner在进度输出后能正常重新渲染。
• Spinner状态控制：每次写入进度前暂停Spinner，写入完成后恢复，避免动画与进度输出冲突。
• 错误处理：克隆失败时调用StopFail显示错误状态，成功则调用StopSuccess展示完成提示。

内容的提问来源于stack exchange，提问作者BlueFalconHD