您的位置:

Goos.OpenFile详解

一、OpenFile介绍

Goos.OpenFile方法是在操作系统中打开一个文件的函数,在Golang语言中的io包中实现。它可以以指定模式打开文件并返回一个io.Reader、io.Writer或io.Seeker接口类型的对象以便读取、写入该文件。OpenFile接收三个参数,文件名、文件打开模式和文件权限,其中文件名是必须的,文件模式和文件权限是可选的。

OpenFile的返回值实现了文件I/O中的诸多接口。因此,它既可以像os.Open方法一样返回一个*os.File类型的对象,也可以返回一个io.Reader、io.Writer或io.Seeker接口类型的对象。

const (
    // 以只读模式打开文件
    O_RDONLY int = syscall.O_RDONLY // 0x0
    // 以写模式打开文件
    O_WRONLY int = syscall.O_WRONLY // 0x1
    // 以读写模式打开文件
    O_RDWR   int = syscall.O_RDWR   // 0x2
    // 打开文件并在读取时锁定
    O_SYNC   int = syscall.O_SYNC   // 0x101000
    // 如果文件不存在则创建文件
    O_CREATE int = syscall.O_CREAT  // 0x40
    // 如果文件已存在则截取文件
    O_TRUNC  int = syscall.O_TRUNC  // 0x200
)

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

type FileMode uint32
type File struct {/* ... */}

二、OpenFile模式介绍

Goos.OpenFile方法中的模式参数可以选取多种配置选项,用来说明对文件访问时所需要的操作类型。下面列举了一些常见的模式。

1.只读模式(O_RDONLY)

当文件仅用于读取时,提供此模式并将打开所请求的文件以供阅读。

file, err := os.OpenFile("test.txt", os.O_RDONLY, 0666)
if err != nil {
    fmt.Println("open file failed")
    return
}
defer file.Close()

2.只写模式(O_WRONLY)

当文件只需要写入时,提供此模式并将打开所请求的文件用于写入。

file, err := os.OpenFile("test.txt", os.O_WRONLY, 0666)
if err != nil {
    fmt.Println("open file failed")
    return
}
defer file.Close()

3.读写模式(O_RDWR)

当文件需要读取和写入时,可以提供此模式,并将打开所请求的文件用于读取和写入。

file, err := os.OpenFile("test.txt", os.O_RDWR, 0666)
if err != nil {
    fmt.Println("open file failed")
    return
}
defer file.Close()

4.同步模式(O_SYNC)

在读取或写入文件时,Sync方法对于确保缓存的数据被写入磁盘非常有用。该同步模式可以提供在文件读取或写入时自动执行操作。

file, err := os.OpenFile("test.txt", os.O_APPEND|os.O_CREATE|os.O_WRONLY|os.O_SYNC, 0666)
if err != nil {
    fmt.Println("open file failed")
    return
}
defer file.Close()

5.截断模式(O_TRUNC)

如果您已经打开了一个文件并希望将其截断到零长度,可以使用此模式。当在写模式下打开文件时,可将文件截断为零长度。如果持有文件描述符的进程在其他进程占有该文件时执行此操作,则截断将被抵消。

file, err := os.OpenFile("test.txt", os.O_TRUNC|os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
if err != nil {
    fmt.Println("open file failed")
    return
}
defer file.Close()

三、文件权限介绍

如果没有指定文件权限,则会默认使用系统默认的权限。在Unix和Linux操作系统中,这些权限是以8进制表示的。

//在Golang中权限是os.FileMode型,即uint32型
type FileMode uint32  

//在Unix和Linux操作系统中,文件权限是以8进制表示的,在windows操作系统中,被忽略
const (
    S_IRUSR FileMode = 0400 // file owner has read permission
    S_IWUSR FileMode = 0200 // file owner has write permission
    S_IXUSR FileMode = 0100 // file owner has execute permission
    // 0400: 文件所有者具备 读 权限
    // 0200: 文件所有者具备 写 权限
    // 0100: 文件所有者具备 执行 权限

    S_IRGRP FileMode = 0040 // group has read permission
    S_IWGRP FileMode = 0020 // group has write permission
    S_IXGRP FileMode = 0010 // group has execute permission
    // 0040: 用户组具备 读 权限
    // 0020: 用户组具备 写 权限
    // 0010: 用户组具备 执行 权限

    S_IROTH FileMode = 0004 // everyone has read permission
    S_IWOTH FileMode = 0002 // everyone has write permission
    S_IXOTH FileMode = 0001 // everyone has execute permission
    // 0004: 其他人具备 读 权限
    // 0002: 其他人具备 写 权限
    // 0001: 其他人具备 执行 权限
)

四、文件打开示例

下面是关于Goos.OpenFile的使用示例。

package main

import (
    "fmt"
    "io/ioutil"
    "os"
)

func main() {
    // 以 read-only 方式打开文件
    f, err := os.OpenFile("test.txt", os.O_RDONLY, 0777) 
    if err != nil {
        panic(err)
    }

    defer f.Close()

    // 读文件
    b, err := ioutil.ReadAll(f)
    if err != nil {
        panic(err)
    }

    fmt.Println(string(b))

    //以 write-only 方式打开文件
    f, err = os.OpenFile("test.txt", os.O_WRONLY, 0777)
    if err != nil {
        panic(err)
    }

    defer f.Close()

    // 写文件
    _, err = f.WriteString("This is a test\n")
    if err != nil {
        panic(err)
    }

    // 以 read-write 方式打开文件
    f, err = os.OpenFile("test.txt", os.O_RDWR, 0777)
    if err != nil {
        panic(err)
    }

    defer f.Close()

    // 读取并修改文件
    b, err = ioutil.ReadAll(f)
    if err != nil {
        panic(err)
    }

    bstring := string(b) + "\nThis is a new line\n"

    _, err = f.WriteAt([]byte(bstring), 0)
    if err != nil {
        panic(err)
    }

    // 以只读模式打开文件,并锁定该文件以便在读取文件时结束时自动解锁。
    f, err = os.OpenFile("test.txt", os.O_RDONLY|os.O_SYNC, 0777)
    if err != nil {
        panic(err)
    }

    defer f.Close()

    //读文件
    b, err = ioutil.ReadAll(f)
    if err != nil {
        panic(err)
    }

    fmt.Println(string(b))
}