快捷導(dǎo)航

深入理解golang中io.Writer接口的使用

更新時(shí)間：2023年10月19日 10:46:04 作者：海生

io 是一個(gè) Golang 標(biāo)準(zhǔn)庫(kù)包,它為圍繞輸入和輸出的許多操作和用例定義了靈活的接口,這篇文章主要為大家介紹了Go中Writer接口的使用,需要的可以參考下

一、前言

在很多地方我們會(huì)用到 io.Writer，比如下面是我在學(xué)習(xí)text/templat遇到的

str := "world"
    tmpl, err := template.New("test").Parse("hello, {{.}}\n") //建立一個(gè)名字為test的模版"hello, {{.}}"
    if err != nil{
        panic(err)
    }
    err = tmpl.Execute(os.Stdout, str) //將str的值合成到tmpl模版的{{.}}中，并將合成得到的文本輸入到os.Stdout,返回hello, world
    if err != nil{
        panic(err)
    }

這里會(huì)在控制臺(tái)上輸出。一個(gè) hello world。

其中是這個(gè)函數(shù)，把模版輸出到 io.Writer中，這里是 os.Stdout，就是執(zhí)行控制臺(tái)。但當(dāng)時(shí)就想在，如果需要輸入到一個(gè)變量中怎么辦呢，方便其他的函數(shù)調(diào)用，才發(fā)現(xiàn)對(duì)io.Writer不理解，不知道變量形式的io.Writer怎么弄。

func (t *Template) Execute(wr io.Writer, data any) error {
    return t.execute(wr, data)
}

二、io.Writer介紹

這里我打開(kāi)官方的 io.Writer，發(fā)現(xiàn)是一個(gè)接口，下面是它的注釋

// Writer 是一個(gè)包含Write()方法的接口.
//
// Write() 寫(xiě)入 len(p) 長(zhǎng)度的字節(jié) 從 p 到特定類型的字節(jié)流里
// Write()返回一個(gè)寫(xiě)入的字節(jié)長(zhǎng)度，以及一個(gè)錯(cuò)誤
// Write() 必須返回一個(gè)err，當(dāng)len(p)<0的時(shí)候
// Write() 不能修改 p的數(shù)據(jù)。
//
// Implementations must not retain p.
type Writer interface {
    Write(p []byte) (n int, err error)
}

io.Writer 會(huì)從 buf 中獲取數(shù)據(jù)，然后再?gòu)?fù)制到底層數(shù)據(jù)流中，這里的底層數(shù)據(jù)流可能是文件、buffer或者網(wǎng)絡(luò)響應(yīng)。

看了上面的我們大約了解是一個(gè) 封裝了Write()方法的一個(gè)接口。在開(kāi)發(fā)中，常見(jiàn)的實(shí)現(xiàn)了io.Writer的接口，常見(jiàn)類型有啥呢？

三、常用的幾種io.Writer實(shí)現(xiàn)

1、寫(xiě)入到內(nèi)存中，bytes.Buffer

func TestBytes(t *testing.T) {
    buf := new(bytes.Buffer)
    // 寫(xiě)入到buf
    buf.Write([]byte("hello"))
    t.Log(buf.String())
    //輸出hello
}

2、寫(xiě)入界面輸出中，os.Stdout

func TestOsStdout(t *testing.T) {
    _, _ = os.Stdout.Write([]byte("hello"))
    // 輸出hello
    // 和fmt.Println()打印一樣，就是打印到控制臺(tái)，
}

3、寫(xiě)入文件中

func TestFile(t *testing.T) {
    f, err := os.Create("hi.txt")
    defer f.Close()
    if err != nil {
        t.Fatal(err)
    }
    f.Write([]byte("hello"))
}

會(huì)發(fā)現(xiàn)，同目錄下增加了一個(gè) hi.txt，里面內(nèi)容是hello

4、寫(xiě)入到自定義結(jié)構(gòu)化數(shù)據(jù)中,這里用json

type Person struct {
    Name string
    Age  int64
}

func (p *Person) Write(b []byte) (n int, err error) {
    err = json.Unmarshal(b, p)
    return 1, err
}

func TestStruct(t *testing.T) {
    p := &Person{}
    p.Write([]byte("{\n\"name\":\"hisheng\",\n\"age\":11\n}"))
    t.Log(p.Name)
}

這里會(huì)輸出hisheng

到此這篇關(guān)于深入理解golang中io.Writer接口的使用的文章就介紹到這了,更多相關(guān)go io.Writer接口內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: