一文掌握 Go 文件的写入操作

前言

通过案例展示如何读取文件里的内容。本文接着上篇文章的内容，介绍文件的写入操作。

File.Write、File.WriteString、File.WriteAt

File.Write(b []byte) (n int, err error)
直接操作磁盘往文件里写入数据，写入单位为字节。

b 参数：写入的数据，类型为字节切片。
返回值 n：写入的字节数。
返回值 err：写入数据的过程中产生的错误。

File.WriteString(s string) (n int, err error)
直接操作磁盘往指定文件里写入数据，写入单位为字符串。

s 参数：写入的字符串数据。
返回值 n：写入的字节数。
返回值 err：写入数据的过程中产生的错误。

File.WriteAt(b []byte, off int64) (n int, err error)
从指定位置 off 往文件里顺序写入数据，如果某个偏移量上有数据，则会覆盖。

b 参数：写入的数据，类型为字节切片。
off 参数：偏移量，从此位置开始写入数据。
返回值 n：写入的字节数。
返回值 err：写入数据的过程中产生的错误。

文件写入操作

import (
    "fmt"
    "os"
)

func main() {
    file, err := os.OpenFile("test.txt", os.O_CREATE, 0)
    if err != nil {
            fmt.Println(err)
            return
    }
    defer file.Close()
    count, err := file.Write([]byte{'H', 'e', 'l', 'l', 'o', ' ', 'W', 'o', 'r', 'l', 'd', '\n'})
    if err != nil {
            return
    }
    fmt.Printf("写入了 %d 字节\n", count)
    count, err = file.WriteString("Hello Golang")
    if err != nil {
            return
    }
    fmt.Printf("写入了长度为 %d 的字符串\n", count)
    count, err = file.WriteAt([]byte{'x', 'x', 'x', 'x', 'x', 'x', 'x', 'x', 'x', 'x', 'x'}, 0)
    if err != nil {
            return
    }
    fmt.Printf("写入了 %d 字节\n", count)
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

首先打开 test.txt 文件，指定的模式为 os.O_CREATE，如果文件不存在则会自动创建；
然后通过 Write 方法以字符的形式往文件里写入 Hello World\n 的内容；
接着通过 WriteString 方法以字符串的形式往文件里写入 Hello Golang 内容；此时文件里的内容如下所示：

Hello World
Hello Golang
1
2

最后通过 WriteAt 方法，指定从偏移量为 0 的位置开始写入数据 xxxxxxxxxxx，由于 0 以及之后位置都有数据，因此原有数据被覆盖了。最后文件的内容为：

xxxxxxxxxxx
Hello Golang
1
2

File.Seek

File.Seek(offset int64, whence int)
相对于开头位置或当前位置或末尾位置，将设置当前读或写的偏移量设置为 offset。

offset 参数：所要设置的偏移量。
whence：相对于哪个位置开始设置偏移量的标志，可选值为 0 → 开头位置，1 → 当前位置，2 → 末尾位置。

应用

import (
    "fmt"
    "os"
)

func main() {
    file, err := os.OpenFile("test.txt", os.O_CREATE, 0)
    if err != nil {
            fmt.Println(err)
            return
    }
    defer file.Close()
    _, err = file.WriteString("G0lang")
    if err != nil {
            return
    }
    _, err = file.Seek(1, 0)
    if err != nil {
            fmt.Println(err)
            return
    }
    _, err = file.Write([]byte{'o'})
    if err != nil {
            fmt.Println(err)
            return
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

打开 test.txt 文件，指定的模式为 os.O_CREATE，如果文件不存在则会自动创建；
使用 WriteString 方法往文件里写入 G0lang 字符串；
此时发现第二个字符错了，0 应该改成 o；此时的偏移量是指向尾部的；使用 Seek 方法将偏移量移到第二个位置，然后写入字符 o，由于当前位置已有数据 0，因此 o 将会覆盖 0；

bufio.NewWriter、Writer.WriteString、Writer.Flush

如果需要多次执行写入文件的操作，推荐使用 bufio 里的 Writer 结构体去操作，它会开辟一个缓冲区，默认大小为 4096 字节。在数据没有被刷入磁盘之前，所写入的数据都会暂时保存到缓冲区里。

NewWriter(w io.Writer) *Writer
开辟一个默认值为 4096 字节的缓冲区，用于暂存写入文件的数据内容，返回一个 Writer 结构体的指针变量

w 参数：类型为 Writer 接口，实现这个接口的数据类型变量都可以作为参数，例如 File。
返回值 *Writer：一个 Writer 结构体的指针变量，通过该变量可以往缓冲区里写入数据。

Writer.WriteString(s string) (int, error)
往缓冲区写入内容的方法。

参数 s 为写入的字符串。
第一个返回值为写入的字节数。
第二个返回值为写入数据的过程中产生的错误。

Writer.Flush() error
将所有的缓存数据写入磁盘。

返回值为数据写入磁盘的过程中产生的错误。

文件写入操作

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

func main() {
    file, err := os.OpenFile("test.txt", os.O_CREATE, 0)
    if err != nil {
            fmt.Println(err)
            return
    }
    defer file.Close()
    writer := bufio.NewWriter(file)
    _, err = writer.WriteString("Hello World\n")
    if err != nil {
            fmt.Println(err)
            return
    }
    _, err = writer.WriteString("Hello Golang\n")
    if err != nil {
            fmt.Println(err)
            return
    }
    _, err = writer.WriteString("Hello Gopher\n")
    if err != nil {
            fmt.Println(err)
            return
    }
    writer.Flush()
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

首先打开 test.txt 文件，指定的模式为 os.O_CREATE，如果文件不存在则会自动创建；
然后使用 NewWriter 函数获取一个 Writer 结构体的指针变量 writer；
接着通过 writer 的 WriteString 方法将内容保存到缓冲区里；
最后调用 Flush 方法，将所有的缓存数据写入磁盘。

小结

本文先是对 File.Write、File.WriteString、File.WriteAt 进行介绍，通过例子演示它们的使用方式；然后介绍 File.Seek，说明了它的用法；最后引出 bufio.NewWriter、Writer.WriteString、Writer.Flush，使用它们代替 File 结构体里的写入方法，可以不用频繁操作磁盘，提高写入效率。