uiprogress - Golang终端进度条库使用指南

uiprogress是一个简单易用的Golang终端进度条渲染库，适合在命令行应用中显示任务进度。下面我将详细介绍其使用方法并提供示例代码。

安装

go get github.com/gosuri/uiprogress

基本使用

1. 简单进度条

package main

import (
	"time"
	"github.com/gosuri/uiprogress"
)

func main() {
	uiprogress.Start() // 启动渲染器
	bar := uiprogress.AddBar(100) // 添加一个最大值为100的进度条

	// 可选：设置进度条格式
	bar.AppendCompleted()
	bar.PrependElapsed()

	for bar.Incr() { // 每次增加1
		time.Sleep(time.Millisecond * 20)
	}
}

2. 自定义进度条

bar := uiprogress.AddBar(100).
	PrependFunc(func(b *uiprogress.Bar) string {
		return fmt.Sprintf("任务(%d/%d)", b.Current(), b.Total)
	}).
	AppendFunc(func(b *uiprogress.Bar) string {
		return fmt.Sprintf("%.2f%%", b.CompletedPercent()*100)
	})

3. 多个并行进度条

func main() {
	uiprogress.Start()
	
	// 创建3个并行进度条
	var bars []*uiprogress.Bar
	for i := 0; i < 3; i++ {
		bars = append(bars, uiprogress.AddBar(100).
			PrependFunc(func(b *uiprogress.Bar) string {
				return fmt.Sprintf("任务 %d:", i+1)
			}))
	}

	// 模拟并行任务
	var wg sync.WaitGroup
	for i, bar := range bars {
		wg.Add(1)
		go func(bar *uiprogress.Bar, id int) {
			defer wg.Done()
			for bar.Incr() {
				time.Sleep(time.Millisecond * time.Duration(10*(id+1)))
			}
		}(bar, i)
	}
	wg.Wait()
}

高级功能

1. 自定义宽度

uiprogress.Width = 50 // 设置全局宽度

2. 自定义进度条字符

bar := uiprogress.AddBar(100).
	SetEmpty(' ').       // 空进度字符
	SetFill('▓').       // 填充字符
	SetHead('>').       // 头部字符
	SetLeftBorder('|').  // 左边框
	SetRightBorder('|')  // 右边框

3. 手动控制进度

bar := uiprogress.AddBar(100)
for i := 0; i <= 100; i++ {
	bar.Set(i) // 直接设置进度值
	time.Sleep(time.Millisecond * 50)
}

4. 完成后操作

bar := uiprogress.AddBar(100)
bar.SetOnComplete(func(b *uiprogress.Bar) {
	fmt.Println("\n任务完成!")
})

完整示例

package main

import (
	"fmt"
	"sync"
	"time"
	
	"github.com/gosuri/uiprogress"
)

func main() {
	uiprogress.Start() // 开始渲染
	defer uiprogress.Stop() // 程序退出时停止

	// 设置全局宽度
	uiprogress.Width = 60

	// 创建3个进度条模拟并行任务
	var bars []*uiprogress.Bar
	for i := 0; i < 3; i++ {
		bar := uiprogress.AddBar(100).
			PrependFunc(func(b *uiprogress.Bar) string {
				return fmt.Sprintf("任务 %d:", i+1)
			}).
			AppendFunc(func(b *uiprogress.Bar) string {
				return fmt.Sprintf("(%.1f%%)", b.CompletedPercent()*100)
			}).
			SetOnComplete(func(b *uiprogress.Bar) {
				fmt.Printf("\n任务 %d 已完成!\n", i+1)
			})
		
		// 自定义样式
		bar.SetEmpty(' ').
			SetFill('▓').
			SetHead('>').
			SetLeftBorder('[').
			SetRightBorder(']')
		
		bars = append(bars, bar)
	}

	// 模拟并行任务
	var wg sync.WaitGroup
	for i, bar := range bars {
		wg.Add(1)
		go func(bar *uiprogress.Bar, id int) {
			defer wg.Done()
			for i := 0; i <= 100; i++ {
				bar.Set(i)
				time.Sleep(time.Millisecond * time.Duration(50*(id+1)))
			}
		}(bar, i)
	}
	wg.Wait()
	
	fmt.Println("所有任务完成!")
}

注意事项

1. 确保在程序退出前调用 uiprogress.Stop() 清理终端
2. 在Docker容器中使用时可能需要设置 uiprogress.Out = os.Stderr
3. 进度条不适合在非终端环境使用，应先检测 isatty.IsTerminal(os.Stdout.Fd())

uiprogress库简单易用，适合大多数命令行进度显示需求。对于更复杂的需求，可以考虑其他库如 cheggaaa/pb 或 schollz/progressbar。