一文带你掌握Go语言中的文件读取操作

2022-12-08 20:55

短信预约 -IT技能 免费直播动态提醒

os 包和 bufio 包

Go 标准库的 os 包，为我们提供很多操作文件的函数，如 Open(name) 打开文件、Create(name) 创建文件等函数，与之对应的是 bufio 包，os 包是直接对磁盘进行操作的，而 bufio 包则是带有缓冲的操作，不用每次都去操作磁盘。

os.Open 与 os.OpenFile 以及 File.Read

Open(name string) (*File, error)

通过 文件名 或 文件路径+文件名 的形式打开一个文件，此文件只能用于读操作，如果文件不存在则返回 PathError 。

参数 name 为文件名或文件路径+文件名。
返回值 *File 为一个 File 结构体的指针类型，通过指针可以对文件进行读写等操作。
返回值 error 为打开文件的过程中产生的错误。

OpenFile(name string, flag int, perm FileMode) (*File, error)

通过指定 文件名 或 文件路径+文件名、文件操作模式、文件权限三个参数打开一个文件，之后可对此文件进行读写操作。

参数 name 为文件名或文件路径+文件名。
参数 flag 为指定文件操作模式，可选值有 O_RDONLY → 只读操作、O_WRONLY → 只写操作、O_RDWR → 读写操作、O_APPEND → 写入时向文件追加数据、O_CREATE → 如果不存在，则创建一个新文件等。
参数 perm 参数表示文件的模式和权限，例如 0666 为读写权限。如果对文件权限所对应的数字不了解，可以去学习一下。
返回值 *File 为一个 File 结构体的指针类型，通过指针可以对文件进行读写等操作。
返回值 error 为打开文件的过程中产生的错误。

File.Read(b []byte) (n int, err error)

读取与 b 等长度的字节，并存储到 b 里面。

参数 b 为一个切片数组，用于指定读取长度和存储字节数据。
返回值 n 为所读取字节的长度。
返回值 error 为读取字节的过程中产生的错误。

读取文件操作

import (
	"fmt"
	"os"
)

func main() {
	file, err := os.Open("1.txt")
	if err != nil {
		fmt.Println(err)
		return
	}
	defer file.Close()
	data := make([]byte, 11)
	count, err := file.Read(data)
	if err != nil {
		return
	}
	fmt.Println("字节数据：", data)          // [72 101 108 108 111 32 119 111 114 108 100]
	fmt.Println("字符串数据：", string(data)) // Hello world
	fmt.Println("所获取字节的长度：", count)     // 11
}

执行结果：

字节数据： [72 101 108 108 111 32 119 111 114 108 100]
字符串数据： Hello world
所获取字节的长度： 11

首先通过 Open 函数打开 1.txt 文件，用 file 变量接收，默认为可读模式；
然后创建一个长度为 11 的字节切片，接着通过 file 变量的方法 Read 读取长度为 11 的字节数据。os.Open("1.txt") 等价于 os.OpenFile("1.txt", os.O_RDONLY, 0)。
最后打印读取到的数据。

bufio.NewReader 和 Reader.ReadString

读取文件，建议使用 bufio.NewReader 和 Reader.ReadString，减少磁盘的操作。

NewReader(rd io.Reader) *Reader 获取一个有缓冲区的 Reader 指针变量，缓冲区默认大小为 4096 字节。通过变量可以对数据进行读操作。

参数 rd 为一个接口，实现这个接口的数据类型变量都可以作为参数，例如上面提到的 File。
返回值 *Reader 为 Reader 结构体的指针，通过指针可以读取缓冲区的数据。

ReadString(delim byte) (string, error) 读取数据，直到第一次遇到分隔符 delim 为止。读取过程中发生错误会返回 EOF 错误信息。

参数 delim 为分隔符，每次读取时遇到分隔符就会终止。
第一个返回值为所读取的内容，内容包括分隔符。
第二个返回值为读取过程中产生的错误信息。

读取文件操作

1.txt 文件的内容为：

Hello world
Hello Golang
Hello Gopher

import (
	"bufio"
	"fmt"
	"io"
	"os"
	"strings"
)

func main() {
	file, err := os.OpenFile("1.txt", os.O_RDONLY, 0)
	if err != nil {
		fmt.Println(err)
		return
	}
	defer file.Close()
	reader := bufio.NewReader(file)
	for {
		if lineData, err := reader.ReadString('\n'); err != nil {
			if err == io.EOF {
				// 因为是以换行符为分隔符，如果最后一行没有换行符，那么返回 io.EOF 错误时，也是可能读到数据的，因此判断一下是否读到了数据
				if len(lineData) > 0 {
					fmt.Println(lineData)
				}
				break
			}
		} else {
			fmt.Println(strings.TrimRight(lineData, "\n"))
		}
	}
}

执行结果：

Hello World
Hello Golang
Hello Gopher

首先通过 OpenFile 函数打开 1.txt 文件，用 file 变量接收，指定为可读模式；
然后通过 NewReader 函数创建一个缓冲区，将默认长度的字节读取到缓冲区中；
接着通过 Reader 结构体的方法 ReadString，以 \n 为分隔符，按行读取数据，然后打印数据。
其中有一个注意点就是，因为是以换行符为分隔符，如果最后一行没有换行符，那么返回 io.EOF 错误时，也是可能读到数据的，因此需要判断一下是否读到了数据。

小结

本文先是对 os 包和 bufio 包进行简单的介绍，然后介绍 os 包里的 Open 和 OpenFile 函数以及 File 结构体的方法 Read，通过案例展示它们的使用方式。紧接着引出 bufio 包里的 NewReader 函数和 Reader 结构体的方法 ReadString，读取文件的操作推荐使用它们，能减少对磁盘的操作，高效读取数据。