乐趣区

关于golang:golang-进度条功能实现

最近在做一个需要,性能很简略,就是开发一个轻量级客户端,将一个指定文件中的内容通过 TCP 发送到服务器。因为该文件特地大,有可能达到 100G 的数量级,因而解决起来会比较慢,为了给用户提供比拟敌对的展现界面,因而,在其中退出了进度条显示性能。

在这里,说一下我在实现该进度条性能时的一些思路。

成绩演示

先看一下最终的成品成果展现:

该进度条一共分三局部组成,第一局部是主体进度条,第二局部是百分比,第三局部是以后实现的数据和总数据的一个动静展现。

源码剖析

因为是要在终端上打印出进度条的成果,因而,次要还是利用 fmt.Printf 函数中的 \r 格局控制符。有了这个根底,咱们就能够先设计一下构造,如下所示:

type Bar struct {
    percent int64  // 百分比
    cur     int64  // 以后进度地位
    total   int64  // 总进度
    rate    string // 进度条
    graph   string // 显示符号
}

其中,百分比没什么说的,curtotal 是一组,示意的就是第三局部动静展现的以后实现数据和总数据。rate就是第一局部一直变动的进度条,它是一个 string 类型的字符串。
这个进度条显示工具还提供了一个叫 graph 的属性,有了它,用户就能够自定义进度条显示的图案,比方能够把进度条中的方块换成 #=@ 等你能够想得到的图案。

初始化

为了可能不便的调用该进度条工具,因而,为该构造提供了两个初始化的办法,别离为 NewOptionNewOptionWithGraph, 第二个初始化的办法即能够本人指定显示图案。
NewOption应用的是默认的显示图案,也就是上图展现的方框。其实现代码如下所示:

func (bar *Bar) NewOption(start, total int64) {
    bar.cur = start
    bar.total = total
    if bar.graph == "" {bar.graph = "█"}
    bar.percent = bar.getPercent()
    for i := 0; i < int(bar.percent); i += 2 {bar.rate += bar.graph // 初始化进度条地位}
}

该函数提供了两个参数,别离为 starttotaltotal不用说,它代表的是总的任务量,还提供了一个 start 参数,阐明能够不从 0 开始,这也就意味着,如果你的程序要反对断点续传性能,这个进度条工具仍然能够完满反对,只须要将 start 值设置在断点处即可。当然了,如果你不须要断点续传,每次都从 0 开始,只须要将 start 值设置为 0 即可。
如果你留神到我在初始化进度条地位的时候,我应用了 i += 2 的步长,这就是我接下来要说的。因为百分比总是从 0100,而我的进度条长度最长为 50 个字符,这也就意味着,每增长 2%,进度条就要涨一格,因而,这里的步长为 2。
getPercent 是一个依据 curtotal获取以后进度实现百分比的一个函数,其实现比较简单:

func (bar *Bar) getPercent() int64 {return int64(float32(bar.cur) / float32(bar.total) * 100)
}

第二个初始化函数就比拟容易实现了,只须要把 graph 从新笼罩之后,间接调用下面的初始化函数即可。

func (bar *Bar) NewOptionWithGraph(start, total int64, graph string) {
    bar.graph = graph
    bar.NewOption(start, total)
}

进度条展现

那么,如何实现显示性能呢?
个别调用显示进度条时,都是放在循环中执行的,因而,咱们只须要在循环中可能展现出每轮循环以后的进度状态即可。

func (bar *Bar) Play(cur int64) {
    bar.cur = cur
    last := bar.percent
    bar.percent = bar.getPercent()
    if bar.percent != last && bar.percent%2 == 0 {bar.rate += bar.graph}
    fmt.Printf("\r[%-50s]%3d%%  %8d/%d", bar.rate, bar.percent, bar.cur, bar.total)
}

这段代码中,最重要的就是最初的应用 fmt.Printf 打印的那一句,通过 \r 管制打印成果。
当然了,在构建 rate 进度条时,我须要保留上一次实现的百分比,只有当百分比产生了变动,且步长变动了 2 时,才须要扭转进度条的长度。如果你的屏幕足够大,你也能够让你的进度条长度为 100 个字符,这样,你就不须要管制进度条的步长为 2 了,每增长1%,进度条后退 1 格,也是没有问题的。

完结

因为下面的打印没有打印换行符,因而,在进度全副完结之后(也就是跳出循环之外时),须要打印一个换行符,因而,封装了一个 Finish 函数,该函数纯正的打印一个换行,示意进度条曾经实现。

func (bar *Bar) Finish(){fmt.Println()
}

如何调用

调用该进度条性能,首先,必定要构建一个 Bar 对象,应用该对象进行初始化后,即可实现进度条的调用了,一个残缺的调用程序如下所示:

func main(){
    var bar progressbar.Bar    
    bar.NewOption(0, 100)
    for i:= 0; i<=100; i++{time.Sleep(100*time.Millisecond)
        bar.Play(int64(i))
    }
    bar.Finish()}

以上是一个最简略的调用,其运行成果如下所示:

当然了,你也能够应用另一个初始化函数指定显示的图标,如下所示:

bar.NewOptionWithGraph(0, 100, "#")

展现成果则如下所示:

当然,理论应用中,你太可能只利用睡眠,而是须要实现本人的函数性能,只须要将 time.Sleep(100*time.Millisecond) 换成本人的代码逻辑即可。

退出移动版