Go语言io pipe源码分析详情

 更新时间:2022年02月09日 10:01:24   作者:zwf193071  
这篇文章主要介绍了Go语言io pipe源码分析详情,pipe是一个适配器,用于连接Reader和Writer,pipe的方法不多,新的写法却不少,并且结构体分两块,读写信道和结束标识,下面进入文章了解具体的内容吧

pipe.go分析:

  • 这个文件使用到了errors包,也是用到了sync库.
  • 文件说明:pipe是一个适配器,用于连接Reader和Writer.

1.结构分析

对外暴露的是一个构造函数和构造的两个对象. 两个对象分别暴露了方法,同时这两个对象还有一个共同的底层对象. 实际上,这两个对象暴露的方法是直接调用底层对象的, 那么核心还是在底层对象上,只是通过两个对象和一个构造方法将底层对象的细节隐藏了.

2.pipe sruct分析

pipe的方法不多,新的写法却不少.   

 type atomicError struct{ v atomic.Value }

    func (a *atomicError) Store(err error) {
      a.v.Store(struct{ error }{err})
    }
    func (a *atomicError) Load() error {
      err, _ := a.v.Load().(struct{ error })
      return err.error
    }

atomicError提供了error的原子读写. 

  type pipe struct {
      wrMu sync.Mutex // Serializes Write operations
      wrCh chan []byte
      rdCh chan int

      once sync.Once // Protects closing done
      done chan struct{}
      rerr atomicError
      werr atomicError
    }

可以看到pipe结构体中主要分两块:

  • 读写信道
    • 两个无缓冲信道
    • 一个互斥量(保护暴露的写函数)
  • 结束标识
    • once保证done的关闭只执行一次
    • done标志整个读写的结束
    • 剩下两个用于存储读写错误
    • PipeReader/PipeWriter的分析

3.PipeReader对外暴露的是读/关闭

    type PipeReader struct {
      p *pipe
    }

    func (r *PipeReader) Read(data []byte) (n int, err error) {
      return r.p.Read(data)
    }

    func (r *PipeReader) Close() error {
      return r.CloseWithError(nil)
    }

    func (r *PipeReader) CloseWithError(err error) error {
      return r.p.CloseRead(err)
    }

PipeWriter对外暴露的是写/关闭 

    type PipeWriter struct {
       p *pipe
     }

    func (w *PipeWriter) Write(data []byte) (n int, err error) {
      return w.p.Write(data)
    }

    func (w *PipeWriter) Close() error {
      return w.CloseWithError(nil)
    }

    func (w *PipeWriter) CloseWithError(err error) error {
      return w.p.CloseWrite(err)
    }

他们的方法集都是指针接收者.具体方法的实现是通过pipe的方法完成的. pipe的方法更加明确:读/获取读错误/结束读写并设置读错误; 写/获取写错误/结束读写并设置写错误.思路相当明确.

下面主要分析pipe的读写 

   func (p *pipe) Read(b []byte) (n int, err error) {
      select {
      case <-p.done:
        return 0, p.readCloseError()
      default:
      }

      select {
      case bw := <-p.wrCh:
        nr := copy(b, bw)
        p.rdCh <- nr
        return nr, nil
      case <-p.done:
        return 0, p.readCloseError()
      }
    }

    func (p *pipe) Write(b []byte) (n int, err error) {
      select {
      case <-p.done:
        return 0, p.writeCloseError()
      default:
        p.wrMu.Lock()
        defer p.wrMu.Unlock()
      }

      for once := true; once || len(b) > 0; once = false {
        select {
        case p.wrCh <- b:
          nw := <-p.rdCh
          b = b[nw:]
          n += nw
        case <-p.done:
          return n, p.writeCloseError()
        }
      }
      return n, nil
    }

读写都是利用两个阶段的select来完成,第一个阶段的select是判断读写有没有结束, 第二阶段处理实际的读写.

Read

  • 每次将读的数量写到读信道

Write

  • 先将缓冲写到写信道,再从读信道中获取读字节数,最后调整缓冲
  • 如果缓冲太大,一次读没读完,就将写的过程多来几遍,知道缓冲全部写完

