一文瞭解 io.Copy 函數

来源:https://www.cnblogs.com/chenjiazhan/archive/2023/07/10/17539826.html
-Advertisement-
Play Games

### 歡迎訪問我的GitHub > 這裡分類和彙總了欣宸的全部原創(含配套源碼):[https://github.com/zq2599/blog_demos](https://github.com/zq2599/blog_demos) ### 為什麼要編譯nginx-clojure源碼 - 作為《 ...


1. 引言

io.Copy 函數是一個非常好用的函數,能夠非常方便得將數據進行拷貝。本文我們將從io.Copy 函數的基本定義出發,講述其基本使用和實現原理,以及一些註意事項,基於此完成對io.Copy 函數的介紹。

2. 基本說明

2.1 基本定義

Copy函數用於將數據從源(io.Reader)複製到目標(io.Writer)。它會持續複製直到源中的數據全部讀取完畢或發生錯誤,並返回覆制的位元組數和可能的錯誤。函數定義如下:

func Copy(dst io.Writer, src io.Reader) (written int64, err error)

其中dst 為目標寫入器,用於接收源數據;src則是源讀取器,用於提供數據。

2.2 使用示例

下麵提供一個使用 io.Copy 實現數據拷貝的代碼示例,比便更好得理解和使用Copy函數,代碼示例如下:

package main

import (
        "fmt"
        "io"
        "os"
)

func main() {
        fmt.Print("請輸入一個字元串:")
        src := readString()
        // 通過io.Copy 函數能夠將 src 的全部數據 拷貝到 控制臺上輸出
        written, err := io.Copy(os.Stdout, src)
        if err != nil {
                fmt.Println("複製過程中發生錯誤:", err)
                return
        }

        fmt.Printf("\n成功複製了 %d 個位元組。\n", written)
}

func readString() io.Reader {
   buffer := make([]byte, 1024)
   n, _ := os.Stdin.Read(buffer)
   // 如果實際讀取的位元組數少於切片長度,則截取切片
   if n < len(buffer) {
      buffer = buffer[:n]
   }
   return strings.NewReader(string(buffer))
}

在這個例子中,我們首先使用readString函數從標準輸入中讀取字元串,然後使用strings.NewReader將其包裝為io.Reader返回。

然後,我們調用io.Copy函數,將讀取到數據全部複製到標準輸出(os.Stdout)。最後,我們列印複製的位元組數。可以運行這個程式併在終端輸入一個字元串,通過Copy函數,程式最終會將字元串列印到終端上。

3. 實現原理

在瞭解了io.Copy 函數的基本定義和使用後,這裡我們來對 io.Copy 函數的實現來進行基本的說明,加深對 io.Copy 函數的理解。

io.Copy基本實現原理如下,首先創建一個緩衝區,用於暫存從源Reader讀取到的數據。然後進入一個迴圈,每次迴圈從源Reader讀取數據,然後存儲到之前創建的緩衝區,之後再寫入到目標Writer中。不斷重覆這個過程,直到源Reader返回EOF,此時代表數據已經全部讀取完成,io.Copy也完成了從源Reader往目標Writer拷貝全部數據的工作。

在這個過程中,如果往目標Writer寫入數據過程中發生錯誤,亦或者從源Reader讀取數據發生錯誤,此時io.Copy函數將會中斷,然後返回對應的錯誤。下麵我們來看io.Copy的實現:

func Copy(dst Writer, src Reader) (written int64, err error) {
   // Copy 函數 調用了 copyBuffer 函數來實現
   return copyBuffer(dst, src, nil)
}

func copyBuffer(dst Writer, src Reader, buf []byte) (written int64, err error) {
   // 如果 源Reader 實現了 WriterTo 介面,直接調用該方法 將數據寫入到 目標Writer 當中
   if wt, ok := src.(WriterTo); ok {
      return wt.WriteTo(dst)
   }
   // 同理,如果 目標Writer 實現了 ReaderFrom 介面,直接調用ReadFrom方法
   if rt, ok := dst.(ReaderFrom); ok {
      return rt.ReadFrom(src)
   }
   // 如果沒有傳入緩衝區,此時預設 創建一個 緩衝區
   if buf == nil {
      // 預設緩衝區 大小為 32kb
      size := 32 * 1024
      // 如果源Reader 為LimitedReader, 此時比較 可讀數據數 和 預設緩衝區,取較小那個
      if l, ok := src.(*LimitedReader); ok && int64(size) > l.N {
         if l.N < 1 {
            size = 1
         } else {
            size = int(l.N)
         }
      }
      buf = make([]byte, size)
   }
   for {
      // 調用Read方法 讀取數據
      nr, er := src.Read(buf)
      if nr > 0 {
         // 將數據寫入到 目標Writer 當中
         nw, ew := dst.Write(buf[0:nr])
         // 判斷寫入是否 出現了 錯誤
         if nw < 0 || nr < nw {
            nw = 0
            if ew == nil {
               ew = errInvalidWrite
            }
         }
         // 累加 總寫入數據
         written += int64(nw)
         if ew != nil {
            err = ew
            break
         }
         // 寫入位元組數 小於 讀取位元組數,此時報錯
         if nr != nw {
            err = ErrShortWrite
            break
         }
      }
      if er != nil {
         if er != EOF {
            err = er
         }
         break
      }
   }
   return written, err
}

