最近在使用Golang进行文件读写的过程中，遇到几个细节问题导致程序写入数据时有一定脏数据的残留，最后发现是使用os.OpenFile在进行文件操作的时候没有使用正确的flag造成的。因此专门去学习了下Golang中读写文件的几种方式方法。
读文件
使用golang语言去读取一个文件默认会有多种方式，这里主要介绍以下几种。
使用ioutil直接读取
需要引入io/ioutil包，该包默认拥有以下函数供用户调用。
func NopCloser(r io.Reader) io.ReadCloser
func ReadAll(r io.Reader) ([]byte, error)
func ReadDir(dirname string) ([]os.FileInfo, error)
func ReadFile(filename string) ([]byte, error)
func TempDir(dir, prefix string) (name string, err error)
func TempFile(dir, prefix string) (f *os.File, err error)
func WriteFile(filename string, data []byte, perm os.FileMode) error
读文件，我们可以看以下三个函数:
//从一个io.Reader类型中读取内容直到返回错误或者EOF时返回读取的数据，当err == nil时，数据成功读取到[]byte中
//ReadAll函数被定义为从源中读取数据直到EOF，它是不会去从返回数据中去判断EOF来作为读取成功的依据
func ReadAll(r io.Reader) ([]byte, error)
//读取一个目录，并返回一个当前目录下的文件对象列表和错误信息
func ReadDir(dirname string) ([]os.FileInfo, error)
//读取文件内容，并返回[]byte数据和错误信息。err == nil时，读取成功
func ReadFile(filename string) ([]byte, error)
读取文件示例:
$ cat readfile.go
package main
import (
"fmt"
"io/ioutil"
"strings"
)
func main() {
Ioutil("mytestfile.txt")
}
func Ioutil(name string) {
if contents,err := ioutil.ReadFile(name);err == nil {
//因为contents是[]byte类型，直接转换成string类型后会多一行空格,需要使用strings.Replace替换换行符
result := strings.Replace(string(contents),"\n","",1)
fmt.Println(result)
}
}
$ go run readfile.go
xxbandy.github.io @by Andy_xu
借助os.Open进行读取文件
由于os.Open是打开一个文件并返回一个文件对象，因此其实可以结合ioutil.ReadAll(r io.Reader)来进行读取。io.Reader其实是一个包含Read方法的接口类型，而文件对象本身是实现了了Read方法的。
我们先来看下os.Open家族的相关函数
//打开一个需要被读取的文件，如果成功读取，返回的文件对象将可用被读取，该函数默认的权限为O_RDONLY，也就是只对文件有只读权限。如果有错误，将返回*PathError类型
func Open(name string) (*File, error)
//大部分用户会选择该函数来代替Open or Create函数。该函数主要用来指定参数(os.O_APPEND|os.O_CREATE|os.O_WRONLY)以及文件权限(0666)来打开文件，如果打开成功返回的文件对象将被用作I/O操作
func OpenFile(name string, flag int, perm FileMode) (*File, error)
使用os.Open家族函数和ioutil.ReadAll()读取文件示例:
func OsIoutil(name string) {
if fileObj,err := os.Open(name);err == nil {
//if fileObj,err := os.OpenFile(name,os.O_RDONLY,0644); err == nil {
defer fileObj.Close()
if contents,err := ioutil.ReadAll(fileObj); err == nil {
result := strings.Replace(string(contents),"\n","",1)
fmt.Println("Use os.Open family functions and ioutil.ReadAll to read a file contents:",result)
}
}
}
# 在main函数中调用OsIoutil(name)函数就可以读取文件内容了
$ go run readfile.go
Use 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文件对象，而该文件对象默认是有很多方法的，其中读取文件的方法有如下几种:
//从文件对象中读取长度为b的字节，返回当前读到的字节数以及错误信息。因此使用该方法需要先初始化一个符合内容大小的空的字节列表。读取到文件的末尾时，该方法返回0，io.EOF
func (f *File) Read(b []byte) (n int, err error)
//从文件的off偏移量开始读取长度为b的字节。返回读取到字节数以及错误信息。当读取到的字节数n小于想要读取字节的长度len(b)的时候，该方法将返回非空的error。当读到文件末尾时，err返回io.EOF
func (f *File) ReadAt(b []byte, off int64) (n int, err error)
使用文件对象的Read方法读取：
func FileRead(name string) {
if fileObj,err := os.Open(name);err == nil {
defer fileObj.Close()
//在定义空的byte列表时尽量大一些，否则这种方式读取内容可能造成文件读取不完整
buf := make([]byte, 1024)
if n,err := fileObj.Read(buf);err == nil {
fmt.Println("The number of bytes read:"+strconv.Itoa(n),"Buf length:"+strconv.Itoa(len(buf)))
result := strings.Replace(string(buf),"\n","",1)
fmt.Println("Use os.Open and File's Read method to read a file:",result)
}
}
}
使用os.Open和bufio.Reader读取文件内容
bufio包实现了缓存IO,它本身包装了io.Reader和io.Writer对象，创建了另外的Reader和Writer对象，不过该种方式是带有缓存的，因此对于文本I/O来说，该包是提供了一些便利的。
先看下bufio模块下的相关的Reader函数方法：
//首先定义了一个用来缓冲io.Reader对象的结构体，同时该结构体拥有以下相关的方法
type Reader struct {
}
//NewReader函数用来返回一个默认大小buffer的Reader对象(默认大小好像是4096) 等同于NewReaderSize(rd,4096)
func NewReader(rd io.Reader) *Reader
//该函数返回一个指定大小buffer(size最小为16)的Reader对象，如果 io.Reader参数已经是一个足够大的Reader，它将返回该Reader
func NewReaderSize(rd io.Reader, size int) *Reader
//该方法返回从当前buffer中能被读到的字节数
func (b *Reader) Buffered() int
//Discard方法跳过后续的 n 个字节的数据，返回跳过的字节数。如果0 <= n <= b.Buffered(),该方法将不会从io.Reader中成功读取数据。
func (b *Reader) Discard(n int) (discarded int, err error)
//Peekf方法返回缓存的一个切片，该切片只包含缓存中的前n个字节的数据
func (b *Reader) Peek(n int) ([]byte, error)
//把Reader缓存对象中的数据读入到[]byte类型的p中，并返回读取的字节数。读取成功，err将返回空值
func (b *Reader) Read(p []byte) (n int, err error)
//返回单个字节，如果没有数据返回err
func (b *Reader) ReadByte() (byte, error)
//该方法在b中读取delimz之前的所有数据，返回的切片是已读出的数据的引用，切片中的数据在下一次的读取操作之前是有效的。如果未找到delim，将返回查找结果并返回nil空值。因为缓存的数据可能被下一次的读写操作修改，因此一般使用ReadBytes或者ReadString，他们返回的都是数据拷贝
func (b *Reader) ReadSlice(delim byte) (line []byte, err error)
//功能同ReadSlice，返回数据的拷贝
func (b *Reader) ReadBytes(delim byte) ([]byte, error)
//功能同ReadBytes,返回字符串
func (b *Reader) ReadString(delim byte) (string, error)
//该方法是一个低水平的读取方式，一般建议使用ReadBytes('\n') 或 ReadString('\n')，或者使用一个 Scanner来代替。ReadLine 通过调用 ReadSlice 方法实现，返回的也是缓存的切片，用于读取一行数据，不包括行尾标记（\n 或 \r\n）
func (b *Reader) ReadLine() (line []byte, isPrefix bool, err error)
//读取单个UTF-8字符并返回一个rune和字节大小
func (b *Reader) ReadRune() (r rune, size int, err error)
示例：
func BufioRead(name string) {
if fileObj,err := os.Open(name);err == nil {
defer fileObj.Close()
//一个文件对象本身是实现了io.Reader的 使用bufio.NewReader去初始化一个Reader对象，存在buffer中的，读取一次就会被清空
reader := bufio.NewReader(fileObj)
//使用ReadString(delim byte)来读取delim以及之前的数据并返回相关的字符串.
if result,err := reader.ReadString(byte('@'));err == nil {
fmt.Println("使用ReadSlince相关方法读取内容:",result)
}
//注意:上述ReadString已经将buffer中的数据读取出来了，下面将不会输出内容
//需要注意的是，因为是将文件内容读取到[]byte中，因此需要对大小进行一定的把控
buf := make([]byte,1024)
//读取Reader对象中的内容到[]byte类型的buf中
if n,err := reader.Read(buf); err == nil {
fmt.Println("The number of bytes read:"+strconv.Itoa(n))
//这里的buf是一个[]byte，因此如果需要只输出内容，仍然需要将文件内容的换行符替换掉
fmt.Println("Use bufio.NewReader and os.Open read file contents to a []byte:",string(buf))
}
}
}
读取文件全部示例
/**
* @File Name: readfile.go
* @Author:Andy_xu @xxbandy.github.io
* @Email:371990778@qq.com
* @Create Date: 2017-12-16 16:12:01
* @Last Modified: 2017-12-17 12:12:02
* @Description:读取指定文件的几种方法，需要注意的是[]byte类型在转换成string类型的时候，都会在最后多一行空格，需要使用result := strings.Replace(string(contents),"\n","",1) 方式替换换行符
*/
package main
import (
"fmt"
"io/ioutil"
"strings"
"os"
"strconv"
"bufio"
)
func main() {
Ioutil("mytestfile.txt")
OsIoutil("mytestfile.txt")
FileRead("mytestfile.txt")
BufioRead("mytestfile.txt")
}
func Ioutil(name string) {
if contents,err := ioutil.ReadFile(name);err == nil {
//因为contents是[]byte类型，直接转换成string类型后会多一行空格,需要使用strings.Replace替换换行符
result := strings.Replace(string(contents),"\n","",1)
fmt.Println("Use ioutil.ReadFile to read a file:",result)
}
}
func OsIoutil(name string) {
if fileObj,err := os.Open(name);err == nil {
//if fileObj,err := os.OpenFile(name,os.O_RDONLY,0644); err == nil {
defer fileObj.Close()
if contents,err := ioutil.ReadAll(fileObj); err == nil {
result := strings.Replace(string(contents),"\n","",1)
fmt.Println("Use os.Open family functions and ioutil.ReadAll to read a file :",result)
}
}
}
func FileRead(name string) {
if fileObj,err := os.Open(name);err == nil {
defer fileObj.Close()
//在定义空的byte列表时尽量大一些，否则这种方式读取内容可能造成文件读取不完整
buf := make([]byte, 1024)
if n,err := fileObj.Read(buf);err == nil {
fmt.Println("The number of bytes read:"+strconv.Itoa(n),"Buf length:"+strconv.Itoa(len(buf)))
result := strings.Replace(string(buf),"\n","",1)
fmt.Println("Use os.Open and File's Read method to read a file:",result)
}
}
}
func BufioRead(name string) {
if fileObj,err := os.Open(name);err == nil {
defer fileObj.Close()
//一个文件对象本身是实现了io.Reader的 使用bufio.NewReader去初始化一个Reader对象，存在buffer中的，读取一次就会被清空
reader := bufio.NewReader(fileObj)