4.写法

PipeWriter/PipeReader对外暴露的关闭,其实只可以保留一个CloseWithError, 但是为了方便客户(调用者),还是拆成两个,其实可以做测试比较一下. 性能测试发现拆成两个或写成一个可选参函数,性能上差别不大, 那这种写法的主要作用是让暴露的方法更加清晰易懂.

pipe.Write中,for循环带有once参数,可以保证循环至少来一次, 算是do while的一种实现.

5.总结

不管是PipeReader/PipeWriter,还是pipe,都对Reader/Writer有(部分)实现.

另外还有一些细节没有说道:读写错误和EOF.

反思:本次阅读是先理代码后看文档,才发现关于error部分没有留心到, 后面还是先文档后代码,这样效率会高一点.

到此这篇关于Go语言io pipe源码分析详情的文章就介绍到这了,更多相关Go语言io pipe源码分析内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Golang Gin框架实现多种数据格式返回结果详解

    Golang Gin框架实现多种数据格式返回结果详解

    这篇文章主要介绍了Golang Gin框架实现多种数据格式返回结果,我们都知道,一个完整的请求包含请求和处理请求以及结果返回三个步骤,在服务器端对请求处理完成以后,会将结果返回给客户端,在gin框架中,支持返回多种请求数据格式,下面我们一起来看看
    2023-05-05
  • go语言 xorm框架 postgresql 的用法及详细注解

    go语言 xorm框架 postgresql 的用法及详细注解

    这篇文章主要介绍了go语言 xorm框架 postgresql 的用法及详细注解,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-12-12
  • mac下golang安装了windows编译环境后编译变慢

    mac下golang安装了windows编译环境后编译变慢

    这篇文章主要介绍了mac下golang安装了windows编译环境后编译变慢的处理方法,非常的简单,有相同问题的小伙伴可以参考下。
    2015-04-04
  • Golang开发中常用的代码片段汇总

    Golang开发中常用的代码片段汇总

    这篇文章主要给大家汇总了在Golang开发中常用的代码片段,这些代码片段都是在日常工作中编写golang应用时使用到,需要的朋友可以参考借鉴,下面跟着小编一起来学习学习吧。
    2017-07-07
  • go语言文件正则表达式搜索功能示例

    go语言文件正则表达式搜索功能示例

    这篇文章主要介绍了go语言文件正则表达式搜索功能,涉及Go语言文件目录的遍历及正则操作相关技巧,需要的朋友可以参考下
    2017-01-01
  • Golang开发中如何解决共享变量问题

    Golang开发中如何解决共享变量问题

    Go提供了传统通过共享变量,也就是共享内存的方式来实现并发。这篇文章会介绍 Go提供的相关机制,对Golang共享变量相关知识感兴趣的朋友一起看看吧
    2021-09-09
  • Go语言之io.ReadAtLeast函数的基本使用和原理解析

    Go语言之io.ReadAtLeast函数的基本使用和原理解析

    io.ReadAtLeast函数是Go语言标准库提供的一个工具函数,能够从数据源读取至少指定数量的字节数据到缓冲区中,这篇文章主要介绍了io.ReadAtLeast函数的相关知识,需要的朋友可以参考下
    2023-07-07
  • Go gin框架处理panic的方法详解

    Go gin框架处理panic的方法详解

    本文我们介绍下recover在gin框架中的应用, 首先,在golang中,如果在子协程中遇到了panic,那么主协程也会被终止,文中通过代码示例介绍的非常详细,需要的朋友可以参考下
    2023-09-09
  • Golang嵌入资源文件实现步骤详解

    Golang嵌入资源文件实现步骤详解

    在应用程序中附带代码以外的其他资源可能会很有用,常用的实现方法是嵌入对象或数据。在数据库中存储数据应用中,需要定义schema,在应用启动时创建表,但如果找不到schema文件呢?Go1.16提供embed包让实现变得简单,之前很多第三方包实现类似功能
    2023-01-01
  • Go reflect 反射原理示例详解

    Go reflect 反射原理示例详解

    这篇文章主要为大家介绍了Go reflect 反射原理示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-11-11

最新评论