Golang 最细节篇之 — Reader 和 ReaderAt 的区别

发表于 2年以前  | 总阅读数:781 次

大纲

  • Golang 关于 Read 的两个接口定义
  • C 语言 libc 库关于 read 的接口
  • Golang 里 Read 和 ReadAt 的区别
  • 那么,会出什么样的坑呢?
  • 总结

概述

分享一个细节语义问题引发的思考。关于 Golang Read,ReadAt 这两个接口,不知道大家有没有仔细品过这两个接口的区别。golang 里面有两个关于 Read 的 interface ,就是 Reader 和 ReaderAt ,这两个接口的定义在标准库 io 的 io.go 文件中,如下:

Golang 关于 Read 的两个接口定义

Reader interface 定义

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

ReaderAt interface 定义

type ReaderAt interface {
    ReadAt(p []byte, off int64) (n int, err error)
}

从 interface 接口来看,我们看到的区别是:

  • Reader 传入参数只有一个 p( 用来装读到的数据的 buffer ),返回参数是 n(读了多少数据),err(返回的错误码);
  • ReaderAt 传入参数是两个,一个 ( 装读到的数据 buffer ),off(读取的偏移位置),返回值 n(表示读到了多少数据),err(错误码);

也就是说,Read 读数据的时候只需要给一个 buffer 就行了,偏移在内部维护,ReadAt 可以让你从指定的位置读数据,偏移自维护。这个是两个接口的最明显的区别,现在我的问题是:真的只有这样吗?

C 语言 libc 库关于 read 的接口

思考这个问题之前,我们看下 c 语言相关的接口,关于 libc 库,我们有 3 个读的接口,分别是 read,readv,pread。这三个接口的传入参数略有不同,定义如下(可以用 man 2 read 自行查看手册):

#include <sys/types.h>
#include <sys/uio.h>
#include <unistd.h>

ssize_t
pread(int d, void *buf, size_t nbyte, off_t offset);

ssize_t
read(int fildes, void *buf, size_t nbyte);

ssize_t
readv(int d, const struct iovec *iov, int iovcnt);

简述含义

  1. pread 读取数据,特点是可以指定偏移位置读取;
  • 传入参数:d(文件句柄),buf(内存 buffer),nbyte (buffer 的大小,这个需要正确设置,否则容易越界),offset(文件读取的开始偏移);
  • 返回值:返回读取的数据大小;

2 . read 读取数据;

  • 传入参数:filedes(文件句柄),buf(内存 buffer 地址),nbytes(内存 buffer 大小);
  • 返回值:读取数据的大小;

3 . readv 读取数据,特点是可以用离散的内存块来装数据;

  • 传入参数:d(文件句柄),iov(离散的内存块地址,抽象成向量的概念),iovcnt(内存向量数量);

通过以上的接口,我们注意到:

  1. 由于 c 对于动态数组这个类型,没有严格的检查,语言级别无法检查内存越界等情况,所以,对于数组做参数传入的时候,都是 一个地址,一个长度 这样配套的传入的,比如(buf,nbyte),(iov,iovcnt)都是如此;

2 . 返回值方面,3个函数的返回值语义是一致的,函数返回值表示读到的数据大小,类型是 ssize_t 类型; a. 如果读成功,那么 返回值 > 0,表示读到了多少数据; b. 如果读到了 EOF,那么 >返回值 == 0 ; c. 如果是其他错误,那么 返回值 < 0,这个时候要配合线程变量 errno 来解释;

在接口 man 的描述里,我们注意到这么一段话:

DESCRIPTION

read() attempts to read nbyte bytes of data from the object referenced by the descriptor fildes into the buffer pointed to by buf. readv() performs the same action, but scatters the input data into the iovcnt buffers specified by the members of the iov array: iov[0], iov[1], ..., iov[iovcnt-1]. pread() performs the same function, but reads from the specified position in the file without modifying the file pointer.

也就是说,这三个函数的语义可以说是完全一致的,他们最底层执行的都是一样的函数,只不过传入的参数略有不同而已。

  • 功能上,一个是最平常的 read,一个是可以让我们从指定偏移读数据的 pread,一个是让我们可用离散内存块存储数据的 readv ,除此之外语义是一样的。
  • 关于返回值的解释,读成功的时候,返回值大于0,读到 EOF 的时候,返回值等于 0,读到错误的时候,返回值小于0,可以通过线程变量 errno 进一步获取详细的错误码。

