Golang文件操作

一.Golang打开关闭文件

在Golang中我们操作文件时，需要先打开文件，打开文件操作完毕后，还需要关闭文件，如果只打开文件，不关闭文件，会造成系统资源的浪费。
在Golang中打开文件使用Open函数，关闭文件使用Close函数，打开文件、关闭文件以及大多数文件操作都涉及一个很重要的结构体os.File结构体。

1.1 os.File结构体

type File struct {
	*file // os specific
}
type file struct {
	pfd        poll.FD
	name       string
	dirinfo    *dirInfo // nil unless directory being read
	appendMode bool     // whether file is opened for appending
}

说明：
这里可以看到os.File结构体里面包含了一个file指针，file指针结构体有四个成员，分别为：

• pfd：是一个FD结构体类型，是一个文件的唯一标志，每一个被打开的文件在操作系统中，都会有一个文件标志符，来唯一标识一个文件，就是这里的pfd.
• name：文件名
• dirinfo：文件的路径信息，也是一个结构体
• appendMode：是一个bool类型，表明该文件是否可以被追加写入内容

1.2 Open函数

语法：

func Open(name string) (*File, error)

参数：

• name：文件名

返回值：

• File：打开的文件句柄
• err：如果打开失败，则返回错误信息，否则返回nil

说明
Open函数接受一个字符串类型的文件名作为参数，如果打开成功，则返回一个File结构体的指针，否则就返回error错误信息。

1.3 Close函数

语法：

func (file *File) Close() error

参数：

• file：打开的文件
  返回值
• error：如果打开失败则返回错误信息，否则返回nil
  说明：
  使用File指针来调用Close函数，如果关闭失败，则返回error错误信息。

1.4 示例说明

使用Open函数打开文件，使用Close函数关闭文件：

package main

import (
	"fmt"
	"os"
)

func main() {
	fmt.Println("Open File Test")
	fileName := "D:/go项目/test.go"
	file, err := os.Open(fileName)
	if err != nil {
		fmt.Println("Open file err:", err)
		return
	}
	fmt.Println("Open File Sucess")
	if err := file.Close(); err != nil {
		fmt.Println("Close File Err:", err)
		return
	}
	fmt.Println("Close File Success")
}

二.Golang读取文件

Golang中，读取文件有四种方法：分别为：

• ioutil.ReadFile读取文件
• file.Read读取文件
• bufio.NewReader读取文件
• ioutil.ReadAll读取文件

2.1 ioutil.ReadFile读取文件

语法：

func ReadFile(filename string) ([]byte, error) 

参数：

• filename：文件名
  返回值：

• []byte：读取到的文件内容

• error：如果读取失败，返回错误信息，否则返回nil
  说明：
  ioutil.ReadFile读取文件只需要传入一个文件名作为参数，读取成功，会将文件的内容作为一个字节数组返回，如果读取错误，返回error信息。
  使用ReadFile读取文件不需要手动打开与关闭文件，打开与关闭文件的动作，系统自动帮我们完成，同时使用ReadFile读取文件时，只适合读取小文件，不适合读取大文件。

• 示例说明

package main

import (
	"fmt"
	"io/ioutil"
)
func main() {
	fmt.Println("ioutil.ReadFile test")
	fileName := "D:/go项目/test.go"
	fileData, err := ioutil.ReadFile(fileName)
	if err != nil {
		fmt.Println("read file err:", err)
	}
	fmt.Println(string(fileData))
}

2.2 file.Read读取文件

语法：

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

参数：

• f：打开的文件句柄
• b：读取文件内容存放的指针
  返回值：
• n：读取到的字节数
• err：如果读取失败，返回错误信息，否则返回nil
  说明：
  使用file.Read读取文件时，首先我们需要打开文件，接着使用打开的文件返回的文件句柄来读取文件，文件读取结束的标志时返回的n等于0，如果我们需要读取整个文件内容，那么我们需要使用for循环不停的读取文件，直到n等于0.

2.3 NewReader读取文件

语法：

r := bufio.NewReader(file)
n, err := r.Read(buf)

参数：

• file：要读取的文件句柄
• buf：读取的数据存放的缓冲区
  返回值：
• n：读取到的长度
• err：读取失败，则返回错误信息
  说明：
  使用NewReader读取文件时，首先，我们需要打开文件，接着使用打开的文件返回的句柄当作函数参数传入NewReader，最后我们使用NewReader返回的reader对象调用Read读取文件，文件读取结束的标志是返回的n等于0，因此我们需要读取整个文件的内容，那么我们需要使用for循环不停的读取文件，直到n等于0.
• 示例说明：

package main

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

func main() {
	fmt.Println("Open File Test")
	fileName := "D:/01.代码目录/04.go项目/sensetime/metro-data-check.go"
	file, err := os.Open(fileName)
	if err != nil {
		fmt.Println("Open file err:", err)
		return
	}
	defer file.Close()
	var chunk []byte
	buf := make([]byte, 2048)
	for {
		r := bufio.NewReader(file)
		n, err := r.Read(buf)
		if err != nil && err != io.EOF {
			fmt.Println("read buf fail", err)
			return
		}
		if n == 0 {
			break
		}
		chunk = append(chunk, buf[:n]...)
	}
	fmt.Println("File content is:
", string(chunk))
}

2.4 ReadAll读取文件

语法：

func ReadAll(r io.Reader) ([]byte, error) 

参数：

• []byte：读取到的数据
• error：读取失败，则返回错误信息

说明：
使用ReadAll读取文件时，首先我们需要打开文件，接着使用打开的文件返回的文件句柄当作函数参数传入ReadAll，ReadAll函数会将整个文件的内容一次性读取出来，如果读取出错，则返回error信息。

示例说明：

package main

import (
	"fmt"
	"io/ioutil"
	"os"
)

func main() {
	fmt.Println("Open File Test")
	fileName := "D:/01.代码目录/04.go项目/sensetime/metro-data-check.go"
	file, err := os.Open(fileName)
	if err != nil {
		fmt.Println("Open file err:", err)
		return
	}
	defer file.Close()
	fileContent, err := ioutil.ReadAll(file)
	if err != nil {
		fmt.Println("Read file err: ", err)
	} else {
		fmt.Println("File Content:
", string(fileContent))
	}
}

参考文档：https://haicoder.net/golang/golang-file.html