文件操作

计算机中的文件是存储在外部介质(通常是磁盘)上的数据集合，文件分为文本文件和二进制文件。

打开和关闭文件

os.Open()函数能够打开一个文件，返回一个*File和一个err。对得到的文件实例调用close()方法能够关闭文件。

package main

import (
	"fmt"
	"os"
)

func main() {
    // 只读方式打开当前目录下的 main.go 文件
	file, err := os.Open("./main.go")
	if err != nil {
		fmt.Println("open file failed, err:", err)
		return
	}
	// 关闭文件
	defer file.Close()
}

为了防止文件忘记关闭，我们通常使用 defer 注册文件关闭语句。

读取文件

file.Read()

基本使用

Read 方法定义如下：

func (f *File) Read(b []byte) (n int, err error)

它接收一个字节切片，返回读取的字节数和可能的具体错误，读到文件末尾时会返回0和io.EOF。举个例子：

package main

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

func main() {
	// 只读方式打开当前目录下的 main.go 文件
	file, err := os.Open("./main.go")
	if err != nil {
		fmt.Println("open file failed, err:", err)
		return
	}
	defer file.Close()
	// 使用 Read 方法读取数据
	tmp := make([]byte, 128)
	n, err := file.Read(tmp)
	if err == io.EOF {
		fmt.Println("file read finished")
		return
	}
	if err != nil {
		fmt.Println("read file failed, err:", err)
		return
	}
	fmt.Printf("read %d bytes data\n", n)
	fmt.Println(string(tmp[:n]))
}

循环读取

使用 for 循环读取文件中的所有数据。

package main

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

func main() {
	// 只读方式打开当前目录下的 main.go 文件
	file, err := os.Open("./main.go")
	if err != nil {
		fmt.Println("open file failed, err:", err)
		return
	}
	defer file.Close()
	var content []byte
	// 循环读取文件
	tmp := make([]byte, 128)
	for {
		n, err := file.Read(tmp)
		if err == io.EOF {
			fmt.Println("file read finished")
			break
		}
		if err != nil {
			fmt.Println("read file failed, err:", err)
			return
		}
		content = append(content, tmp[:n]...)
	}

	fmt.Println(string(content))
}

bufio 读取文件

bufio 是在 file 的基础上封装了一层 API，支持更多的功能。

package main

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

func main() {
	file, err := os.Open("./main.go")
	if err != nil {
		fmt.Println("open file failed, err:", err)
		return
	}
	defer file.Close()
	scanner := bufio.NewScanner(file) // MaxScanTokenSize = 64 * 1024
	for scanner.Scan() {
		fmt.Println(scanner.Text())
	}
	if err := scanner.Err(); err != nil {
		fmt.Println("read file failed, err:", err)
	}
}

读取整个文件

os(Go1.16之前io/ioutil)包的ReadFile函数能够读取完整的文件，只需要将文件名作为参数传入。

package main

import (
	"fmt"
	"os"
)

// os.ReadFile 读取整个文件
func main() {
	content, err := os.ReadFile("./main.go")
	if err != nil {
		fmt.Println("read file failed, err:", err)
		return
	}
	fmt.Println(string(content))
}

文件写入操作

os.OpenFile()函数能够以指定模式打开文件，从而实现文件写入相关功能。

func OpenFile(name string, flag int, perm FileMode) (*File, error) {
	// ...
}

其中：

• name：要打开的文件名。
• flag：打开文件的模式。

模式有以下几种：

模式	含义
os.O_WRONLY	只写
os.O_CREATE	创建文件
os.O_RDONLY	只读
os.O_RD_WE	读写
os.O_TRUNC	清空
os.O_APPEND	追加

perm：文件权限，一个八进制数。r(读)04，w(写)02，x(执行)01。

Write 和 WriteString

func main() {
	file, err := os.OpenFile("xx.txt", os.O_CREATE|os.O_TRUNC|os.O_WRONLY, 0666)
	if err != nil {
		fmt.Println("open file failed, err:", err)
		return
	}
	defer file.Close()
	str := "hello 沙河"
	file.Write([]byte(str))       // 写入字节切片数据
	file.WriteString("hello 小王子") // 直接写入字符串数据
}

os.WriteFile

os(Go1.16之前io/ioutil)包的os.WriteFile函数可直接向文件写入指定内容。

func writeFile() {
	str := "hello 沙河"
	err := os.WriteFile("./xx.txt", []byte(str), 0666)
	if err != nil {
		fmt.Println("write file failed, err:", err)
		return
	}
}

bufio.NewWriter

func main() {
	file, err := os.OpenFile("xx.txt", os.O_CREATE|os.O_TRUNC|os.O_WRONLY, 0666)
	if err != nil {
		fmt.Println("open file failed, err:", err)
		return
	}
	defer file.Close()
	writer := bufio.NewWriter(file)
	for i := 0; i < 10; i++ {
		writer.WriteString("hello\"沙河\"\n") // 将数据先写入缓存
	}
	writer.Flush()
}

练习

copyFile

借助io.Copy()实现一个拷贝文件函数。

package main

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

func main() {
	_, err := CopyFile("main.go.bk", "main.go")
	if err != nil {
		fmt.Println("copy file failed, err:", err)
		return
	}
	fmt.Println("copy done!")
}

// CopyFile 拷贝文件函数
func CopyFile(dstName, srcName string) (written int64, err error) {
	srcFile, err := os.Open(srcName)
	if err != nil {
		fmt.Println("open src file failed, err:", err)
		return
	}
	defer srcFile.Close()
	dstFile, err := os.OpenFile(dstName, os.O_CREATE|os.O_TRUNC|os.O_WRONLY, 0644)
	if err != nil {
		fmt.Println("open src file failed, err:", err)
		return
	}
	defer dstFile.Close()
	return io.Copy(dstFile, srcFile)
}

实现一个 cat 命令

使用文件操作相关知识，模拟实现 linux 平台cat命令的功能。

package main

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

func main() {
	if len(os.Args) == 0 {
		// 如果没有参数默认从标准输入读取内容
		cat(bufio.NewReader(os.Stdin))
	}
	for i := 0; i < len(os.Args); i++ {
		f, err := os.Open(os.Args[i])
		if err != nil {
			fmt.Fprintf(os.Stdout, "reading from %s failed, err: %v\n", os.Args[i], err)
			continue
		}
		cat(bufio.NewReader(f))
	}
}

// cat 命令实现
func cat(r *bufio.Reader) {
	for {
		buf, err := r.ReadBytes('\n') // 注意是字符
		if err == io.EOF {
			// 退出之前将已读到的内容输出
			fmt.Fprintf(os.Stdout, "%s", buf)
			break
		}
		fmt.Fprintf(os.Stdout, "%s", buf)
	}
}