golang终端应用多进度条显示插件库mpb的使用

简介

mpb是一个用于在终端应用程序中渲染进度条的Go库。

主要特性

• 多进度条支持：支持多个进度条同时显示
• 动态总数：可以在进度条运行时设置总数
• 动态添加/移除：可以动态添加或移除进度条
• 取消功能：可以取消整个渲染过程
• 预定义装饰器：包括已用时间、基于EWMA的ETA、百分比、字节计数器等
• 装饰器宽度同步：在多个进度条之间同步装饰器的宽度

使用示例

渲染单个进度条

package main

import (
    "math/rand"
    "time"

    "github.com/vbauerster/mpb/v8"
    "github.com/vbauerster/mpb/v8/decor"
)

func main() {
    // 初始化进度容器，自定义宽度
    p := mpb.New(mpb.WithWidth(64))

    total := 100
    name := "Single Bar:"
    // 创建单个进度条，将继承容器的宽度
    bar := p.New(int64(total),
        // 自定义样式的BarFillerBuilder
        mpb.BarStyle().Lbound("╢").Filler("▌").Tip("▌").Padding("░").Rbound("╟"),
        mpb.PrependDecorators(
            // 在右侧显示名称和一个空格
            decor.Name(name, decor.WC{C: decor.DindentRight | decor.DextraSpace}),
            // 在完成时用"done"消息替换ETA装饰器
            decor.OnComplete(decor.AverageETA(decor.ET_STYLE_GO), "done"),
        ),
        mpb.AppendDecorators(decor.Percentage()),
    )
    // 模拟工作
    max := 100 * time.Millisecond
    for i := 0; i < total; i++ {
        time.Sleep(time.Duration(rand.Intn(10)+1) * max / 10)
        bar.Increment()
    }
    // 等待进度条完成并刷新
    p.Wait()
}

渲染多个进度条

package main

import (
    "fmt"
    "math/rand"
    "sync"
    "time"

    "github.com/vbauerster/mpb/v8"
    "github.com/vbauerster/mpb/v8/decor"
)

func main() {
    var wg sync.WaitGroup
    // 传入的wg将在p.Wait()调用时被计算
    p := mpb.New(mpb.WithWaitGroup(&wg))
    total, numBars := 100, 3
    wg.Add(numBars)

    for i := 0; i < numBars; i++ {
        name := fmt.Sprintf("Bar#%d:", i)
        bar := p.AddBar(int64(total),
            mpb.PrependDecorators(
                // 简单的名称装饰器
                decor.Name(name),
                // decor.DSyncWidth位启用列宽同步
                decor.Percentage(decor.WCSyncSpace),
            ),
            mpb.AppendDecorators(
                // 在完成时用"done"消息替换ETA装饰器
                decor.OnComplete(
                    // EWMA年龄为30的ETA装饰器
                    decor.EwmaETA(decor.ET_STYLE_GO, 30, decor.WCSyncWidth), "done",
                ),
            ),
        )
        // 模拟工作
        go func() {
            defer wg.Done()
            rng := rand.New(rand.NewSource(time.Now().UnixNano()))
            max := 100 * time.Millisecond
            for i := 0; i < total; i++ {
                // start变量仅用于EWMA计算
                // EWMA的度量单位是迭代的持续时间
                start := time.Now()
                time.Sleep(time.Duration(rng.Intn(10)+1) * max / 10)
                // 需要调用EwmaIncrement来满足ewma装饰器的约定
                bar.EwmaIncrement(time.Since(start))
            }
        }()
    }
    // 等待传入的wg和所有进度条完成并刷新
    p.Wait()
}

动态总数示例

复杂示例

IO示例