Go 写入文件

在 Go 语言中,把程序中的数据保存到本地文件主要有以下 3 个常用函数:

  • os.WriteFile():一次性把数据写入文件。如果文件不存在会自动新建,如果已存在则会覆盖原来的内容。
  • os.OpenFile():按指定模式打开文件。配合 os.O_APPEND 可以在保留原有内容的基础上,往文件末尾继续追加数据。
  • bufio.NewWriter():先把数据暂存到内存缓冲区,攒够一批后再统一写入硬盘,适合循环写入大量文本的场景。

覆盖写入:os.WriteFile()

如果我们只是想把一段简短的字符串或字节数据保存成文件,最直接的做法就是使用 os 包中的 os.WriteFile() 函数。

语法:

err := os.WriteFile(name, data, perm)

说明:

os.WriteFile() 接收以下 3 个参数,并返回一个 error 错误值:

  • name(必选):目标文件的路径字符串。如果该文件不存在会自动创建;如果已经存在,则会先清空原有内容再写入新数据。
  • data(必选):要写入的字节切片,类型为 []byte。如果要写入普通字符串 s,我们可以使用 []byte(s) 将其转换成字节切片。
  • perm(必选):文件的读写权限编码,日常开发中一般直接填写 0644 就可以了。

示例 1:创建并写入文件

package main

import (
    "fmt"
    "os"
)

func main() {
    content := "Hello, Go!\nScore: 95\n"

    // 将字符串转为字节切片并写入文件
    err := os.WriteFile("output.txt", []byte(content), 0644)
    if err != nil {
        fmt.Println("写入失败:", err)
        return
    }

    fmt.Println("文件写入成功")
}

运行结果如下。

文件写入成功

分析:

在这个例子中,程序会在当前工作目录下创建 output.txt,并把两行文本写入其中。运行成功后,我们打开项目目录下的 output.txt,就能看到刚刚写入的 "Hello, Go!" 和 "Score: 95" 两行内容。

与 os.ReadFile() 一样,os.WriteFile() 在写入完成后也会自动关闭文件,不需要我们手动调用 Close()。需要注意的是,如果我们接着对同一个 output.txt 再次调用 os.WriteFile() 写入新数据,文件中原有的两行内容就会被全部替换掉。

这里小伙伴们还要留意一个常见的坑:os.WriteFile() 只负责创建文件本身,并不会自动创建不存在的上级文件夹。如果把路径写成 "data/output.txt",但当前目录下还没有 data 文件夹,程序就会直接报错。遇到这种情况,我们需要先用 os.MkdirAll() 把上级目录建好才行。

八进制权限码 0644

在 Linux 和 macOS 系统中,0644 是一种八进制的文件权限表示法。其中开头的数字 0 代表八进制,后面三位数字分别对应 “文件拥有者”、“同组用户” 和 “其他用户” 的操作权限。

每一位权限值由 4(可读)、2(可写)和 1(可执行)相加得出,比如 6 就是 4 加 2,代表 “可读可写”。因此 0644 表示 “自己可读可写,其他人只读”。在 Windows 系统中这个权限码基本会被忽略,小伙伴们平时创建普通文件时固定传入 0644 就可以了。

追加写入:os.OpenFile()

os.WriteFile() 属于 “覆盖写入”,就像把黑板上的旧字擦干净再重新写一样。但在记录程序运行日志等场景下,我们通常希望保留文件里原有的内容,像记日记一样在最后一行接着往下写。两种写入方式的区别如下图所示。

覆盖写入与末尾追加写入对比

在 Go 语言中,如果想要往文件末尾追加内容,我们可以使用 os.OpenFile() 函数按需组合文件的打开模式。

语法:

file, err := os.OpenFile(name, flag, perm)

说明:

os.OpenFile() 的第 1 个参数 name 是文件路径,第 3 个参数 perm 是权限码(同样填 0644)。第 2 个参数 flag 用于控制打开方式,我们可以使用按位或运算符(|)把多个模式常量组合起来。常用的打开模式如下表所示。

常用打开模式
常量 说明
os.O_RDONLY 以只读模式打开文件
os.O_WRONLY 以只写模式打开文件
os.O_RDWR 以可读可写模式打开文件
os.O_CREATE 文件不存在时自动创建
os.O_APPEND 写入时追加到文件末尾
os.O_TRUNC 打开时清空文件原有内容

在实际开发中,向文件末尾追加内容时,我们通常传入 os.O_WRONLY|os.O_CREATE|os.O_APPEND 这 3 个常量的组合。为什么它们用竖线(|)连接,而不是逗号呢?

