GoLang讀取檔案的10種方法範例

2022-06-29 18:02:39

一. 整個檔案讀入記憶體

直接將資料直接讀取入記憶體，是效率最高的一種方式，但此種方式，僅適用於小檔案，對於大檔案，則不適合，因為比較浪費記憶體

1.直接指定文化名讀取

在 Go 1.16 開始，ioutil.ReadFile 就等價於 os.ReadFile，二者是完全一致的

1.1使用os.ReadFile函數讀取檔案

package main

import (
    "fmt"
    "os"
)

func main() {
   //func ReadFile(name string) ([]byte, error) {}
    content, err := os.ReadFile("a.txt")
    if err != nil {
        panic(err)
    }
    fmt.Println(string(content))
}

1.2使用ioutil.ReadFile函數讀取檔案

package main

import (
    "io/ioutil"
    "fmt"
)

func main() {
    content, err := ioutil.ReadFile("a.txt")
    if err != nil {
        panic(err)
    }
    fmt.Println(string(content))
}

// As of Go 1.16, this function simply calls os.ReadFile.
func ReadFile(filename string) ([]byte, error) {
    return os.ReadFile(filename)
}

2.先建立控制程式碼再讀取

2.1使用os.OpenFile函數唯讀形式獲取控制程式碼

package main

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

func main() {
    /*func Open(name string) (*File, error) {
	return OpenFile(name, O_RDONLY, 0)
     }*/
     //Open是一個高階函數，是因為它是唯讀模式來開啟檔案
     /*也可以直接使用 os.OpenFile，只是要多加兩個引數
       file, err := os.OpenFile("a.txt", os.O_RDONLY, 0)*/
    file, err := os.Open("a.txt")
    if err != nil {
        panic(err)
    }
    //func (f *File) Close() error {}
    defer file.Close()
    //func ReadAll(r io.Reader) ([]byte, error) {}
    content, err := ioutil.ReadAll(file)
    fmt.Println(string(content))
}

2.2程式碼講解

2.2.1os.File結構體

type File struct {
	*file // os specific
}

2.2.2os.OpenFile函數

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

2.2.3io.Reader介面

type Reader interface {
	Read(p []byte) (n int, err error)
}

二.每次唯讀取一行

一次性讀取所有的資料，太耗費記憶體，因此可以指定每次唯讀取一行資料，方法有三種：

(1)bufio.讀行（）

(2)bufio.讀取位元組（"n"）

(3)bufio.ReadString（’n’）

在 bufio 的原始碼註釋中，曾說道 bufio.ReadLine（）是低階庫，不太適合普通使用者使用，更推薦使用者使用 bufio.ReadBytes和bufio.ReadString 去讀取單行資料

因此，這裡不再介紹 bufio.讀行（）

1.使用bufio.Reader結構體的ReadBytes方法讀取位元組數

ReadBytes讀取直到第一次遇到delim位元組，返回一個包含已讀取的資料和delim位元組的切片。如果ReadBytes方法在讀取到delim之前遇到了錯誤，它會返回在錯誤之前讀取的資料以及該錯誤（一般是io.EOF）。當且僅當ReadBytes方法返回的切片不以delim結尾時，會返回一個非nil的錯誤

package main

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

func main() {
    // 建立控制程式碼
    fi, err := os.Open("christmas_apple.py")
    if err != nil {
        panic(err)
    }
    //func NewReader(rd io.Reader) *Reader {}，返回的是bufio.Reader結構體
    r := bufio.NewReader(fi)// 建立 Reader

    for {
    //func (b *Reader) ReadBytes(delim byte) ([]byte, error) {}
        lineBytes, err := r.ReadBytes('n')
        //去掉字串首尾空白字元，返回字串
        line := strings.TrimSpace(string(lineBytes))
        if err != nil && err != io.EOF {
            panic(err)
        }
        if err == io.EOF {
            break
        }
        fmt.Println(line)
    }
}

