golang 進度條功能實現

最近在做一個需求，功能很簡單，就是開發一個輕量級客戶端，將一個指定文件中的內容通過 TCP 發送到服務器。由於該文件特別大，有可能到達100G的數量級，因此處理起來會比較慢，爲了給用戶提供比較友好的展示界面，因此，在其中加入了進度條顯示功能。

在這裏，說一下我在實現該進度條功能時的一些思路。

成果演示

先看一下最終的成品效果展示：

該進度條一共分三部分組成，第一部分是主體進度條，第二部分是百分比，第三部分是當前完成的數據和總數據的一個動態展示。

源碼分析

由於是要在終端上打印出進度條的效果，因此，主要還是利用 fmt.Printf 函數中的 \r 格式控制符。有了這個基礎，我們就可以先設計一下結構，如下所示：

type Bar struct {
    percent int64  //百分比
    cur     int64  //當前進度位置
    total   int64  //總進度
    rate    string //進度條
    graph   string //顯示符號
}

其中，百分比沒什麼說的， cur 和 total 是一組，表示的就是第三部分動態展示的當前完成數據和總數據。 rate 就是第一部分不斷變化的進度條，它是一個 string 類型的字符串。

這個進度條顯示工具還提供了一個叫 graph 的屬性，有了它，用戶就可以自定義進度條顯示的圖案，比如可以把進度條中的方塊換成 # 、 = 、 @ 等你可以想得到的圖案。

初始化

爲了能夠方便的調用該進度條工具，因此，爲該結構提供了兩個初始化的方法，分別爲 NewOption 和 NewOptionWithGraph ,第二個初始化的方法即可以自己指定顯示圖案。

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 //初始化進度條位置
    }
}

該函數提供了兩個參數，分別爲 start 和 total ， total 不用說，它代表的是總的任務量，還提供了一個 start 參數，說明可以不從 0 開始，這也就意味着，如果你的程序要支持斷點續傳功能，這個進度條工具依然可以完美支持，只需要將 start 值設置在斷點處即可。當然了，如果你不需要斷點續傳，每次都從 0 開始，只需要將 start 值設置爲0即可。

如果你注意到我在初始化進度條位置的時候，我使用了 i += 2 的步長，這就是我接下來要說的。因爲百分比總是從 0 到 100 ，而我的進度條長度最長爲50個字符，這也就意味着，每增長 2% ，進度條就要漲一格，因此，這裏的步長爲2。

getPercent 是一個根據 cur 和 total 獲取當前進度完成百分比的一個函數，其實現比較簡單：

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()
}

以上是一個最簡單的調用，其運行效果如下所示：