本文主要介绍了Go语言中文件读写的相关操作。
文件是什么？
计算机中的文件是存储在外部介质（通常是磁盘）上的数据集合，文件分为文本文件和二进制文件。

1. 打开和关闭文件

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
    }
    fmt.Println(file)
    // 关闭文件
    file.Close()
}

为了防止文件忘记关闭，我们通常使用defer注册文件关闭语句。
file.Close() 一定要在错误判断之后执行，因为如果出错：file是空指针，会触发panic。
— 也就是说对有错误返回值的情况下面紧接错误判断，再执行其他代码，以免panic。

#此处go内部在Close对file做了一层判断，优化之后不会报错。但使用其他第三方库，需要注意。

func (file *File) Close() error {
    if file == nil {
        return ErrInvalid
    }
    return file.file.close()
}

2. 读取文件

2.1 file.Read()

基本使用

Read方法定义如下：

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

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

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方法读取数据：每次读取128个字节
    var tmp = make([]byte, 128)
    n, err := file.Read(tmp)
    if err == io.EOF {
        fmt.Println("文件读完了")
        return
    }
    if err != nil {
        fmt.Println("read file failed, err:", err)
        return
    }
    fmt.Printf("读取了%d字节数据\n", n)
    fmt.Println(string(tmp[:n]))// 通过打印整个切片看出读取的内容
}

循环读取

使用for循环读取文件中的所有数据。 — 当读完或者出错跳出for循环

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
    var tmp = make([]byte, 128)
    for {
        n, err := file.Read(tmp)
        if err == io.EOF {
            fmt.Println("文件读完了")
            break
        }
        if err != nil {
            fmt.Println("read file failed, err:", err)
            return
        }
        content = append(content, tmp[:n]...)
    }
    fmt.Println(string(content))
}

2.2 bufio读取文件 - 一行一行读取

bufio是在file的基础上封装了一层API，支持更多的功能。
bufio.NewReader返回一个reader来通过reader.ReadString(‘\n’)一行一行读取。

package main
import (
    "bufio"
    "fmt"
    "io"
    "os"
)
// bufio按行读取示例
func main() {
    file, err := os.Open("./xx.txt")
    if err != nil {
        fmt.Println("open file failed, err:", err)
        return
    }
    defer file.Close()
    reader := bufio.NewReader(file)
    for {
        line, err := reader.ReadString('\n') //注意是字符
        if err == io.EOF {
            if len(line) != 0 {
                fmt.Println(line)
            }
            fmt.Println("文件读完了")
            break
        }
        if err != nil {
            fmt.Println("read file failed, err:", err)
            return
        }
        fmt.Print(line)
    }
}

2.3 ioutil读取整个/完整文件

io/ioutil包的ReadFile方法能够读取完整的文件，只需要将文件名作为参数传入。

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

3. 文件写入操作

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_RDWR | 读写 | | os.O_TRUNC | 清空 | | os.O_APPEND | 追加 |

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

3.1 Write和WriteString-直接对*File写入

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 小王子") //直接写入字符串数据
}

3.2 bufio.NewWriter-对*File处理后得到一个writer写入

先储存在缓冲区，等达到一定阈值通过Flush写入磁盘。
优点是：提升性能
缺点是：一旦未Flush，白做了

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() //将缓存中的内容写入文件
}

3.3 ioutil.WriteFile-直接通过文件路径写入，没有用到os.Openfile事先打开

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

4. 练习

copyFile

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

io.Copy() 的返回值：拷贝的字节数和error

// CopyFile 拷贝文件函数
func CopyFile(dstName, srcName string) (written int64, err error) {
  // ** 以读方式打开源文件
  src, err := os.Open(srcName)
  if err != nil {
      fmt.Printf("open %s failed, err:%v.\n", srcName, err)
      return
  }
  defer src.Close()
  // ** 以写|创建的方式打开目标文件
  dst, err := os.OpenFile(dstName, os.O_WRONLY|os.O_CREATE, 0644)
  if err != nil {
      fmt.Printf("open %s failed, err:%v.\n", dstName, err)
      return
  }
  defer dst.Close()
  return io.Copy(dst, src) //调用io.Copy()拷贝内容，返回值为拷贝的字节数和error
}
func main() {
  _, err := CopyFile("dst.txt", "src.txt")
  if err != nil {
      fmt.Println("copy file failed, err:", err)
      return
  }
  fmt.Println("copy done!")
}

