go语言读文件写文件

末蓝、 2023-02-15 10:06 9阅读 0赞

文件是什么？

计算机中的文件是存储在外部介质（通常是磁盘）上的数据集合，文件分为文本文件和二进制文件。

# 打开和关闭文件 #

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

为了防止文件忘记关闭，我们通常使用defer注册文件关闭语句。

# 读取文件 #

## 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方法读取数据
    	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循环读取文件中的所有数据。

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]...)  // append会自动扩容
    	}
    	fmt.Println(string(content))
    }

## bufio读取文件 ##

bufio是在file的基础上封装了一层API，支持更多的功能。

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)
    	}
    }

## 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))
    }

# 文件写入操作 #

`os.OpenFile()`函数能够以指定模式打开文件，从而实现文件写入相关功能。

func OpenFile(name string, flag int, perm FileMode) (*File, error) { 
    	...
    }

其中：

`name`：要打开的文件名 `flag`：打开文件的模式。 模式有以下几种：

<table> 
 <thead> 
  <tr> 
   <th align="center">模式</th> 
   <th align="center">含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center"><code>os.O_WRONLY</code></td> 
   <td align="center">只写</td> 
  </tr> 
  <tr> 
   <td align="center"><code>os.O_CREATE</code></td> 
   <td align="center">创建文件</td> 
  </tr> 
  <tr> 
   <td align="center"><code>os.O_RDONLY</code></td> 
   <td align="center">只读</td> 
  </tr> 
  <tr> 
   <td align="center"><code>os.O_RDWR</code></td> 
   <td align="center">读写</td> 
  </tr> 
  <tr> 
   <td align="center"><code>os.O_TRUNC</code></td> 
   <td align="center">清空</td> 
  </tr> 
  <tr> 
   <td align="center"><code>os.O_APPEND</code></td> 
   <td align="center">追加</td> 
  </tr> 
 </tbody> 
</table>

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

## Write和WriteString ##

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

## bufio.NewWriter ##

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

# 补充读终端输入内容，如果输入内容中有空格
    func useBufio(){ 
    	var s string
    	reader := bufio.NewReader(os.Stdin)		// 终端输入 
    	s, _ = reader.ReadString("\n")
    	fmt.Printf("你输入的是%s\n", s)
    }

## ioutil.WriteFile ##

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

## copyFile ##

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

// 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()拷贝内容
    }
    func main() { 
    	_, err := CopyFile("dst.txt", "src.txt")
    	if err != nil { 
    		fmt.Println("copy file failed, err:", err)
    		return
    	}
    	fmt.Println("copy done!")
    }

## 实现一个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))
    	}
    }