1. 程式人生 > 程式設計 >golang 進度條功能實現示例

golang 進度條功能實現示例

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

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

成果演示

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

golang 進度條功能實現示例

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

原始碼分析

由於是要在終端上打印出進度條的效果,因此,主要還是利用 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()
}

以上是一個最簡單的呼叫,其執行效果如下所示:

golang 進度條功能實現示例

當然了,你也可以使用另一個初始化函式指定顯示的圖示,如下所示:

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

展示效果則如下所示:

golang 進度條功能實現示例

當然,實際使用中,你太可能只利用睡眠,而是需要實現自己的函式功能,只需要將 time.Sleep(100*time.Millisecond) 換成自己的程式碼邏輯即可。

到此這篇關於golang 進度條功能實現示例的文章就介紹到這了,更多相關golang 進度條內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們!