Go从入门到放弃之文件操作

原创

寻找百衲本 2024-09-25 17:44:02 ©著作权

©著作权归作者所有：来自51CTO博客作者寻找百衲本的原创作品，请联系作者获取转载授权，否则将追究法律责任

Go语言主要有os bufio ioutil单个模块可以实现文件的读写相关操作

一、OS

打开文件和关闭文件

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
	}
	// 关闭文件,为了防止文件忘记关闭，我们通常使用defer注册文件关闭语句。
	file.Close()
}

读取文件(指定大小)

Read方法定义如下：

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

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

package main

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

func main() {
	// 打开文件
	file, err := os.Open("D:\\MyData\\Desktop\\工作记录.txt")
	if err != nil {
		fmt.Printf("open file failed:%v\n",err)
		return
	}

	// 读取文件
	defer file.Close()
	var tmp = make([]byte, 128) // 读取128字节
	n,err := file.Read(tmp)
	// 读到文件末尾时会返回0和io.EOF
	if err == io.EOF {
		fmt.Println("文件读取完毕")
		return
	}
	if err != nil {
		fmt.Printf("open file failed:%v\n",err)
		return
	}

	fmt.Printf("读取了%d字节数据\n",n)
	fmt.Println(string(tmp[:n]))
}

读取文件(所有内容)

package main

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

func main() {
	// 打开文件
	file, err := os.Open("D:\\MyData\\Desktop\\工作记录.txt")
	if err != nil {
		fmt.Printf("open file failed:%v\n", err)
		return
	}

	// 读取文件
	defer file.Close()
	var content []byte
	var tmp = make([]byte, 128)
	for {
		n, err := file.Read(tmp)
		// 读到文件末尾时会返回0和io.EOF
		if err == io.EOF {
			fmt.Println("文件读取完毕")
			break
		}
		if err != nil {
			fmt.Printf("open file failed:%v\n", err)
			return
		}
		content = append(content, tmp[:n]...)
	}
	fmt.Println(string(content))
}

文件写入

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。

package main

import (
	"fmt"
	"os"
)

func main() {
        // 创建文件并清空文件以只写模式打开，创建后文件权限为666(Linux)，window忽略该参数
	file, err := os.OpenFile("test.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()
        
        // 以字节的方式写入
	str1 := "你是个大帅比\r\n"
	file.Write([]byte(str1))
        // 以字符串的方式写入
	str2 := "大帅比是你"
	file.WriteString(str2)
}

二、bufio

读取文件

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

package main

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

func main() {
	file, err := os.Open("test.txt")
	if err != nil {
		fmt.Println("open file failed,err:",err)
		return
	}

	reader := bufio.NewReader(file)

	for {
		line ,err := reader.ReadString('\n') // 注意时字符串，以单引号包含，\n 是文件分隔符
		if err == io.EOF {
			if len(line) !=0 {
				fmt.Println(line)
			}
			fmt.Println("文件读取完毕")
			break
		}

		if err != nil {
			fmt.Println("文件读取错误，错误：",err)
			return
		}

		fmt.Println(line)
	}

}

写入文件

package main

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

func main() {
	file, err := os.OpenFile("test.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("你是大帅比\n")
	}

	writer.Flush()
}

三、ioutil

读取文件

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

package main

import (
	"fmt"
	"io/ioutil"
)

func main() {
	content ,err := ioutil.ReadFile("test.txt")
	if err != nil {
		fmt.Println("read file failed, err:", err)
		return
	}
	fmt.Println(string(content))
}

写入文件

package main

import (
	"fmt"
	"io/ioutil"
)

func main() {
	str := "大帅比"
	err := ioutil.WriteFile("test.txt", []byte(str), 0666)
	if err != nil {
		fmt.Println("write file failed, err:", err)
		return
	}
}

四、练习

1.借助`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!")
}

2.实现一个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 {
			// 退出之前将已读到的内容输出
			fmt.Fprintf(os.Stdout, "%s", buf)
			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))
	}
}

"一劳永逸" 的话，有是有的，而 "一劳永逸" 的事却极少