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