这是因为在底层设计中,每个常量各自占据一个独立的二进制开关位,用竖线就能把多个开关打包成同一个整数参数传进去。你平时直接记住这个固定组合就可以了。

这里小伙伴们要注意,不能只单独传入一个 os.O_APPEND。我们还必须同时指明允许写入(如 os.O_WRONLY 或 os.O_RDWR),否则默认按只读模式打开是无法写入数据的。

示例 2:向文件末尾追加内容

package main

import (
    "fmt"
    "os"
)

func main() {
    // 以只写、不存在则创建、末尾追加模式打开文件
    f, err := os.OpenFile("output.txt", os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
    if err != nil {
        fmt.Println("打开失败:", err)
        return
    }
    defer f.Close()    // 函数退出时关闭文件

    // 向文件末尾写入一行字符串
    _, err = f.WriteString("Level: Pass\n")
    if err != nil {
        fmt.Println("追加失败:", err)
        return
    }

    fmt.Println("内容追加成功")
}

运行结果如下。

内容追加成功

分析:

上面代码里的 os.O_WRONLY|os.O_CREATE|os.O_APPEND 相当于同时开启了 3 个开关:① 只写打开;② 文件不存在时自动新建;③ 每次写入都追加到末尾。

拿到文件对象 f 后,我们调用 f.WriteString() 方法就能直接写入字符串,省去了手动转换成 []byte 的步骤。同时记得配合 defer 语句在函数退出时关闭文件。在示例 1 生成的 output.txt 基础上运行这段代码后,打开文件可以看到如下内容:

Hello, Go!
Score: 95
Level: Pass

带缓冲写入:bufio.NewWriter()

如果我们需要在循环里连续写入成百上千行数据,每生成一行就调用一次 WriteString() 直接操作硬盘,频繁的磁盘写入会让速度变慢。这时我们可以使用 bufio 包中的 bufio.NewWriter() 创建一个带内存缓冲区的写入器,先把数据暂存在内存里,最后再一次性刷入硬盘。

语法:

writer := bufio.NewWriter(file)
writer.WriteString(s)
err := writer.Flush()

说明:

bufio.NewWriter(file) 接收一个可写入的文件对象。如果是从头生成新文件,我们可以先调用 os.Create("notes.txt") 快速创建文件对象,它等价于 os.O_RDWR|os.O_CREATE|os.O_TRUNC 模式。

需要注意的是,如果同名文件原本已存在,os.Create() 会清空里面的旧内容,因此追加数据时不要误用它。

调用 writer.WriteString(s) 时,程序只是先把字符串 s 写进内存缓冲区(默认 4KB),还没有真正落到硬盘上。等所有数据都写完后,我们必须在关闭文件前调用一次 writer.Flush()。其中,flush 是 “冲刷” 的意思,表示把留在内存缓冲区里的数据全部刷进磁盘文件中。

示例 3:缓冲写入多行数据

package main

import (
    "bufio"
    "fmt"
    "os"
)

func main() {
    f, err := os.Create("notes.txt")
    if err != nil {
        fmt.Println("创建失败:", err)
        return
    }
    defer f.Close()

    // 创建带缓冲的写入器
    writer := bufio.NewWriter(f)
    for i := 1; i <= 3; i++ {
        line := fmt.Sprintf("第 %d 条学习笔记\n", i)
        _, err := writer.WriteString(line)    // 先写入内存缓冲区
        if err != nil {
            fmt.Println("写入失败:", err)
            return
        }
    }

    // 将缓冲区数据刷入磁盘文件
    if err := writer.Flush(); err != nil {
        fmt.Println("刷入磁盘失败:", err)
        return
    }

    fmt.Println("缓冲写入完成")
}

运行结果如下。

缓冲写入完成

分析:

在这个例子中,循环内部通过 fmt.Sprintf() 拼接出每一行文本。调用 writer.WriteString(line) 时,只是先把这 3 行内容暂存到了内存中。直到循环结束后执行 writer.Flush(),这些数据才真正一次性写入硬盘上的 notes.txt 文件里。

注意: 使用 bufio.NewWriter() 写完数据后,小伙伴们一定要记得调用 writer.Flush()。如果漏写了 Flush(),当函数运行结束触发 defer f.Close() 关闭文件时,留在内存缓冲区里的数据还没来得及写入硬盘就会丢失,打开生成的文件会发现里面是空的(0 字节)。

给站长反馈

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

邮箱:lvyenet@vip.qq.com

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