Golang 里 Read 和 ReadAt 的区别

类比 libc,C 的 read,pread 这两个接口对应的是 Golang 的 Read 和 ReadAt 这两个接口,C 的 read,pread 除了传入参数有区别,其他语义是完全一致的。那么 Golang 呢?

答案当然是有巨坑(细节)的区别,不然也不会特意分享出来。下面我们先再去 Golang 标准库 io 看下接口定义:

Reader

ReaderAt

在我标红的两个地方就是最核心的区别(大家细品),Golang 里面 Read 接口对于读的结果有这么几种情况:

  1. 读成功了,数据完全填充 buffer ,读到了用户预期的数据大小,这个时候 n == len(p),err == nil,p 里都是用户有用的数据;

2 . 读失败了,err != nil ,这个时候 err 会标示出对应的错误;

3 . 读到 EOF 了,err == EOF,n 表示读到的有用数据大小,p 部分被填充;

4 . 第四种最坑(最细节),这个也是 Read 特意说明的(我截屏标红的), golang 允许当数据还没全部准备好的时候,返回部分数据,这个时候 err == nil; 也就是说,Read 接口允许:没有读满预期的 buffer,也不是 EOF 的情况,err == nil,这种情况是 Golang Read 接口语义的一部分;

而对于 ReadAt 接口,Golang 的 interface 也特意说明了,这个接口比 Read 更严格,不允许第四种情况的发生。也就是说,ReadAt 读数据的结果,只有三种:

  1. 那么就是读成功,读满 buffer,这个时候 n==len(p),err==nil;
  2. 要么就是读到 EOF,这个时候没有读满 buffer,只读到了部分有效数据,n<len(p),err==EOF,n 指明有效数据的大小;
  3. 要么就是读失败,这个时候 err 表示错误码;

ReadAt 绝对不允许出现,没有读满 buffer,又非 EOF,又没有 err 的情况发生,这个是接口语义明确规定的,这是一个非常细节的区别。

那么,会出什么样的坑呢?

这么小的细节,可能带来的是非常严重的问题,因为这个是数据相关的问题,对于存储来说,数据正确性是生命的底线。那么可能带来什么问题呢?下面举个栗子。

Golang 的 interface 应用非常方便,非常容易让你一层层封装逻辑。那么在封装的过程中,一定要保持语义。举一个标准库的栗子,标准库里有一个 LimitedReader 的封装,构造的时候传入一个 N 参数,来保证读取数据的一个上限,什么意思?也就是经过这一个封装,Read 读取最大的数据量不会超过 limit 的设置。我们来看他的实现:

type LimitedReader struct {
     R Reader // underlying reader
     N int64  // max bytes remaining
}

func (l *LimitedReader) Read(p []byte) (n int, err error) {
    if l.N <= 0 {
     return 0, EOF
    }
    if int64(len(p)) > l.N {
        // 经过这一层,就非常有可能出现我们之前提到的第四种情况,并且是个常态;
        p = p[0:l.N]
    }
    n, err = l.R.Read(p)
    l.N -= int64(n)
    return
}

那么你能找到 LimitedReaderAt 的实现吗?标准库里是没有的(可以思考下,为啥没有?),如果你要自己实现这么一个功能,那么是绝对不能照搬上面的实现的,否则就违反了 ReadAt 的语义。ReaderAt 规定:在没有读满 buffer 的时候,要么就是 EOF 的场景,要么就是其他 err!=nil 的场景,所以 ReadAt 的实现,封装之后一般要加一个循环处理,在没有读满,要继续处理,直到读满,或者报错。

那么有人想问了,如果没有遵守这个接口语义,可能会出什么事?可能没啥事,也可能出大事。举个例子,如果你 ReadAt 照搬了 Read 的语义,在没有读满的时候,也不报错,那么可能会导致调用者误用了错误的数据,比如下面:

// buffer 是一个 4K 的 slice 结构,off 是偏移
_, err := S.ReadAt(buffer, off)
   if err != nil {
       // 出错处理
}

// 把 buffer 的 4K 数据当作全部有效的数据处理 。。。。。

上面这种代码就是出大事了。所以,理解其中区别了吗?

Golang 的 interface 非常灵活,对于我们做存储的来说,最核心的就是 IO ,也就是Read/Write,Golang 在标准库里定义的 interface 语义一定要看仔细了,保证语义的一致性才能保证逻辑的正确性。

