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

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

固然了，你也可使用另外一個初始化函數指定顯示的圖標，以下所示：

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

展現效果則以下所示：

固然，實際使用中，你太可能只利用睡眠，而是須要實現本身的函數功能，只須要將time.Sleep(100*time.Millisecond)換成本身的代碼邏輯便可。