Go语言之Writer 和 Reader

输入和输出

Go Writer 和 Reader接口的设计遵循了Unix的输入和输出,一个程序的输出可以是另外一个程序的输入。他们的功能单一并且纯粹,这样就可以非常容易的编写程序代码,又可以通过组合的概念,让我们的程序做更多的事情。

比如我们在上一篇的Go log中,就介绍了Unix的三种输入输出输入模式,他们对应的Go语言里有专门的实现。

var (
    Stdin  = NewFile(uintptr(syscall.Stdin), "/dev/stdin")
    Stdout = NewFile(uintptr(syscall.Stdout), "/dev/stdout")
    Stderr = NewFile(uintptr(syscall.Stderr), "/dev/stderr"))

这三种标准的输入和输出都是一个*File,而*File恰恰就是同时实现了io.Writer和io.Reader这两个接口的类型,所以它们同时具备输入和输出的功能,既可以从里面读取数据,又可以往里面写入数据。

Go标准库的io包也是基于Unix这种输入和输出的理念,大部分的接口都是扩展了io.Writer和io.Reader,大部分的类型也都选择地实现了io.Writer和io.Reader这两个接口,然后把数据的输入和输出,抽象为流的读写。所以只要实现了这两个接口,都可以使用流的读写功能。

io.Writer和io.Reader两个接口的高度抽象,让我们不用再面向具体的业务,我们只关注,是读还是写。只要我们定义的方法函数可以接收这两个接口作为参数,那么我们就可以进行流的读写,而不用关心如何读、写到哪里去,这也是面向接口编程的好处。

Reader和Writer接口

这两个高度抽象的接口,只有一个方法,也体现了Go接口设计的简洁性,只做一件事。

// Writer is the interface that wraps the basic Write method.//// Write writes len(p) bytes from p to the underlying data stream.// It returns the number of bytes written from p (0 <= n <= len(p))// and any error encountered that caused the write to stop early.// Write must return a non-nil error if it returns n < len(p).// Write must not modify the slice data, even temporarily.//// Implementations must not retain p.type Writer interface {
    Write(p []byte) (n int, err error)}

这是Wirter接口的定义,它只有一个Write方法。它接受一个byte的切片,返回两个值,n表示写入的字节数、err表示写入时发生的错误。

从其文档注释来看,这个方法是有规范要求的,我们要想实现一个io.Writer接口,就要遵循这些规则。

  • write方法向底层数据流写入len(p)字节的数据,这些数据来自于切片p;
  • 返回被写入的字节数n,0 <= n <= len(p);
  • 如果n<len(p), 则必须返回一些非nil的err;
  • 如果中途出现问题,也要返回非nil的err;
  • Write方法绝对不能修改切片p以及里面的数据。

这些实现io.Writer接口的规则,所有实现了该接口的类型都要遵守,不然可能会导致莫名其妙的问题。

// Reader is the interface that wraps the basic Read method.//// Read reads up to len(p) bytes into p. It returns the number of bytes// read (0 <= n <= len(p)) and any error encountered. Even if Read// returns n < len(p), it may use all of p as scratch space during the call.// If some data is available but not len(p) bytes, Read conventionally// returns what is available instead of waiting for more.//// When Read encounters an error or end-of-file condition after// successfully reading n > 0 bytes, it returns the number of// bytes read. It may return the (non-nil) error from the same call// or return the error (and n == 0) from a subsequent call.// An instance of this general case is that a Reader returning// a non-zero number of bytes at the end of the input stream may// return either err == EOF or err == nil. The next Read should// return 0, EOF.//// Callers should always process the n > 0 bytes returned before// considering the error err. Doing so correctly handles I/O errors// that happen after reading some bytes and also both of the// allowed EOF behaviors.//// Implementations of Read are discouraged from returning a// zero byte count with a nil error, except when len(p) == 0.// Callers should treat a return of 0 and nil as indicating that// nothing happened; in particular it does not indicate EOF.//// Implementations must not retain p.type Reader interface {
    Read(p []byte) (n int, err error)}

这是io.Reader接口定义,也只有一个Read方法。这个方法接受一个byte的切片,并返回两个值,一个是读入的字节数,一个是err错误。

从其注释文档看,io.Reader接口的规则更多。

  • Read最多读取len(p)字节的数据,并保存到p;
  • 返回读取的字节数以及任何发生的错误信息;
  • n要满足0 <= n <= len(p);
  • n<len(p)时,表示读取的数据不足以填满p,这时方法会立即返回,而不是等待更多的数据;
  • 读取过程中遇到错误,会返回读取的字节数n以及相应的错误err;
  • 在底层输入流结束时,方法会返回n>0的字节,但是err可能时EOF,也可以是nil;
  • 在第6种(上面)情况下,再次调用read方法的时候,肯定会返回0,EOF;
  • 调用Read方法时,如果n>0时,优先处理处理读入的数据,然后再处理错误err,EOF也要这样处理;
  • Read方法不鼓励返回n=0并且err=nil的情况。