总结

  • Golang 的 Read 和 ReadAt 两个接口语义具有根本性区别,不同于 libc 关于 read 和 pread 的语义;
  • Golang 的 ReadAt 语义相比于 Read 接口更严格,要么成功,要么失败,失败必须有对应 err 说明;
  • 如果你封装了 ReadAt 接口,千万记得保证 ReadAt 的语义,否则就可能出现不可预期的事故;

本文由哈喽比特于2年以前收录,如有侵权请联系我们。
文章来源:https://mp.weixin.qq.com/s/IrAp7Qgfu8GfNSh89SRrSQ

 相关推荐

刘强东夫妇:“移民美国”传言被驳斥

京东创始人刘强东和其妻子章泽天最近成为了互联网舆论关注的焦点。有关他们“移民美国”和在美国购买豪宅的传言在互联网上广泛传播。然而,京东官方通过微博发言人发布的消息澄清了这些传言,称这些言论纯属虚假信息和蓄意捏造。

发布于:6月以前  |  808次阅读  |  详细内容 »

博主曝三大运营商,将集体采购百万台华为Mate60系列

日前,据博主“@超能数码君老周”爆料,国内三大运营商中国移动、中国电信和中国联通预计将集体采购百万台规模的华为Mate60系列手机。

发布于:6月以前  |  770次阅读  |  详细内容 »

ASML CEO警告:出口管制不是可行做法,不要“逼迫中国大陆创新”

据报道,荷兰半导体设备公司ASML正看到美国对华遏制政策的负面影响。阿斯麦(ASML)CEO彼得·温宁克在一档电视节目中分享了他对中国大陆问题以及该公司面临的出口管制和保护主义的看法。彼得曾在多个场合表达了他对出口管制以及中荷经济关系的担忧。

发布于:6月以前  |  756次阅读  |  详细内容 »

抖音中长视频App青桃更名抖音精选,字节再发力对抗B站

今年早些时候,抖音悄然上线了一款名为“青桃”的 App,Slogan 为“看见你的热爱”,根据应用介绍可知,“青桃”是一个属于年轻人的兴趣知识视频平台,由抖音官方出品的中长视频关联版本,整体风格有些类似B站。

发布于:6月以前  |  648次阅读  |  详细内容 »

威马CDO:中国每百户家庭仅17户有车

日前,威马汽车首席数据官梅松林转发了一份“世界各国地区拥车率排行榜”,同时,他发文表示:中国汽车普及率低于非洲国家尼日利亚,每百户家庭仅17户有车。意大利世界排名第一,每十户中九户有车。

发布于:6月以前  |  589次阅读  |  详细内容 »

研究发现维生素 C 等抗氧化剂会刺激癌症生长和转移

近日,一项新的研究发现,维生素 C 和 E 等抗氧化剂会激活一种机制,刺激癌症肿瘤中新血管的生长,帮助它们生长和扩散。

发布于:6月以前  |  449次阅读  |  详细内容 »

苹果据称正引入3D打印技术,用以生产智能手表的钢质底盘

据媒体援引消息人士报道,苹果公司正在测试使用3D打印技术来生产其智能手表的钢质底盘。消息传出后,3D系统一度大涨超10%,不过截至周三收盘,该股涨幅回落至2%以内。

发布于:6月以前  |  446次阅读  |  详细内容 »

千万级抖音网红秀才账号被封禁

9月2日,坐拥千万粉丝的网红主播“秀才”账号被封禁,在社交媒体平台上引发热议。平台相关负责人表示,“秀才”账号违反平台相关规定,已封禁。据知情人士透露,秀才近期被举报存在违法行为,这可能是他被封禁的部分原因。据悉,“秀才”年龄39岁,是安徽省亳州市蒙城县人,抖音网红,粉丝数量超1200万。他曾被称为“中老年...

发布于:6月以前  |  445次阅读  |  详细内容 »

亚马逊股东起诉公司和贝索斯,称其在购买卫星发射服务时忽视了 SpaceX

9月3日消息,亚马逊的一些股东,包括持有该公司股票的一家养老基金,日前对亚马逊、其创始人贝索斯和其董事会提起诉讼,指控他们在为 Project Kuiper 卫星星座项目购买发射服务时“违反了信义义务”。

发布于:6月以前  |  444次阅读  |  详细内容 »

