Golang跨平台线程安全进度条显示插件progressbar的使用

progressbar是一个非常简单且线程安全的进度条库，可以在所有操作系统上正常工作。

安装

go get -u github.com/schollz/progressbar/v3

基本用法

// 创建一个默认进度条，总进度为100
bar := progressbar.Default(100)
for i := 0; i < 100; i++ {
    // 每次增加1个进度
    bar.Add(1)
    time.Sleep(40 * time.Millisecond)
}

I/O操作

progressbar实现了io.Writer接口，因此可以自动检测写入流的字节数，你可以将其用作io.Reader的进度条。

// 下载文件示例
req, _ := http.NewRequest("GET", "https://dl.google.com/go/go1.14.2.src.tar.gz", nil)
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

f, _ := os.OpenFile("go1.14.2.src.tar.gz", os.O_CREATE|os.O_WRONLY, 0644)
defer f.Close()

// 创建基于字节的进度条
bar := progressbar.DefaultBytes(
    resp.ContentLength,  // 总字节数
    "downloading",       // 进度条描述
)
// 将数据同时写入文件和进度条
io.Copy(io.MultiWriter(f, bar), resp.Body)

未知长度的进度条

当进度条长度为-1时，它会自动转换为带有可自定义旋转器类型的旋转动画。

// 将resp.ContentLength设置为-1即可创建旋转动画
bar := progressbar.DefaultBytes(-1, "processing")

自定义

你可以进行大量自定义 - 更改写入器、颜色、宽度、描述、主题等。

bar := progressbar.NewOptions(1000,
    progressbar.OptionSetWriter(ansi.NewAnsiStdout()), // 需要安装"github.com/k0kubun/go-ansi"
    progressbar.OptionEnableColorCodes(true),          // 启用颜色代码
    progressbar.OptionShowBytes(true),                 // 显示字节数
    progressbar.OptionSetWidth(15),                    // 设置宽度
    progressbar.OptionSetDescription("[cyan][1/3][reset] Writing moshable file..."), // 设置描述
    progressbar.OptionSetTheme(progressbar.Theme{      // 自定义主题
        Saucer:        "[green]=[reset]",             // 进度条填充字符
        SaucerHead:    "[green]>[reset]",             // 进度条头部字符
        SaucerPadding: " ",                           // 进度条填充
        BarStart:      "[",                           // 进度条开始字符
        BarEnd:        "]",                           // 进度条结束字符
    }))
for i := 0; i < 1000; i++ {
    bar.Add(1)
    time.Sleep(5 * time.Millisecond)
}

完整示例

下面是一个完整的示例，展示了progressbar的基本用法和自定义选项：

package main

import (
	"io"
	"net/http"
	"os"
	"time"

	"github.com/k0kubun/go-ansi"
	"github.com/schollz/progressbar/v3"
)

func main() {
	// 示例1: 基本进度条
	basicExample()

	// 示例2: 下载文件进度条
	downloadExample()

	// 示例3: 自定义进度条
	customExample()
}

func basicExample() {
	// 创建一个默认进度条，总进度为100
	bar := progressbar.Default(100)
	for i := 0; i < 100; i++ {
		// 每次增加1个进度
		bar.Add(1)
		time.Sleep(40 * time.Millisecond)
	}
}

func downloadExample() {
	// 下载文件示例
	req, _ := http.NewRequest("GET", "https://dl.google.com/go/go1.14.2.src.tar.gz", nil)
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()

	f, _ := os.OpenFile("go1.14.2.src.tar.gz", os.O_CREATE|os.O_WRONLY, 0644)
	defer f.Close()

	// 创建基于字节的进度条
	bar := progressbar.DefaultBytes(
		resp.ContentLength,  // 总字节数
		"downloading",       // 进度条描述
	)
	// 将数据同时写入文件和进度条
	io.Copy(io.MultiWriter(f, bar), resp.Body)
}

func customExample() {
	// 自定义进度条示例
	bar := progressbar.NewOptions(1000,
		progressbar.OptionSetWriter(ansi.NewAnsiStdout()),
		progressbar.OptionEnableColorCodes(true),
		progressbar.OptionShowBytes(true),
		progressbar.OptionSetWidth(15),
		progressbar.OptionSetDescription("[cyan][1/3][reset] 处理中..."),
		progressbar.OptionSetTheme(progressbar.Theme{
			Saucer:        "[green]=[reset]",
			SaucerHead:    "[green]>[reset]",
			SaucerPadding: " ",
			BarStart:      "[",
			BarEnd:        "]",
		}))
	for i := 0; i < 1000; i++ {
		bar.Add(1)
		time.Sleep(5 * time.Millisecond)
	}
}

progressbar库提供了简单易用的API，可以轻松地在Golang应用中添加进度条功能，支持跨平台使用且线程安全。