规则稍微比Write接口有点多,不过也都比较好理解。注意第 8 条,即使我们在读取的时候遇到错误,但是也应该处理已经读到的数据。因为这些已经读到的数据是正确的,如果不进行处理丢失的话,读到的数据就不完整了。

示例

对这两个接口了解后,我们就可以尝试使用他们了,现在来看个例子。

func main() {
    //定义零值Buffer类型变量b
    var b bytes.Buffer
    //使用Write方法为写入字符串
    b.Write([]byte("你好"))    
    //这个是把一个字符串拼接到Buffer里
    fmt.Fprint(&b,",","http://www.flysnow.org")    
    //把Buffer里的内容打印到终端控制台
    b.WriteTo(os.Stdout)}

这个例子是拼接字符串到Buffer里,然后再输出到控制台。它非常简单,但是利用了流的读写,bytes.Buffer是一个可变字节的类型,可以让我们很容易的对字节进行操作,比如读写、追加等。bytes.Buffer实现了io.Writer和io.Reader接口,所以我们可以很容易地进行读写操作,而不用关注具体实现。

b.Write([]byte("你好"))实现了写入一个字符串。我们把这个字符串转为一个字节切片,然后调用Write方法写入,这个就是bytes.Buffer为了实现io.Writer接口而实现的一个方法,可以帮我们写入数据流。

func (b *Buffer) Write(p []byte) (n int, err error) {
    b.lastRead = opInvalid
    m := b.grow(len(p))
    return copy(b.buf[m:], p), nil}

以上就是bytes.Buffer实现io.Writer接口的方法。最终我们看到,写入的切片会被拷贝到b.buf里,这里b.buf[m:]拷贝其实就是追加的意思,不会覆盖已经存在的数据。

从实现看,我们发现其实只有b *Buffer指针实现了io.Writer接口,所以我们示例代码中调用fmt.Fprint函数的时候,传递的是一个地址&b。

func Fprint(w io.Writer, a ...interface{}) (n int, err error) {
    p := newPrinter()
    p.doPrint(a)
    n, err = w.Write(p.buf)
    p.free()
    return}

这是函数fmt.Fprint的实现,它的功能就是实现把数据a写入到一个io.Writer接口,具体如何写入,它是不关心的。因为这都是io.Writer会做的,它只关心可以写入即可。w.Write(p.buf)调用Wirte方法写入。

最后的b.WriteTo(os.Stdout)是把最终的数据输出到标准的os.Stdout里,以便我们查看输出,它接收一个io.Writer接口类型的参数。开篇我们讲过os.Stdout也实现了这个io.Writer接口,所以就可以作为参数传入。

这里我们会发现,很多方法的接收参数都是io.Writer接口,当然还有io.Reader接口,这就是面向接口的编程。我们不用关注具体实现,只关注这个接口可以做什么事情。如果我们换成输出到文件里,那也很容易,只需把os.File类型作为参数即可。任何实现了该接口的类型,都可以作为参数。

除了b.WriteTo方法外,我们还可以使用io.Reader接口的Read方法实现数据的读取。

var p [100]byten,err:=b.Read(p[:])fmt.Println(n,err,string(p[:n]))

这是最原始的方法,使用Read方法,n为读取的字节数,然后我们输出打印出来。

因为byte.Buffer指针实现了io.Reader接口,所以我们还可以使用如下方式读取数据信息。

data,err:=ioutil.ReadAll(&b)fmt.Println(string(data),err)

ioutil.ReadAll接收了一个io.Reader接口的参数,表明可以从任何实现了io.Reader接口的类型里读取全部的数据。

func readAll(r io.Reader, capacity int64) (b []byte, err error) {
    buf := bytes.NewBuffer(make([]byte, 0, capacity))
    // If the buffer overflows, we will get bytes.ErrTooLarge.
    // Return that as an error. Any other panic remains.
    defer func() {
        e := recover()        
        if e == nil {
                    return
        }      
        if panicErr, ok := e.(error); ok && panicErr == bytes.ErrTooLarge {
                   err = panicErr            } else {
                    panic(e)
        }
    }()
    _, err = buf.ReadFrom(r)    return buf.Bytes(), err}