苹果上线AppsbyApple网站,以推广自家应用程序

据消息,为推广自家应用,苹果现推出了一个名为“Apps by Apple”的网站,展示了苹果为旗下产品(如 iPhone、iPad、Apple Watch、Mac 和 Apple TV)开发的各种应用程序。

发布于:6月以前  |  442次阅读  |  详细内容 »

特斯拉美国降价引发投资者不满:“这是短期麻醉剂”

特斯拉本周在美国大幅下调Model S和X售价,引发了该公司一些最坚定支持者的不满。知名特斯拉多头、未来基金(Future Fund)管理合伙人加里·布莱克发帖称,降价是一种“短期麻醉剂”,会让潜在客户等待进一步降价。

发布于:6月以前  |  441次阅读  |  详细内容 »

光刻机巨头阿斯麦:拿到许可,继续对华出口

据外媒9月2日报道,荷兰半导体设备制造商阿斯麦称,尽管荷兰政府颁布的半导体设备出口管制新规9月正式生效,但该公司已获得在2023年底以前向中国运送受限制芯片制造机器的许可。

发布于:6月以前  |  437次阅读  |  详细内容 »

马斯克与库克首次隔空合作:为苹果提供卫星服务

近日,根据美国证券交易委员会的文件显示,苹果卫星服务提供商 Globalstar 近期向马斯克旗下的 SpaceX 支付 6400 万美元(约 4.65 亿元人民币)。用于在 2023-2025 年期间,发射卫星,进一步扩展苹果 iPhone 系列的 SOS 卫星服务。

发布于:6月以前  |  430次阅读  |  详细内容 »

𝕏(推特)调整隐私政策,可拿用户发布的信息训练 AI 模型

据报道,马斯克旗下社交平台𝕏(推特)日前调整了隐私政策,允许 𝕏 使用用户发布的信息来训练其人工智能(AI)模型。新的隐私政策将于 9 月 29 日生效。新政策规定,𝕏可能会使用所收集到的平台信息和公开可用的信息,来帮助训练 𝕏 的机器学习或人工智能模型。

发布于:6月以前  |  428次阅读  |  详细内容 »

荣耀CEO谈华为手机回归:替老同事们高兴,对行业也是好事

9月2日,荣耀CEO赵明在采访中谈及华为手机回归时表示,替老同事们高兴,觉得手机行业,由于华为的回归,让竞争充满了更多的可能性和更多的魅力,对行业来说也是件好事。

发布于:6月以前  |  423次阅读  |  详细内容 »

AI操控无人机能力超越人类冠军

《自然》30日发表的一篇论文报道了一个名为Swift的人工智能(AI)系统,该系统驾驶无人机的能力可在真实世界中一对一冠军赛里战胜人类对手。

发布于:6月以前  |  423次阅读  |  详细内容 »

AI生成的蘑菇科普书存在可致命错误

近日,非营利组织纽约真菌学会(NYMS)发出警告,表示亚马逊为代表的电商平台上,充斥着各种AI生成的蘑菇觅食科普书籍,其中存在诸多错误。

发布于:6月以前  |  420次阅读  |  详细内容 »

社交媒体平台𝕏计划收集用户生物识别数据与工作教育经历

社交媒体平台𝕏(原推特)新隐私政策提到:“在您同意的情况下,我们可能出于安全、安保和身份识别目的收集和使用您的生物识别信息。”

发布于:6月以前  |  411次阅读  |  详细内容 »

国产扫地机器人热销欧洲,国产割草机器人抢占欧洲草坪

2023年德国柏林消费电子展上,各大企业都带来了最新的理念和产品,而高端化、本土化的中国产品正在不断吸引欧洲等国际市场的目光。

发布于:6月以前  |  406次阅读  |  详细内容 »

罗永浩吐槽iPhone15和14不会有区别,除了序列号变了

罗永浩日前在直播中吐槽苹果即将推出的 iPhone 新品,具体内容为:“以我对我‘子公司’的了解,我认为 iPhone 15 跟 iPhone 14 不会有什么区别的,除了序(列)号变了,这个‘不要脸’的东西,这个‘臭厨子’。

发布于:6月以前  |  398次阅读  |  详细内容 »
 相关文章
Android插件化方案 5年以前  |  236810次阅读
vscode超好用的代码书签插件Bookmarks 1年以前  |  6656次阅读
 目录