Go语言（基础）——文件操作

1、前言

• Go 语言的 os 包，拥有对文件进行操作的一系列方法、函数。

2、文件操作——创建、打开、读、写

2.1、创建文件

2.1.1、os.Create(name string) (file *File, err error)

• Create采用模式0644（文件创建者可读写但不可执行，同组以及其他人都只可读，不可写和执行，这个地方感觉 Go 语言中文手册 那里写错了）创建一个名为name的文件，如果文件已存在会截断它（为空文件）。如果成功，返回的文件对象可用于I/O；对应的文件描述符具有O_RDWR模式。如果出错，err 不为 nil，错误底层类型是*PathError。以下为示例代码：

func CreateFile(filename string) {
	_, err := os.Create(filename)
	if err != nil {
		fmt.Println(err)
	} else {
		fmt.Println("create file successfully")
	}
}

func main() {
	CreateFile("golang.txt)
}

• 上述代码执行输出如下：

create file successfully

• 我们来看看文件的权限是怎么样的：
  
• 可以看到，文件的创建者 root 具有读写权限，同组成员以及其他用户都只有读权限。

2.1.2、os.OpenFile(name string, flag int, perm FileMode) (file *File, err error)

• OpenFile是一个更一般性的文件打开函数，大多数调用者都应用Open或Create代替本函数。它会使用指定的选项（如O_RDONLY等）、指定的模式（如0666等）打开指定名称的文件。如果操作成功，返回的文件对象可用于I/O。如果出错，err 不为 nil，错误底层类型是*PathError。

2.1.2.1、文件选项

• 注意：不是所有的 flag 都能在特定系统里使用！

const (
    O_RDONLY int = syscall.O_RDONLY // 只读模式打开文件
    O_WRONLY int = syscall.O_WRONLY // 只写模式打开文件
    O_RDWR   int = syscall.O_RDWR   // 读写模式打开文件
    O_APPEND int = syscall.O_APPEND // 写操作时将数据附加到文件尾部
    O_CREATE int = syscall.O_CREAT  // 如果不存在将创建一个新文件
    O_EXCL   int = syscall.O_EXCL   // 和O_CREATE配合使用，文件必须不存在
    O_SYNC   int = syscall.O_SYNC   // 打开文件用于同步I/O
    O_TRUNC  int = syscall.O_TRUNC  // 如果可能，打开时清空文件
)

2.1.2.2、文件模式

• 创建文件时，我们可以指定文件的权限，文件权限总共分三种：读（r）、写（w）、执行（x），其中：

读（r）：4
写（w）：2
执行（x）：1

• 然后一个文件可被拥有者、拥有者所在组里的其他成员、以及除此以外的其他成员读写或执行（在赋予相应的权限的前提下）。例如 0764 模式，代表的意思见下面的讲解：

其中 0 后面第一个位置处的 7 代表 4 + 2 + 1，即 rwx 权限，意思就是：文件拥有者可以读写并执行该文件
7 后面的 6 代表 4 + 2 + 0，即 rw- 权限，意思就是：文件拥有者所在的组里的其他成员可对文件进行读写操作
6 后面的 4 代表 4 + 0 + 0，即 r-- 权限，意思就是：除了上面提到的用户，其余用户只能对该文件进行读操作

2.1.2.3、创建一个不存在的文件，并且文件权限设为 rwxr-xr–

func OpenFile1(filename string) {
	_, err := os.OpenFile(filename, os.O_CREATE, 0754)
	if err != nil {
		fmt.Println(err)
	} else {
		fmt.Println("create file successfully")
	}
}

func main() {
	OpenFile1("golang1.txt")
}

• 执行以上函数，得到的输出是：

create file successfully

• 让我们去看看文件的权限是怎样的：
  

2.1.3、创建单级目录

• 创建单级目录用到的方法是 Mkdir(name string, perm FileMode) error。

func MkDir(dirname string, perm os.FileMode) {
	err := os.Mkdir(dirname, perm)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println(dirname, "创建成功")
}

func main() {
	MkDir("pic", 0740)
}

• 执行以上函数，得到的输出是：

pic 创建成功

• 但是上面的代码无法创建多级目录。

2.1.4、创建多级目录

• 创建多级目录用到的方法是 MkdirAll(path string, perm FileMode) error。权限位 perm 会应用在每一个被本函数创建的目录上。如果 path 指定了一个已经存在的目录，MkdirAll 不做任何操作并返回 nil。

func MkDirP(dirname string, perm os.FileMode) {
	err := os.MkdirAll(dirname, perm)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println(dirname, "创建成功")
}

func main() {
	MkDirP("picture/go", 0740)
}

• 执行以上函数，得到的输出是：

picture/go 创建成功

2.2、打开文件

2.2.1、os.Open(name string) (file *File, err error)

• Open打开一个文件用于读取。如果操作成功，返回的文件对象的方法可用于读取数据；对应的文件模式是 O_RDONLY 模式。

file, err := os.Open(filename)

2.2.2、os.OpenFile(name string, flag int, perm FileMode) (file *File, err error)

• 这个方法前面已经介绍过了，就不再介绍了。

2.3、读取文件内容

2.3.1、按字节读取

• 循环读
  读取的时候，要注意一个问题，就是文件有时候可能太大，需要我们循环多次去读取，这个时候需要设置两个“容器”，一个容器用来装每次读的内容，另一个容器用来累积读的所有内容，看下面示例代码：

func ReadFile(filename string) {
	file, _ := os.OpenFile(filename, os.O_RDONLY, 0400)
	var read_buffer = make([]byte, 10)
	var content_buffer = make([]byte, 0)
	fileinfo, _ := file.Stat()
	size := fileinfo.Size() //文件大小，单位是字节，int64
	var length int64 = 0 //标记已经读取了多少字节的内容
	for ; length < size; { //循环读取文件内容
		n, _ := file.Read(read_buffer)
		content_buffer = append(content_buffer, read_buffer[:n]...)
		length += int64(n)
	}
	fmt.Println(string(content_buffer))
}

func main() {
	ReadFile("golang.txt")
}

• 执行上面代码，得到输出如下：

hello, golang!
你好，go语言！
by wxy

• 一次性读取
  只要获取到了文件大小（以字节为单位），我们也可以一次性读取文件内容：

func ReadFile2(filename string) {
	file, _ := os.OpenFile(filename, os.O_RDONLY, 0400)
	fileinfo, _ := file.Stat()
	size := fileinfo.Size() //文件大小，单位是字节，int64
	var read_buffer = make([]byte, size) //直接一步到位
	var length int64 = 0 //标记已经读取了多少字节的内容
	for ; length < size; { //循环读取文件内容
		n, _ := file.Read(read_buffer)
		length += int64(n)
	}
	fmt.Println(string(read_buffer))
}

2.3.2、按行读取

• 在正式介绍怎么按行读取之前，先简单介绍一下 bufio.NewReader(rd io.Reader) Reader，NewReader创建一个具有默认大小缓冲、从r读取的Reader。看以下示例代码：

func ReadFile3(filename string) {
	file, _ := os.OpenFile(filename, os.O_RDONLY, 0400)
	reader := bufio.NewReader(file)
	for i := 1; ; i++ {
		//line, err := reader.ReadBytes('\n') //line 是一个[]byte
		line, err := reader.ReadString('\n') //line 是一个 string
		//ReadBytes 与 ReadString 两种方法都可以达到目的
		if err != nil && err != io.EOF {
			fmt.Println(err)
		}
		fmt.Printf("第%d行：%s", i, line)
		if err == io.EOF { //读到文件结尾就退出循环
			break
		}
	}
}

2.3.3、一次性读取全部

• 一次性全部读取，要用到 io/ioutil 包里的 ReadAll(r io.Reader) ([]byte, error) 方法，ReadAll 从 r 读取数据直到 EOF 或遇到 error，返回读取的数据和遇到的错误。成功的调用返回的 err 为 nil 而非 EOF。因为本函数定义为读取 r 直到 EOF，它不会将读取返回的 EOF 视为应报告的错误。看以下示例代码：

func ReadFile4(filename string) {
	file, _ := os.OpenFile(filename, os.O_RDONLY, 0400)
	data, err := ioutil.ReadAll(file) //data 是一个 []byte
	if err != nil {
		return
	}
	fmt.Printf("%s", data)
}

func main() {
	ReadFile4("golang.txt")
}

• 执行以上代码，得到输出如下：

hello, golang!
你好，go语言！
by wxy

2.4、写内容 >> 文件

2.4.1、写入字节流

func WriteByte(filename string, data []byte) {
	file, err := os.OpenFile(filename, os.O_CREATE | os.O_APPEND | os.O_WRONLY, 0200)
	if err != nil {
		fmt.Println(err)
		return
	}
	n, err := file.Write(data)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Printf("写入了%d字节的内容", n)
	file.Close()
}

func main() {
	WriteByte("golang.txt", []byte("2021-3-29"))
}

• 执行上述代码，输出结果为：

写入了9字节的内容

• 注意：上述代码中，打开文件的选项有一项 os.O_APPEND，这个很重要，有了这个，写文件是追加写，没有这个，写文件则是覆盖写。

2.4.2、写入字符串

func WriteString(filename string, data string) {
	file, err := os.OpenFile(filename, os.O_CREATE | os.O_APPEND | os.O_WRONLY, 0200)
	if err != nil {
		fmt.Println(err)
		return
	}
	n, err := file.WriteString(data)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Printf("写入了%d字节的内容", n)
	file.Close()
}

func main() {
	WriteString("golang.txt", "2021-3-29")
}

• 执行上述代码，输出结果为：

写入了9字节的内容

2.4.3、在指定位置处写入内容

func WriteAt(filename string, data []byte, offset int64) {
	file, err := os.OpenFile(filename, os.O_CREATE | os.O_WRONLY, 0200)
	if err != nil {
		fmt.Println(err)
		return
	}
	n, err := file.WriteAt(data, offset) //覆盖写
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Printf("写入了%d字节的内容", n)
	file.Close()
}

func main() {
	WriteAt("golang.txt", []byte("world, "), int64(7))
}

• 执行上述代码，输出结果为：

写入了7字节的内容

• 注意：打开文件的 os.O_APPEND 选项与 file.WriteAt 冲突，两个不能同时出现。

os: invalid use of WriteAt on file opened with O_APPEND

3、文件的其它操作

3.1、判断文件存不存在

• 判断文件存不存在用到了 os.Stat(filename string) 方法，该方法返回一个 FileInfo 和一个 error，通过 error 和 os.IsNotExist(error) 判断出文件存不存在，其中 FileInfo 的结构如下所示，通过它，我们能了解到许多有关文件的信息。

type FileInfo interface {
	Name() string       // base name of the file
	Size() int64        // length in bytes for regular files; system-dependent for others
	Mode() FileMode     // file mode bits
	ModTime() time.Time // modification time
	IsDir() bool        // abbreviation for Mode().IsDir()
	Sys() interface{}   // underlying data source (can return nil)
}

• 判断文件存不存在代码如下所示：

func IsExist(filename string) {
	_, err := os.Stat(filename)
	if err != nil && !os.IsNotExist(err) {
		fmt.Println(err)
		return
	}
	if os.IsNotExist(err) {
		fmt.Println(filename, "不存在")
	} else {
		fmt.Println(filename, "存在")
	}
}

func main() {
	IsExist("os.txt")
}

• 执行上述代码，输出结果为：

os.txt 不存在

3.2、删除文件或目录

3.2.1、删除文件或单级目录

• os.Remove(name string) 只能删除空目录或文件。

func Remove(name string) {
	err := os.Remove(name)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println("删除", name, "成功")
}

func main() {
	Remove("picture")
}

• 因为 picture 文件夹下还有一个文件夹 go，所以删除失败，程序执行结果如下：

remove picture: The directory is not empty.

3.2.2、删除文件或多级目录

• 删除多级目录用到的方法是 os.RemoveAll(path string)，RemoveAll 删除 path 指定的文件，或目录及它包含的任何下级对象。它会尝试删除所有东西，除非遇到错误并返回。如果 path 指定的对象不存在，RemoveAll 会返回 nil 而不返回错误。
• 下面这幅图这是 picture/go 的目录结构，现在，我要删除 picture 目录及其里面的所有对象。
  

func RemoveP(name string) {
	err := os.RemoveAll(name)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println("删除", name, "成功")
}

func main() {
	RemoveP("picture")
}

• 执行上述代码，输出结果为：

删除 picture 成功