文件中间插入内容

// func (*File) Seek
func (f *File) Seek(offset int64, whence int) (ret int64, err error)
/* Seek设置下一次读/写的位置。offset为相对偏移量，
而whence决定相对位置：0为相对文件开头，1为相对当前位置，2为相对文件结尾。
它返回新的偏移量（相对开头）和可能的错误。*/

临时文件方案：

package main
import (
    "fmt"
    "io"
    "os"
)
// 指定位置插入
func writeLocation() {
    // 打开源文件
    fileObj, err := os.OpenFile("./src.txt", os.O_RDWR, 0644)
    if err != nil {
        fmt.Printf("open failed, err:%v.\n", err)
        return
    }
    // defer fileObj.Close()
    // 因为没办法直接在原文件中间插入内容，因此借助临时文件实现
    tempFile, err := os.OpenFile("./temp.txt", os.O_CREATE|os.O_TRUNC|os.O_WRONLY, 0644)
    if err != nil {
        fmt.Printf("open failed, err:%v.\n", err)
        return
    }
    // defer tempFile.Close()
    // 读取插入位置光标前的内容写入临时文件
    var startOfFile [1]byte
    n, err := fileObj.Read(startOfFile[:])
    if err != nil {
        fmt.Printf("read from file's start failed, err:%v.\n", err)
        return
    }
    tempFile.Write(startOfFile[:n])
    fmt.Println("开始", string(startOfFile[:n]))
    // 再写入待插入内容
    var middleOfFile = []byte{'b'}
    fmt.Println("中间待插入", string(middleOfFile))
    tempFile.Write(middleOfFile)
    // 原文件后续内容写入临时文件
    var endOfFile [1024]byte
    // for n,err:=fileObj.Read(end_file[:]);err!=nil;{}
    for {
        n, err := fileObj.Read(endOfFile[:])
        if err == io.EOF {
            tempFile.Write(endOfFile[:n])
            fmt.Println("结尾内容", string(endOfFile[:n]))
            break
        }
        if err != nil {
            fmt.Printf("read from file's end failed, err:%v.\n", err)
            return
        }
        tempFile.Write(endOfFile[:n])
        fmt.Println("结尾内容", string(endOfFile[:n]))
    }
    // 关闭文件，并重命名覆盖
    fileObj.Close()
    tempFile.Close()
    // 临时文件重命名为原文件名字->实现覆盖
    os.Rename("./temp.txt", "./src.txt")
}
func main() {
    writeLocation()
}

实现一个cat命令

使用文件操作相关知识，模拟实现linux平台cat命令的功能。— 连接文件并打印到标准输出设备上

package main
import (
    "bufio"
    "flag"
    "fmt"
    "io"
    "os"
)
// cat命令实现
func cat(r *bufio.Reader) {
    for {
        buf, err := r.ReadBytes('\n') //注意是字符
        if err == io.EOF {
            break
        }
        fmt.Fprintf(os.Stdout, "%s", buf)
    }
}
func main() {
    flag.Parse() // 解析命令行参数
    if flag.NArg() == 0 {
        // 如果没有参数默认从标准输入读取内容
        cat(bufio.NewReader(os.Stdin))
    }
    // 依次读取每个指定文件的内容并打印到终端
    for i := 0; i < flag.NArg(); i++ {
        f, err := os.Open(flag.Arg(i))
        if err != nil {
            fmt.Fprintf(os.Stdout, "reading from %s failed, err:%v\n", flag.Arg(i), err)
            continue
        }
        cat(bufio.NewReader(f))
    }
}

Golang 学习笔记

Go语言文件操作os