Go項目實戰：一步步構建一個并發文件下載器
大家好，我是 polarisxu。
今天為大家帶來一個實戰項目。建議你一定要動手實踐。
在往下看之前，你不妨思考下，用 Go 如何實現一個并發下載器。
01 原理
對于服務器上的某個文件，我們要并發下載到本地，很容易想到，應該將文件分成多個部分，然后開多個 goroutine 并發地去下載，最后將這多個部分合并成一個文件，實現并發下載的目的。
現在的問題是，服務器上的一個文件，我們怎么做到分成多個呢？
這需要 HTTP 協議相關知識了。
HTTP 協議有一個響應頭：Accept-Ranges，服務器通過該頭來標識自身支持部分請求（partial requests），也叫范圍請求。如果服務端支持部分請求，我們就可以實現并發下載。該頭有兩個可能的值：
- Accept-Ranges: bytes
- Accept-Ranges: none
- none：不支持任何部分請求單位，由于其等同于沒有返回此頭部，因此很少使用。不過一些瀏覽器，比如 IE9，會依據該頭部去禁用或者移除下載管理器的暫停按鈕。
- bytes：部分請求的單位是 bytes （字節）。
所以，我們在并發下載之前，應該先發起一個 Head 請求，來確認服務端是否支持部分請求。比如：
- resp, err := http.Head("https://studygolang.com/dl/golang/go1.16.5.src.tar.gz")
- if err != nil {
- return err
- }
- if resp.StatusCode == http.StatusOK && resp.Header.Get("Accept-Ranges") == "bytes" {
- // 支持部分請求
- }
確認了服務器支持部分請求，接下來就是如何進行部分請求。
這就用到 HTTP 的一個請求頭部：Range。（詳情參考： https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Headers/Range ）
Range 告知服務器返回文件的哪一部分。在一個 Range 頭部中，可以一次性請求多個部分，服務器會以 multipart 文件的形式將其返回。如果服務器返回的是范圍響應，需要使用 206 Partial Content 狀態碼。假如所請求的范圍不合法，那么服務器會返回 416 Range Not Satisfiable 狀態碼，表示客戶端錯誤。服務器允許忽略 Range 首部，從而返回整個文件，狀態碼用 200。
具體語法：
- Range: <unit>=<range-start>-
- Range: <unit>=<range-start>-<range-end>
- Range: <unit>=<range-start>-<range-end>, <range-start>-<range-end>
- Range: <unit>=<range-start>-<range-end>, <range-start>-<range-end>, <range-start>-<range-end>
-
<unit>范圍所采用的單位，通常是字節（bytes）。
-
<range-start>一個整數，表示在特定單位下，范圍的起始值。
-
<range-end>一個整數，表示在特定單位下，范圍的結束值。這個值是可選的，如果不存在，表示此范圍一直延伸到文檔結束。
例如：
- Range: bytes=200-1000, 2000-6576, 19000-
掌握了以上知識點，最后要做的就是將下載下來的各個部分合并成一個文件。需要注意各個部分的順序，比如根據順序，按 1、2、3 等編號。
02 動手實現一個
知道了原理不代表你真的就會了，我們應該實際動手實現一個，加深理解。
在本地某個目錄下創建目錄：downloader。
- $ mkdir downloader
- $ cd downloader
- $ go mod init github.com/polaris1119/downloader
命令行參數控制
為了讓工具更好用，我們應該支持命令行參數，而不是代碼寫死一個，比如要下載的 URL、并發數、輸出的文件名等。關于命令行參數控制，除了使用標準庫 flag，我比較喜歡 github.com/urfave/cli，最新版本 v2。
創建一個文件 main.go，內容如下：
- package main
- import (
- "log"
- "os"
- "runtime"
- "github.com/urfave/cli/v2"
- )
- func main() {
- // 默認并發數
- concurrencyN := runtime.NumCPU()
- app := &cli.App{
- Name: "downloader",
- Usage: "File concurrency downloader",
- Flags: []cli.Flag{
- &cli.StringFlag{
- Name: "url",
- Aliases: []string{"u"},
- Usage: "`URL` to download",
- Required: true,
- },
- &cli.StringFlag{
- Name: "output",
- Aliases: []string{"o"},
- Usage: "Output `filename`",
- },
- &cli.IntFlag{
- Name: "concurrency",
- Aliases: []string{"n"},
- Value: concurrencyN,
- Usage: "Concurrency `number`",
- },
- },
- Action: func(c *cli.Context) error {
- return nil
- },
- }
- err := app.Run(os.Args)
- if err != nil {
- log.Fatal(err)
- }
- }
執行 go mod tidy，下載必要的包。然后執行：
- $ go run main.go -h
- NAME:
- downloader - File concurrency downloader
- USAGE:
- downloader [global options] command [command options] [arguments...]
- COMMANDS:
- help, h Shows a list of commands or help for one command
- GLOBAL OPTIONS:
- --url URL, -u URL URL to download
- --output filename, -o filename Output filename
- --concurrency number, -n number Concurrency number (default: 8)
- --help, -h show help (default: false)
關于 cli 這個庫的使用，可以參閱官方文檔，寫的很詳細，也有很多例子。
檢查是否支持并發下載
創建另外一個文件 downloader.go，定義一個結構體 Dowloader：
- package main
- type Downloader struct {
- concurrency int
- }
- func NewDownloader(concurrency int) *Downloader {
- return &Downloader{concurrency: concurrency}
- }
為該結構體增加 Download 方法：
- func (d *Downloader) Download(strURL, filename string) error {
- if filename == "" {
- filename = path.Base(strURL)
- }
- resp, err := http.Head(strURL)
- if err != nil {
- return err
- }
- if resp.StatusCode == http.StatusOK && resp.Header.Get("Accept-Ranges") == "bytes" {
- return d.multiDownload(strURL, filename, int(resp.ContentLength))
- }
- return d.singleDownload(strURL, filename)
- }
- func (d *Downloader) multiDownload(strURL, filename string, contentLen int) error {
- return nil
- }
- func (d *Downloader) singleDownload(strURL, filename string) error {
- return nil
- }
- 通過 Head 請求，判斷是否支持部分請求。在原理部分已經講解；
- 如果不支持，就直接下載整個文件；
當支持部分請求時，文件總大小通過 Head 請求的響應中的 ContentLength 可以獲得。有了文件總大小和并發數，就可以知道每個部分的大小了。
并發下載
這部分第一個要點是如何發起部分請求：
- req, err := http.NewRequest("GET", "https://apache.claz.org/zookeeper/zookeeper-3.7.0/apache-zookeeper-3.7.0-bin.tar.gz", nil)
- if err != nil {
- return err
- }
- rangeStart := 2000
- rangeStop := 3000
- req.Header.Set("Range", fmt.Sprintf("bytes=%d-%d", rangeStart, rangeStop))
- res, err := http.DefaultClient.Do(req)
我們可以將其封裝成一個方法：
- func (d *Downloader) downloadPartial(strURL, filename string, rangeStart, rangeEnd, i int) {
- if rangeStart >= rangeEnd {
- return
- }
- req, err := http.NewRequest("GET", strURL, nil)
- if err != nil {
- log.Fatal(err)
- }
- req.Header.Set("Range", fmt.Sprintf("bytes=%d-%d", rangeStart, rangeEnd))
- resp, err := http.DefaultClient.Do(req)
- if err != nil {
- log.Fatal(err)
- }
- defer resp.Body.Close()
- flags := os.O_CREATE | os.O_WRONLY
- partFile, err := os.OpenFile(d.getPartFilename(filename, i), flags, 0666)
- if err != nil {
- log.Fatal(err)
- }
- defer partFile.Close()
- buf := make([]byte, 32*1024)
- _, err = io.CopyBuffer(partFile, resp.Body, buf)
- if err != nil {
- if err == io.EOF {
- return
- }
- log.Fatal(err)
- }
- }
- // getPartDir 部分文件存放的目錄
- func (d *Downloader) getPartDir(filename string) string {
- return strings.SplitN(filename, ".", 2)[0]
- }
- // getPartFilename 構造部分文件的名字
- func (d *Downloader) getPartFilename(filename string, partNum int) string {
- partDir := d.getPartDir(filename)
- return fmt.Sprintf("%s/%s-%d", partDir, filename, partNum)
- }
- 通過發起 Range 請求后，將請求的內容寫入本地文件中；
- 為了方便后續合并，文件名加上了序號，這就是 downloadPartial 最后一個參數的作用；
- rangeStart 和 rangeEnd 分別表示 Range 的開始和結束；
然后就是 multiDownload 方法中怎么分部分，這和并發請求多個 URL 很類似，使用 sync.WaitGroup 進行控制：
- func (d *Downloader) multiDownload(strURL, filename string, contentLen int) error {
- partSize := contentLen / d.concurrency
- // 創建部分文件的存放目錄
- partDir := d.getPartDir(filename)
- os.Mkdir(partDir, 0777)
- defer os.RemoveAll(partDir)
- var wg sync.WaitGroup
- wg.Add(d.concurrency)
- rangeStart := 0
- for i := 0; i < d.concurrency; i++ {
- // 并發請求
- go func(i, rangeStart int) {
- defer wg.Done()
- rangeEnd := rangeStart + partSize
- // 最后一部分，總長度不能超過 ContentLength
- if i == d.concurrency-1 {
- rangeEnd = contentLen
- }
- d.downloadPartial(strURL, filename, rangeStart, rangeEnd, i)
- }(i, rangeStart)
- rangeStart += partSize + 1
- }
- wg.Wait()
- // 合并文件
- d.merge(filename)
- return nil
- }
- func (d *Downloader) merge(filename string) error {
- return nil
- }
- 計算出每個部分的大小；
- 通過 sync.WaitGroup 協調并發請求；
- 注意每個部分的 rangeStart 和 rangeEnd 的計算規則，特別注意最后一部分；
- 所有部分都請求完成后，需要進行合并；
因為把每部分單獨保存為文件了，所以合并只需要按照順序處理這些文件即可：
- func (d *Downloader) merge(filename string) error {
- destFile, err := os.OpenFile(filename, os.O_CREATE|os.O_WRONLY, 0666)
- if err != nil {
- return err
- }
- defer destFile.Close()
- for i := 0; i < d.concurrency; i++ {
- partFileName := d.getPartFilename(filename, i)
- partFile, err := os.Open(partFileName)
- if err != nil {
- return err
- }
- io.Copy(destFile, partFile)
- partFile.Close()
- os.Remove(partFileName)
- }
- return nil
- }
連接程序
到這里，程序的核心部分已經完成。接下來該在 main.go 中的 Action 作如下處理：
- Action: func(c *cli.Context) error {
- strURL := c.String("url")
- filename := c.String("output")
- concurrency := c.Int("concurrency")
- return NewDownloader(concurrency).Download(strURL, filename)
- },
到這里可以運行測試下：
- go run . --url https://apache.claz.org/zookeeper/zookeeper-3.7.0/apache-zookeeper-3.7.0-bin.tar.gz
不出意外的話文件會下載成功。
03 總結
實現了基本功能，讀者朋友們可以進一步做優化、完善。比如：
- 看到下載過程，體驗更友好，可以加入 github.com/schollz/progressbar 庫；
- 可以暫停下載，然后繼續下載。即端點續傳；
- 不支持并發下載的，支持單個下載，即完成 singleDownload 方法；
類似下面這樣：
這個實現的完整代碼我放在了 GitHub： https://github.com/polaris1119/downloader 。
還有兩點大家可以注意下：
- 并發下載并不一定總是比簡單下載快，一般文件越大，并發下載的優勢才能體現。不過，并發下載可以端點續傳；
- 并發下載可以進一步優化，畢竟寫文件，再打開文件合并，是需要時間的；
最后，再提醒一次，記得自己動手實現一個哦。