從上述基本原理和代碼實現來看,io.Copy 函數的實現還是非常簡單的,就是申請一個緩衝區,然後從源Reader讀取一些數據放到緩衝區中,然後再將緩衝區的數據寫入到 目標Writer, 如此往複,直到數據全部讀取完成。

4. 註意事項

4.1 註意關閉源Reader和目標Writer

在使用io.Copy 進行數據拷貝時,需要指定源Reader 和 目標Writer,當io.Copy 完成數據拷貝工作後,我們需要調用Close 方法關閉 源Reader 和 目標Writer。如果沒有適時關閉資源,可能會導致一些不可預料情況的出現。

下麵展示一個使用 io.Copy 進行文件複製的代碼示例,同時簡單說明不適時關閉資源可能導致的問題:

package main

import (
        "fmt"
        "io"
        "os"
)

func main() {
        sourceFile := "source.txt"
        destinationFile := "destination.txt"

        // 打開源文件
        src, err := os.Open(sourceFile)
        if err != nil {
                fmt.Println("無法打開源文件:", err)
                return
        }
        // 調用Close方法
        defer src.Close()

        // 創建目標文件
        dst, err := os.Create(destinationFile)
        if err != nil {
                fmt.Println("無法創建目標文件:", err)
                return
        }
        // 調用Close 方法
        defer dst.Close()

        // 執行文件複製
        _, err = io.Copy(dst, src)
        if err != nil {
                fmt.Println("複製文件出錯:", err)
                return
        }

        fmt.Println("文件複製成功!")
}

使用 io.Copy 函數將源文件的內容複製到目標文件中。在結束代碼之前,我們需要適時地關閉源文件和目標文件。以上面使用io.Copy 實現文件複製功能為例,如果我們沒有適時關閉資源,首先是可能會導致文件句柄泄漏,數據不完整等一系列問題的出現。

因此我們在io.Copy函數之後,需要在適當的地方調用Close關閉系統資源。

4.2 考慮性能問題

io.Copy 函數預設使用一個32KB大小的緩衝區來複制數據,如果我們處理的是大型文件,亦或者是高性能要求的場景,此時是可以考慮直接使用io.CopyBuffer 函數,自定義緩衝區大小,以優化複製性能。而io.Copyio.CopyBuffer 底層其實都是調用io.copyBuffer 函數的,二者底層實現其實沒有太大的區別。

下麵通過一個基準測試,展示不同緩衝區大小對數據拷貝性能的影響:

func BenchmarkCopyWithBufferSize(b *testing.B) {
   // 本地運行時, 文件大小為 100 M
   filePath := "largefile.txt"
   bufferSizes := []int{32 * 1024, 64 * 1024, 128 * 1024} // 不同的緩衝區大小

   for _, bufferSize := range bufferSizes {
      b.Run(fmt.Sprintf("BufferSize-%d", bufferSize), func(b *testing.B) {
         for n := 0; n < b.N; n++ {
            src, _ := os.Open(filePath)
            dst, _ := os.Create("destination.txt")

            buffer := make([]byte, bufferSize)
            _, _ = io.CopyBuffer(dst, src, buffer)

            _ = src.Close()
            _ = dst.Close()
            _ = os.Remove("destination.txt")
         }
      })
   }
}

這裡我們定義的緩衝區大小分別是32KB, 64KB和128KB,然後使用該緩衝區來拷貝數據。下麵我們看基準測試的結果:

BenchmarkCopyWithBufferSize/BufferSize-32768-4                        12         116494592 ns/op
BenchmarkCopyWithBufferSize/BufferSize-65536-4                        10         110496584 ns/op
BenchmarkCopyWithBufferSize/BufferSize-131072-4                       12          87667712 ns/op