2.使用bufio.Reader結構體的ReadString方法讀取字串

ReadString讀取直到第一次遇到delim位元組，返回一個包含已讀取的資料和delim位元組的字串。如果ReadString方法在讀取到delim之前遇到了錯誤，它會返回在錯誤之前讀取的資料以及該錯誤（一般是io.EOF）。當且僅當ReadString方法返回的切片不以delim結尾時，會返回一個非nil的錯誤

package main

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

func main() {
    // 建立控制程式碼
    fi, err := os.Open("a.txt")
    if err != nil {
        panic(err)
    }

    // 建立 Reader
    r := bufio.NewReader(fi)

    for {
    //func (b *Reader) ReadString(delim byte) (string, error) {}
        line, err := r.ReadString('n')
        line = strings.TrimSpace(line)
        if err != nil && err != io.EOF {
            panic(err)
        }
        if err == io.EOF {
            break
        }
        fmt.Println(line)
    }
}

3.程式碼講解

3.1bufio.Reader結構體

type Reader struct {
	buf          []byte
	rd           io.Reader // reader provided by the client
	r, w         int       // buf read and write positions
	err          error
	lastByte     int // last byte read for UnreadByte; -1 means invalid
	lastRuneSize int // size of last rune read for UnreadRune; -1 means invalid
}

三.每次唯讀取固定位元組數

每次僅讀取一行資料，可以解決記憶體佔用過大的問題，但要注意的是，並不是所有的檔案都有換行符 n;
因此對於一些不換行的大檔案來說，還得再想想其他辦法

1.使用os庫

通用的做法是：

先建立一個檔案控制程式碼，可以使用 os.Open 或者 os.OpenFile；

然後 bufio.NewReader 建立一個 Reader；

然後在 for 迴圈裡呼叫 Reader 的 Read 函數，每次僅讀取固定位元組數量的資料

Read方法讀取資料寫入p；本方法返回寫入p的位元組數；本方法一次呼叫最多會呼叫下層Reader介面一次Read方法，因此返回值n可能小於len§；讀取到達結尾時，返回值n將為0而err將為io.EOF

package main

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

func main() {
    // 建立控制程式碼
    fi, err := os.Open("a.txt")
    if err != nil {
        panic(err)
    }

    // 建立 Reader
    r := bufio.NewReader(fi)

    // 每次讀取 1024 個位元組
    buf := make([]byte, 1024)
    for {
        //func (b *Reader) Read(p []byte) (n int, err error) {}
        n, err := r.Read(buf)
        if err != nil && err != io.EOF {
            panic(err)
        }

        if n == 0 {
            break
        }
        fmt.Println(string(buf[:n]))
    }
}

2.使用 syscall庫

os 庫本質上也是呼叫 syscall 庫，但由於 syscall 過於底層，如非特殊需要，一般不會使用 syscall；

本篇為了內容的完整度，這裡也使用 syscall 來舉個例子；

本例中，會每次讀取 100 位元組的資料，並行送到通道中，由另外一個協程進行讀取並列印出來

package main

import (
    "fmt"
    "sync"
    "syscall"
)

func main() {
    fd, err := syscall.Open("christmas_apple.py", syscall.O_RDONLY, 0)
    if err != nil {
        fmt.Println("Failed on open: ", err)
    }
    defer syscall.Close(fd)

    var wg sync.WaitGroup
    wg.Add(2)
    dataChan := make(chan []byte)
    go func() {
        wg.Done()
        for {
            data := make([]byte, 100)
            n, _ := syscall.Read(fd, data)
            if n == 0 {
                break
            }
            dataChan <- data
        }
        close(dataChan)
    }()

    go func() {
        defer wg.Done()
        for {
            select {
            case data, ok := <-dataChan:
                if !ok {
                    return
                }

                fmt.Printf(string(data))
            default:

            }
        }
    }()
    wg.Wait()
}