以上是ioutil.ReadAll实现的源代码,也非常简单。基本原理是创建一个byte.Buffer,通过byte.Buffer的ReadFrom方法,把io.Reader里的数据读取出来,最后通过byte.Buffer的Bytes方法进行返回,最终读取字节数据信息。

整个流的读取和写入已经被完全抽象啦,io包的大部分操作和类型都是基于这两个接口。当然还有http等其他牵涉到数据流、文件流等,都可以完全用io.Writer和io.Reader接口来表示,通过这两个接口的连接,我们可以实现任何数据的读写。

时间: 2024-10-14 15:39:26

Go语言之Writer 和 Reader的相关文章

java 字符流writer、reader基本操作及理解

字符和字节有什么区别,额--这个我也不知道. 1.基本操作实例 import java.io.*; public class CharDemo { public static void main(String[] args) { File f=new File("F:\\workspace\\Javaprj\\test.txt"); Writer out=null; Reader in=null; try { out=new FileWriter(f); String str=&quo

Java IO操作——字节流(OutputStream、InputStream)和字符流(Writer、Reader)

学习目标 掌握流的概念 掌握字节流与字符流的作用 掌握文件的标准操作步骤 掌握字节与字符操作的区别 流的概念 在程序中所有的数据都是以流的方式进行传输或保存的,程序中需要数据的时候就用输入流读取数据,而当程序需要将一些数据保存起来的时候,就要使用输出流完成. 程序中的输入输出都是以流的形式保存的,流中保存的实际上全部是字节文件. 字节流与字符流 在java.io包中操作文件内容的主要有两大类:字节流和字符流,两类都分为输入和输出操作.在字节流中输出数据主要是使用OutputStream完成,输入

JavaIO(04)字符流--Writer and Reader

字符流: 常识:在java中一个字符等于两个字节: 操作字符流的两个类:Writer,Reader API文档介绍(Writer): public abstract class Writer extends Object implements Appendable, Closeable, Flushable 发现此类依然是抽象类,如果使用子类还是需要使用该子类,FileWriter; Writer类的常用方法: 关闭该流,但要先刷新它: public abstract void close() 

同步阻塞式I/O(二)——基于字符的Writer、Reader

不管是磁盘还是网络传输,最小的存储单元都是字节,而不是字符,所以 I/O 操作的都是字节而不是字符,但是为啥有操作字符的 I/O 接口呢?这是因为我们的程序中通常操作的数据都是以字符形式,有时我们必须把来自于"字节"层次结构中的类和"字符"层次结构中的类结合起来使用,为了实现这个目的,要用到"适配器"类:InputStreamReader可以把InputStream转化为Reader,而OutputStreamWriter可以把OutputStr

IO Writer和Reader

Writer 写入字符流的抽象类.子类必须实现的方法仅有 write(char[], int, int).flush() 和 close().但是,多数子类将重写此处定义的一些方法,以提供更高的效率和/或其他功能. 字段 protected  Object lock 用于同步针对此流的操作的对象. 构造函数 protected Writer() 创建一个新的字符流 writer,其关键部分将同步 writer 自身. protected Writer(Object lock) 创建一个新的字符流

字节流与字符流简单操作(OutputStream、InputStream、Writer、Reader)

操作流程 使用File类打开一个文件 通过字节流或者字符流的子类.指定输出的位置. 进行读/写操作 关闭输入/出 字节流与字符流 在java.io包中操作文件内容主要有两大类:字节流字符流.两大类分为输入和输出操作,在字节流中输出数据主要是OutputStream完成,输入使用InputStream,在字符流冲输出主要是使用Writer类完成,输入主要是Reader完成 字节流 字节流主要是操作byte类型数据,以byte数组为准,主要操作类是OutputStream和InputSream 字节

java IO文件读写例子(OutputStream,InputStream,Writer,Reader)

一,File创建文件 File file = new File("D:" + File.separator + "yi.txt"); 代码示例: package com.hbut.io; import java.io.File; import java.io.IOException; public class FileDemo { public static void main(String[] args) { File file = new File("

javaIO流--Writer,Reader

Writer /** *<li> Writer中定义的一个重要的方法: * public void writer(String str)throws IOException; */ package com.java.demo; import java.io.File; import java.io.FileWriter; import java.io.Writer; public class TestDemo { public static void main(String args[]) t

JAVA IO包的整理---------Writer和Reader

一 Writer public abstract class Writer extends Object implements Appendable, Closeable, Flushable 这个类表示的是输入字符的输入流.然后这个类中有一个同步锁,用来同步这个流内的操作.然后就是这个流和FileInputStream不同的是,它提供了append的方法来实现追加. 然后也有flush,write,close的方法.然后就是既然可以写入字符,那其实也就是可以写入String了.因为这个类并不是