Go 复制文件

Go 语言标准库并没有直接提供名为 os.CopyFile() 的现成函数,但复制一个本地文件其实非常简单。在实际开发中,我们主要有 2 种实现方式。

第 1 种是使用 io 包的 io.Copy() 函数进行流式复制,适合处理任意大小的文件。第 2 种是结合 os.ReadFile() 和 os.WriteFile() 一次性读写,适合处理几 MB 以内的小文件。

io.Copy() 流式复制(推荐)

如果需要复制视频、压缩包或大型日志文件,或者事先不确定文件有多大,我们优先推荐使用标准库 io 包中的 io.Copy() 函数。其中,io 是 “Input/Output(输入输出)” 的缩写。

io.Copy() 内部自带一个 32KB 的缓冲区,就像拿一个小水瓢,一瓢一瓢地把数据从源文件舀到目标文件里。因此哪怕复制几十 GB 的大文件,它也只会占用很少的内存。

io.Copy() 的 32KB 缓冲区分批复制机制

语法:

written, err := io.Copy(dst, src)

说明:

io.Copy() 接收目标文件对象 dst 和源文件对象 src 作为参数,将 src 中的数据流式写入 dst 中。其中,dst 是 “destination(目标)” 的缩写,src 是 “source(源头)” 的缩写。

复制完成后,io.Copy() 会返回成功复制的字节数 written(类型为 int64)和错误值 err。

使用 io.Copy() 复制文件通常分为以下 3 步:

  • 打开源文件:我们调用 os.Open() 只读打开源文件 src,并在确认无误后配合 defer 语句写上 defer src.Close()。
  • 创建目标文件:我们调用 os.Create() 创建目标文件 dst,并在确认无误后写上 defer dst.Close()。如果目标文件原本已存在,os.Create() 会直接清空原有内容。
  • 执行流式复制:我们调用 io.Copy(dst, src),把源文件 src 中的数据流式写入目标文件 dst 中。

这里有个顺序小讲究:为什么要先打开源文件,再去创建目标文件呢?因为一旦源文件路径写错或文件不存在,第 1 步就会提前返回报错,这样就不会在硬盘上白白留下一个 0 字节的空目标文件了。

下面我们先在当前工作目录下准备一个测试文件 source.txt,在里面写入 15 个英文字符 "Hello, lvyenet!"(不含换行符)并保存,这一节的两个示例都会用到它。

示例 1:流式复制文件

package main

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

func main() {
    // 1. 打开源文件
    src, err := os.Open("source.txt")
    if err != nil {
        fmt.Println("打开源文件失败:", err)
        return
    }
    defer src.Close()

    // 2. 创建目标文件
    dst, err := os.Create("backup.txt")
    if err != nil {
        fmt.Println("创建目标文件失败:", err)
        return
    }
    defer dst.Close()

    // 3. 将 src 的内容流式复制到 dst
    written, err := io.Copy(dst, src)
    if err != nil {
        fmt.Println("复制失败:", err)
        return
    }

    fmt.Printf("复制成功,共写入 %d 个字节\n", written)
}

运行结果如下。

复制成功,共写入 15 个字节

分析:

"Hello, lvyenet!" 一共包含 15 个英文字符与标点,每个字符占 1 个字节。因此 io.Copy(dst, src) 返回的写入字节数 written 为 15,打开同目录下的 backup.txt 就能看到完整复制过来的内容。

调用 io.Copy(dst, src) 时,小伙伴们一定要看清两个参数的先后顺序:第 1 个参数是目标文件 dst,第 2 个参数是源文件 src。下面把正确写法和错误写法放在一起对比一下。

// 正确方式
io.Copy(dst, src)

// 错误方式
io.Copy(src, dst)

一旦写反成 io.Copy(src, dst),程序就会尝试往只读打开的源文件 src 里写入数据,运行时直接报错失败。此外还要注意,源文件路径和目标文件路径不能指向同一个文件,否则第 2 步执行 os.Create() 时会瞬间把源文件清空成 0 字节,导致原数据丢失。

提示: io.Copy(dst, src) 的参数顺序,和前面学习 “复制切片” 一节时见过的内置 copy(dst, src) 函数一致,都是 “目标 dst 在前,源头 src 在后”。你也可以结合赋值语句 dst = src(把右边的值赋给左边)来辅助记忆。

一次性读写复制小文件

如果我们要复制的只是一个几 KB 的小型配置文件,不想写完整的打开与关闭步骤,也可以结合 os.ReadFile() 和 os.WriteFile() 两步完成。下面我们来看一个例子。

示例 2:快速复制小文件

package main

import (
    "fmt"
    "os"
)

func main() {
    // 读取源文件全部内容
    data, err := os.ReadFile("source.txt")
    if err != nil {
        fmt.Println("读取失败:", err)
        return
    }

    // 将数据写入目标文件
    err = os.WriteFile("backup2.txt", data, 0644)
    if err != nil {
        fmt.Println("写入失败:", err)
        return
    }

    fmt.Println("小文件复制成功")
}

运行结果如下。

小文件复制成功

分析:

在这个例子中,我们先调用 os.ReadFile("source.txt") 把源文件读成字节切片 data,再调用 os.WriteFile("backup2.txt", data, 0644) 写入新文件,短短几行代码就完成了复制。

需要注意的是,因为 os.ReadFile() 会把整个文件一次性装进内存,这种方式只适合临时复制小文件。如果小伙伴们要在正式项目中封装通用的文件复制函数,还是优先推荐使用第 1 小节的 io.Copy()。此外,这两种方式都只用于复制单个普通文件,不能直接传入文件夹路径。

给站长反馈

绿叶网正在不断完善中,小伙伴们如果发现任何问题,还望多多给站长反馈,谢谢!

邮箱:lvyenet@vip.qq.com

「绿叶网」服务号
绿叶网服务号放大
关注服务号,微信也能看教程。
绿叶网服务号