從這裡看來,32KB大小的緩衝區拷貝一個100M的文件,需要116494592 ns/op, 而128KB大小的緩衝區拷貝一個100M的文件,需要87667712 ns/op。不同緩衝區的大小,確實是會對拷貝的性能有一定的影響。

在實際使用中,根據文件大小、系統資源和性能需求,可以根據需求進行緩衝區大小的調整。較小的文件通常可以直接使用io.Copy 函數預設的 32KB 緩衝區,而較大的文件可能需要更大的緩衝區來提高性能。通過合理選擇緩衝區大小,可以獲得更高效的文件複製操作。

5. 總結

io.Copy 函數是Go語言標準庫提供的一個工具函數,能夠將數據從源Reader複製到目標Writer。 我們先從io.Copy 函數的基本定義出發,之後通過一個簡單的示例,展示如何使用io.Copy 函數實現數據拷貝。

接著我們講述了io.Copy 函數的實現原理,其實就是定義了一個緩衝區,將源Reader數據寫入到緩衝區中,然後再將緩衝區的數據寫入到目標Writer,不斷重覆這個過程,實現了數據的拷貝。

在註意事項方面,則強調了及時關閉源Reader和目標Writer的重要性。以及用戶在使用時,需要考慮io.Copy函數的性能是否能夠滿足要求,之後通過基準測試展示了不同緩衝區大小可能帶來的性能差距。

基於此,完成了對io.Copy 函數的介紹,希望對你有所幫助。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 摘要:7月8日,華為開發者大會2023(Cloud)華為雲河圖KooMap技術分論壇在東莞溪村順利舉辦。 7月8日,華為開發者大會2023(Cloud)華為雲河圖KooMap技術分論壇在東莞溪村順利舉辦。本次分論壇以“夯實數字孿生底座,點燃燎原星火”為主題,邀請了來自華為的技術專家和產學研領域的行業 ...
  • 1. 系統準備 查看系統信息:cat /proc/version查看 CPU:lscpu 或cat /proc/cpuinfo查看記憶體:free -m查看磁碟空間:cat /proc/meminfo或df -h查看tmp空間(至少1.5G以上):df -h /tmp發現tmp空間太小(安裝DM8需要 ...
  • *最近項目中要做一個拖動排序功能,首先想到的是之前項目中用過的antd自帶的tree和table的拖動排序,但是只能在對應的組建里使用。這裡用的是自定義組件,隨意拖動排序,所以記錄一下實現流程* 1. ***react-dnd*** antd組件的拖動排序都是用的這個庫,使用比較靈活,但是要配置的東 ...
  • 這裡給大家分享我在網上總結出來的一些知識,希望對大家有所幫助 介紹 今天介紹一個非常簡單的入門級小案例,就是地圖的捲簾效果實現,各大地圖引擎供應商都有相關示例,很奇怪高德居然沒有,我看了下文檔發現其實也是可以簡單實現的,演示代碼放到文末。本文用到了圖層掩模,即圖層遮罩,讓圖層只在指定範圍內顯示。 實 ...
  • ![](https://img2023.cnblogs.com/blog/3076680/202307/3076680-20230704152811386-132747394.png) # 1. 記錄日誌 ## 1.1. 傳統的日誌文件仍然是最可靠和最靈活的信息載體 ## 1.2. 日誌文件反映應用 ...
  • ## 引言 **觀察者模式**是一種行為型設計模式,它允許對象之間建立一種一對多的關係,使得當一個對象狀態改變時,所有依賴它的對象都能夠自動得到通知並更新自己的狀態。該模式可以幫助我們實現松耦合的系統,以便更好地應對變化和擴展。 在觀察者模式中,有兩個角色:**觀察者**和**被觀察者**。被觀察者 ...
  • ## 引言 **工廠方法模式**是一種創建型設計模式,它定義了一個用於創建對象的介面,但是讓子類決定將哪一個類實例化。換句話說,工廠方法模式讓一個類的實例化延遲到其子類。 工廠方法模式有以下幾個主要角色: - 抽象工廠(AbstractFactory):聲明用於創建抽象產品的操作的介面。 - 工廠實 ...
  • ## 引言 **抽象工廠模式**一種創建型設計模式,它提供了一種方式來封裝一組具有相同主題的工廠,而不必指定它們具體的類。這樣,客戶端代碼就可以使用抽象工廠來創建一組相關的對象,而不必關心實際創建的具體類。 抽象工廠模式有以下幾個主要角色: - 抽象工廠(AbstractFactory):聲明用於創 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...