Golang读写文件的几种方式
Posted Golang语言社区
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Golang读写文件的几种方式相关的知识，希望对你有一定的参考价值。
最近在使用Golang进行文件读写的过程中，遇到几个细节问题导致程序写入数据时有一定脏数据的残留，最后发现是使用os.OpenFile在进行文件操作的时候没有使用正确的flag造成的。因此专门去学习了下Golang中读写文件的几种方式方法。
读文件
使用golang语言去读取一个文件默认会有多种方式，这里主要介绍以下几种。
使用ioutil直接读取
需要引入io/ioutil包，该包默认拥有以下函数供用户调用。
1func NopCloser(r io.Reader) io.ReadCloser
2func ReadAll(r io.Reader) ([]byte, error)
3func ReadDir(dirname string) ([]os.FileInfo, error)
4func ReadFile(filename string) ([]byte, error)
5func TempDir(dir, prefix string) (name string, err error)
6func TempFile(dir, prefix string) (f *os.File, err error)
7func WriteFile(filename string, data []byte, perm os.FileMode) error
8
读文件，我们可以看以下三个函数:
1//从一个io.Reader类型中读取内容直到返回错误或者EOF时返回读取的数据，当err == nil时，数据成功读取到[]byte中
2//ReadAll函数被定义为从源中读取数据直到EOF，它是不会去从返回数据中去判断EOF来作为读取成功的依据
3func ReadAll(r io.Reader) ([]byte, error)
4
5//读取一个目录，并返回一个当前目录下的文件对象列表和错误信息
6func ReadDir(dirname string) ([]os.FileInfo, error)
7
8//读取文件内容，并返回[]byte数据和错误信息。err == nil时，读取成功
9func ReadFile(filename string) ([]byte, error)
读取文件示例:
1$ cat readfile.go
2package main
3import (
4 "fmt"
5 "io/ioutil"
6 "strings"
7)
8func main() {
9 Ioutil("mytestfile.txt")
10 }
11
12func Ioutil(name string) {
13 if contents,err := ioutil.ReadFile(name);err == nil {
14 //因为contents是[]byte类型，直接转换成string类型后会多一行空格,需要使用strings.Replace替换换行符
15 result := strings.Replace(string(contents),"\n","",1)
16 fmt.Println(result)
17 }
18 }
19
20$ go run readfile.go
21xxbandy.github.io @by Andy_xu
借助os.Open进行读取文件
由于os.Open是打开一个文件并返回一个文件对象，因此其实可以结合ioutil.ReadAll(r io.Reader)来进行读取。io.Reader其实是一个包含Read方法的接口类型，而文件对象本身是实现了了Read方法的。
我们先来看下os.Open家族的相关函数
1//打开一个需要被读取的文件，如果成功读取，返回的文件对象将可用被读取，该函数默认的权限为O_RDONLY，也就是只对文件有只读权限。如果有错误，将返回*PathError类型
2func Open(name string) (*File, error)
3
4//大部分用户会选择该函数来代替Open or Create函数。该函数主要用来指定参数(os.O_APPEND|os.O_CREATE|os.O_WRONLY)以及文件权限(0666)来打开文件，如果打开成功返回的文件对象将被用作I/O操作
5func OpenFile(name string, flag int, perm FileMode) (*File, error)
6
使用os.Open家族函数和ioutil.ReadAll()读取文件示例:
1func OsIoutil(name string) {
2 if fileObj,err := os.Open(name);err == nil {
3 //if fileObj,err := os.OpenFile(name,os.O_RDONLY,0644); err == nil {
4 defer fileObj.Close()
5 if contents,err := ioutil.ReadAll(fileObj); err == nil {
6 result := strings.Replace(string(contents),"\n","",1)
7 fmt.Println("Use os.Open family functions and ioutil.ReadAll to read a file contents:",result)
8 }
9
10 }
11}
12
13# 在main函数中调用OsIoutil(name)函数就可以读取文件内容了
14$ go run readfile.go
15Use os.Open family functions and ioutil.ReadAll to read a file contents: xxbandy.github.io @by Andy_xu
然而上述方式会比较繁琐一些，因为使用了os的同时借助了ioutil,但是在读取大文件的时候还是比较有优势的。不过读取小文件可以直接使用文件对象的一些方法。
不论是上边说的os.Open还是os.OpenFile他们最终都返回了一个*File文件对象，而该文件对象默认是有很多方法的，其中读取文件的方法有如下几种:
1//从文件对象中读取长度为b的字节，返回当前读到的字节数以及错误信息。因此使用该方法需要先初始化一个符合内容大小的空的字节列表。读取到文件的末尾时，该方法返回0，io.EOF
2func (f *File) Read(b []byte) (n int, err error)
3
4//从文件的off偏移量开始读取长度为b的字节。返回读取到字节数以及错误信息。当读取到的字节数n小于想要读取字节的长度len(b)的时候，该方法将返回非空的error。当读到文件末尾时，err返回io.EOF
5func (f *File) ReadAt(b []byte, off int64) (n int, err error)
6
使用文件对象的Read方法读取：
1func FileRead(name string) {
2 if fileObj,err := os.Open(name);err == nil {
3 defer fileObj.Close()
4 //在定义空的byte列表时尽量大一些，否则这种方式读取内容可能造成文件读取不完整
5 buf := make([]byte, 1024)
6 if n,err := fileObj.Read(buf);err == nil {
7 fmt.Println("The number of bytes read:"+strconv.Itoa(n),"Buf length:"+strconv.Itoa(len(buf)))
8 result := strings.Replace(string(buf),"\n","",1)
9 fmt.Println("Use os.Open and File's Read method to read a file:",result)
10 }
11 }
12}
使用os.Open和bufio.Reader读取文件内容
bufio包实现了缓存IO,它本身包装了io.Reader和io.Writer对象，创建了另外的Reader和Writer对象，不过该种方式是带有缓存的，因此对于文本I/O来说，该包是提供了一些便利的。
先看下bufio模块下的相关的Reader函数方法：
1//首先定义了一个用来缓冲io.Reader对象的结构体，同时该结构体拥有以下相关的方法
2type Reader struct {
3}
4
5//NewReader函数用来返回一个默认大小buffer的Reader对象(默认大小好像是4096) 等同于NewReaderSize(rd,4096)
6func NewReader(rd io.Reader) *Reader
7
8//该函数返回一个指定大小buffer(size最小为16)的Reader对象，如果 io.Reader参数已经是一个足够大的Reader，它将返回该Reader
9func NewReaderSize(rd io.Reader, size int) *Reader
10
11
12//该方法返回从当前buffer中能被读到的字节数
13func (b *Reader) Buffered() int
14
15//Discard方法跳过后续的 n 个字节的数据，返回跳过的字节数。如果0 <= n <= b.Buffered(),该方法将不会从io.Reader中成功读取数据。
16func (b *Reader) Discard(n int) (discarded int, err error)
17
18//Peekf方法返回缓存的一个切片，该切片只包含缓存中的前n个字节的数据
19func (b *Reader) Peek(n int) ([]byte, error)
20
21//把Reader缓存对象中的数据读入到[]byte类型的p中，并返回读取的字节数。读取成功，err将返回空值
22func (b *Reader) Read(p []byte) (n int, err error)
23
24//返回单个字节，如果没有数据返回err
25func (b *Reader) ReadByte() (byte, error)
26
27//该方法在b中读取delimz之前的所有数据，返回的切片是已读出的数据的引用，切片中的数据在下一次的读取操作之前是有效的。如果未找到delim，将返回查找结果并返回nil空值。因为缓存的数据可能被下一次的读写操作修改，因此一般使用ReadBytes或者ReadString，他们返回的都是数据拷贝
28func (b *Reader) ReadSlice(delim byte) (line []byte, err error)
29
30//功能同ReadSlice，返回数据的拷贝
31func (b *Reader) ReadBytes(delim byte) ([]byte, error)
32
33//功能同ReadBytes,返回字符串
34func (b *Reader) ReadString(delim byte) (string, error)
35
36//该方法是一个低水平的读取方式，一般建议使用ReadBytes('\n') 或 ReadString('\n')，或者使用一个 Scanner来代替。ReadLine 通过调用 ReadSlice 方法实现，返回的也是缓存的切片，用于读取一行数据，不包括行尾标记（\n 或 \r\n）
37func (b *Reader) ReadLine() (line []byte, isPrefix bool, err error)
38
39//读取单个UTF-8字符并返回一个rune和字节大小
40func (b *Reader) ReadRune() (r rune, size int, err error)
41
示例：
1func BufioRead(name string) {
2 if fileObj,err := os.Open(name);err == nil {
3 defer fileObj.Close()
4 //一个文件对象本身是实现了io.Reader的 使用bufio.NewReader去初始化一个Reader对象，存在buffer中的，读取一次就会被清空
5 reader := bufio.NewReader(fileObj)
6 //使用ReadString(delim byte)来读取delim以及之前的数据并返回相关的字符串.
7 if result,err := reader.ReadString(byte('@'));err == nil {
8 fmt.Println("使用ReadSlince相关方法读取内容:",result)
9 }
10 //注意:上述ReadString已经将buffer中的数据读取出来了，下面将不会输出内容
11 //需要注意的是，因为是将文件内容读取到[]byte中，因此需要对大小进行一定的把控
12 buf := make([]byte,1024)
13 //读取Reader对象中的内容到[]byte类型的buf中
14 if n,err := reader.Read(buf); err == nil {
15 fmt.Println("The number of bytes read:"+strconv.Itoa(n))
16 //这里的buf是一个[]byte，因此如果需要只输出内容，仍然需要将文件内容的换行符替换掉
17 fmt.Println("Use bufio.NewReader and os.Open read file contents to a []byte:",string(buf))
18 }
19
20
21 }
22}
读取文件全部示例
1/**
2 * @File Name: readfile.go
3 * @Author:Andy_xu @xxbandy.github.io
4 * @Email:371990778@qq.com
5 * @Create Date: 2017-12-16 16:12:01
6 * @Last Modified: 2017-12-17 12:12:02
7 * @Description:读取指定文件的几种方法，需要注意的是[]byte类型在转换成string类型的时候，都会在最后多一行空格，需要使用result := strings.Replace(string(contents),"\n","",1) 方式替换换行符
8 */
9package main
10import (
11 "fmt"
12 "io/ioutil"
13 "strings"
14 "os"
15 "strconv"
16 "bufio"
17)
18
19func main() {
20 Ioutil("mytestfile.txt")
21 OsIoutil("mytestfile.txt")
22 FileRead("mytestfile.txt")
23 BufioRead("mytestfile.txt")
24 }
25
26
27func Ioutil(name string) {
28 if contents,err := ioutil.ReadFile(name);err == nil {
29 //因为contents是[]byte类型，直接转换成string类型后会多一行空格,需要使用strings.Replace替换换行符
30 result := strings.Replace(string(contents),"\n","",1)
31 fmt.Println("Use ioutil.ReadFile to read a file:",result)
32 }
33 }
34
35func OsIoutil(name string) {
36 if fileObj,err := os.Open(name);err == nil {
37 //if fileObj,err := os.OpenFile(name,os.O_RDONLY,0644); err == nil {
38 defer fileObj.Close()
39 if contents,err := ioutil.ReadAll(fileObj); err == nil {
40 result := strings.Replace(string(contents),"\n","",1)
41 fmt.Println("Use os.Open family functions and ioutil.ReadAll to read a file :",result)
42 }
43
44 }
45}
46
47
48func FileRead(name string) {
49 if fileObj,err := os.Open(name);err == nil {
50 defer fileObj.Close()
51 //在定义空的byte列表时尽量大一些，否则这种方式读取内容可能造成文件读取不完整
52 buf := make([]byte, 1024)
53 if n,err := fileObj.Read(buf);err == nil {
54 fmt.Println("The number of bytes read:"+strconv.Itoa(n),"Buf length:"+strconv.Itoa(len(buf)))
55 result := strings.Replace(string(buf),"\n","",1)
56 fmt.Println("Use os.Open and File's Read method to read a file:",result)
57 }
58 }
59}
60
61func BufioRead(name string) {
62 if fileObj,err := os.Open(name);err == nil {
63 defer fileObj.Close()
64 //一个文件对象本身是实现了io.Reader的 使用bufio.NewReader去初始化一个Reader对象，存在buffer中的，读取一次就会被清空
65 reader := bufio.NewReader(fileObj)
66 //使用ReadString(delim byte)来读取delim以及之前的数据并返回相关的字符串.
67 if result,err := reader.ReadString(byte('@'));err == nil {
68 fmt.Println("使用ReadSlince相关方法读取内容:",result)
69 }
70 //注意:上述ReadString已经将buffer中的数据读取出来了，下面将不会输出内容
71 //需要注意的是，因为是将文件内容读取到[]byte中，因此需要对大小进行一定的把控
72 buf := make([]byte,1024)
73 //读取Reader对象中的内容到[]byte类型的buf中
74 if n,err := reader.Read(buf); err == nil {
75 fmt.Println("The number of bytes read:"+strconv.Itoa(n))
76 //这里的buf是一个[]byte，因此如果需要只输出内容，仍然需要将文件内容的换行符替换掉
77 fmt.Println("Use bufio.NewReader and os.Open read file contents to a []byte:",string(buf))
78 }
79
80
81 }
82}
写文件
那么上述几种方式来读取文件的方式也支持文件的写入，相关的方法如下:
使用ioutil包进行文件写入
1// 写入[]byte类型的data到filename文件中，文件权限为perm
2func WriteFile(filename string, data []byte, perm os.FileMode) error
示例:
1$ cat writefile.go
2/**
3 * @File Name: writefile.go
4 * @Author:
5 * @Email:
6 * @Create Date: 2017-12-17 12:12:09
7 * @Last Modified: 2017-12-17 12:12:30
8 * @Description:使用多种方式将数据写入文件
9 */
10package main
11import (
12 "fmt"
13 "io/ioutil"
14)
15
16func main() {
17 name := "testwritefile.txt"
18 content := "Hello, xxbandy.github.io!\n"
19 WriteWithIoutil(name,content)
20}
21
22//使用ioutil.WriteFile方式写入文件,是将[]byte内容写入文件,如果content字符串中没有换行符的话，默认就不会有换行符
23func WriteWithIoutil(name,content string) {
24 data := []byte(content)
25 if ioutil.WriteFile(name,data,0644) == nil {
26 fmt.Println("写入文件成功:",content)
27 }
28 }
29
30# 会有换行符
31$ go run writefile.go
32写入文件成功: Hello, xxbandy.github.io!
使用os.Open相关函数进行文件写入
因为os.Open系列的函数会打开文件，并返回一个文件对象指针，而该文件对象是一个定义的结构体，拥有一些相关写入的方法。
文件对象结构体以及相关写入文件的方法:
1//写入长度为b字节切片到文件f中，返回写入字节号和错误信息。当n不等于len(b)时，将返回非空的err
2func (f *File) Write(b []byte) (n int, err error)
3//在off偏移量出向文件f写入长度为b的字节
4func (f *File) WriteAt(b []byte, off int64) (n int, err error)
5//类似于Write方法，但是写入内容是字符串而不是字节切片
6func (f *File) WriteString(s string) (n int, err error)
7
注意：使用WriteString()j进行文件写入发现经常新内容写入时无法正常覆盖全部新内容。(是因为字符串长度不一样)
示例：
1//使用os.OpenFile()相关函数打开文件对象，并使用文件对象的相关方法进行文件写入操作
2func WriteWithFileWrite(name,content string){
3 fileObj,err := os.OpenFile(name,os.O_RDWR|os.O_CREATE|os.O_TRUNC,0644)
4 if err != nil {
5 fmt.Println("Failed to open the file",err.Error())
6 os.Exit(2)
7 }
8 defer fileObj.Close()
9 if _,err := fileObj.WriteString(content);err == nil {
10 fmt.Println("Successful writing to the file with os.OpenFile and *File.WriteString method.",content)
11 }
12 contents := []byte(content)
13 if _,err := fileObj.Write(contents);err == nil {
14 fmt.Println("Successful writing to thr file with os.OpenFile and *File.Write method.",content)
15 }
16}
注意:使用os.OpenFile(name string, flag int, perm FileMode)打开文件并进行文件内容更改，需要注意flag相关的参数以及含义。
1const (
2 O_RDONLY int = syscall.O_RDONLY // 只读打开文件和os.Open()同义
3 O_WRONLY int = syscall.O_WRONLY // 只写打开文件
4 O_RDWR int = syscall.O_RDWR // 读写方式打开文件
5 O_APPEND int = syscall.O_APPEND // 当写的时候使用追加模式到文件末尾
6 O_CREATE int = syscall.O_CREAT // 如果文件不存在，此案创建
7 O_EXCL int = syscall.O_EXCL // 和O_CREATE一起使用, 只有当文件不存在时才创建
8 O_SYNC int = syscall.O_SYNC // 以同步I/O方式打开文件，直接写入硬盘.
9 O_TRUNC int = syscall.O_TRUNC // 如果可以的话，当打开文件时先清空文件
10)
使用io包中的相关函数写入文件
在io包中有一个WriteString()函数，用来将字符串写入一个Writer对象中。
1//将字符串s写入w(可以是一个[]byte)，如果w实现了一个WriteString方法，它可以被直接调用。否则w.Write会再一次被调用
2func WriteString(w Writer, s string) (n int, err error)
3
4//Writer对象的定义
5type Writer interface {
6 Write(p []byte) (n int, err error)
7}
示例:
1//使用io.WriteString()函数进行数据的写入
2func WriteWithIo(name,content string) {
3 fileObj,err := os.OpenFile(name,os.O_RDWR|os.O_CREATE|os.O_APPEND,0644)
4 if err != nil {
5 fmt.Println("Failed to open the file",err.Error())
6 os.Exit(2)
7 }
8 if _,err := io.WriteString(fileObj,content);err == nil {
9 fmt.Println("Successful appending to the file with os.OpenFile and io.WriteString.",content)
10 }
11}
使用bufio包中的相关函数写入文件
bufio和io包中很多操作都是相似的，唯一不同的地方是bufio提供了一些缓冲的操作，如果对文件I/O操作比较频繁的，使用bufio还是能增加一些性能的。
在bufio包中，有一个Writer结构体，而其相关的方法也支持一些写入操作。
1//Writer是一个空的结构体，一般需要使用NewWriter或者NewWriterSize来初始化一个结构体对象
2type Writer struct {
3 // contains filtered or unexported fields
4}
5
6//NewWriterSize和NewWriter函数
7//返回默认缓冲大小的Writer对象(默认是4096)
8func NewWriter(w io.Writer) *Writer
9
10//指定缓冲大小创建一个Writer对象
11func NewWriterSize(w io.Writer, size int) *Writer
12
13//Writer对象相关的写入数据的方法
14
15//把p中的内容写入buffer,返回写入的字节数和错误信息。如果nn<len(p),返回错误信息中会包含为什么写入的数据比较短
16func (b *Writer) Write(p []byte) (nn int, err error)
17//将buffer中的数据写入 io.Writer
18func (b *Writer) Flush() error
19
20//以下三个方法可以直接写入到文件中
21//写入单个字节
22func (b *Writer) WriteByte(c byte) error
23//写入单个Unicode指针返回写入字节数错误信息
24func (b *Writer) WriteRune(r rune) (size int, err error)
25//写入字符串并返回写入字节数和错误信息
26func (b *Writer) WriteString(s string) (int, error)
27
注意：如果需要再写入文件时利用缓冲的话只能使用bufio包中的Write方法
示例:
1//使用bufio包中Writer对象的相关方法进行数据的写入
2func WriteWithBufio(name,content string) {
3 if fileObj,err := os.OpenFile(name,os.O_RDWR|os.O_CREATE|os.O_APPEND,0644);err == nil {
4 defer fileObj.Close()
5 writeObj := bufio.NewWriterSize(fileObj,4096)
6 //
7 if _,err := writeObj.WriteString(content);err == nil {
8 fmt.Println("Successful appending buffer and flush to file with bufio's Writer obj WriteString method",content)
9 }
10
11 //使用Write方法,需要使用Writer对象的Flush方法将buffer中的数据刷到磁盘
12 buf := []byte(content)
13 if _,err := writeObj.Write(buf);err == nil {
14 fmt.Println("Successful appending to the buffer with os.OpenFile and bufio's Writer obj Write method.",content)
15 if err := writeObj.Flush(); err != nil {panic(err)}
16 fmt.Println("Successful flush the buffer data to file ",content)
17 }
18 }
19}
写文件全部示例
1/**
2 * @File Name: writefile.go
3 * @Author:Andy_xu @xxbandy.github.io
4 * @Email:371990778@qq.com
5 * @Create Date: 2017-12-17 12:12:09
6 * @Last Modified: 2017-12-17 23:12:10
7 * @Description:使用多种方式将数据写入文件
8 */
9package main
10import (
11 "os"
12 "io"
13 "fmt"
14 "io/ioutil"
15 "bufio"
16)
17
18func main() {
19 name := "testwritefile.txt"
20 content := "Hello, xxbandy.github.io!\n"
21 WriteWithIoutil(name,content)
22 contents := "Hello, xuxuebiao\n"
23 //清空一次文件并写入两行contents
24 WriteWithFileWrite(name,contents)
25 WriteWithIo(name,content)
26 //使用bufio包需要将数据先读到buffer中，然后在flash到磁盘中
27 WriteWithBufio(name,contents)
28}
29
30//使用ioutil.WriteFile方式写入文件,是将[]byte内容写入文件,如果content字符串中没有换行符的话，默认就不会有换行符
31func WriteWithIoutil(name,content string) {
32 data := []byte(content)
33 if ioutil.WriteFile(name,data,0644) == nil {
34 fmt.Println("写入文件成功:",content)
35 }
36 }
37
38//使用os.OpenFile()相关函数打开文件对象，并使用文件对象的相关方法进行文件写入操作
39//清空一次文件
40func WriteWithFileWrite(name,content string){
41 fileObj,err := os.OpenFile(name,os.O_RDWR|os.O_CREATE|os.O_TRUNC,0644)
42 if err != nil {
43 fmt.Println("Failed to open the file",err.Error())
44 os.Exit(2)
45 }
46 defer fileObj.Close()
47 if _,err := fileObj.WriteString(content);err == nil {
48 fmt.Println("Successful writing to the file with os.OpenFile and *File.WriteString method.",content)
49 }
50 contents := []byte(content)
51 if _,err := fileObj.Write(contents);err == nil {
52 fmt.Println("Successful writing to thr file with os.OpenFile and *File.Write method.",content)
53 }
54}
55
56
57//使用io.WriteString()函数进行数据的写入
58func WriteWithIo(name,content string) {
59 fileObj,err := os.OpenFile(name,os.O_RDWR|os.O_CREATE|os.O_APPEND,0644)
60 if err != nil {
61 fmt.Println("Failed to open the file",err.Error())
62 os.Exit(2)
63 }
64 if _,err := io.WriteString(fileObj,content);err == nil {
65 fmt.Println("Successful appending to the file with os.OpenFile and io.WriteString.",content)
66 }
67}
68
69//使用bufio包中Writer对象的相关方法进行数据的写入
70func WriteWithBufio(name,content string) {
71 if fileObj,err := os.OpenFile(name,os.O_RDWR|os.O_CREATE|os.O_APPEND,0644);err == nil {
72 defer fileObj.Close()
73 writeObj := bufio.NewWriterSize(fileObj,4096)
74 //
75 if _,err := writeObj.WriteString(content);err == nil {
76 fmt.Println("Successful appending buffer and flush to file with bufio's Writer obj WriteString method",content)
77 }
78
79 //使用Write方法,需要使用Writer对象的Flush方法将buffer中的数据刷到磁盘
80 buf := []byte(content)
81 if _,err := writeObj.Write(buf);err == nil {
82 fmt.Println("Successful appending to the buffer with os.OpenFile and bufio's Writer obj Write method.",content)
83 if err := writeObj.Flush(); err != nil {panic(err)}
84 fmt.Println("Successful flush the buffer data to file ",content)
85 }
86 }
87}
版权申明：内容来源网络，版权归原创者所有。除非无法确认，我们都会标明作者及出处，如有侵权烦请告知，我们会立即删除并表示歉意。谢谢。
Golang语言社区
ID：Golangweb
www.bytedancing.com
游戏服务器架构丨分布式技术丨大数据丨游戏算法学习
以上是关于Golang读写文件的几种方式的主要内容，如果未能解决你的问题，请参考以下文章