Redispy 源码学习(三) --- RESP协议实现--编码

经过对RESP协议的阅读,我们了解redis客户端和服务端的通信方式。下面将根据resp协议使用python3实现其编码,也就是将客户端的查询命令按照RESP协议编码。

字符编码

在处理resp编码之前,有必要对字符的编码做简单的介绍。计算机给人感觉很强大,可是它们处理的数据的基本构成却很简单。任何计算机里的数据,无非都是一些二进制的0或者1。这些0和1当然不适合给人类阅读,人类只写自己认识的字符,例如hello world1 + 1之类的字符。计算机当然也会抗议,毕竟它们不懂。为了让计算机能懂人类可读的字符,就需要把这些字符转换成0或1组成的二进制数据。这个转换过程就是编码,顾名思义,编码的反方向就是解码。

由于计算机是西方人搞出来的,美国人思来想去,拉丁字符才26个,乱七八糟的标点和美元百分好加起来也不过百多个。一个字节有8位,可以表示256种字符(2**8)。一个字节编码符号绰绰有余。然后他们就依此指定了一个编码表,即ASCII表。

可是没多久,同样是西方人的欧洲其他国家不干了,像法国德国这样除了拉丁字符,还有类似拼音声调的字符,ASCII的规定就不够了。不仅这些字符,中国的汉字,日本文字,阿拉伯文字等,都无法用ASCII表示。既然世界文化这么多,就只能想一个完全之策来大一统。

Unicode应运而生,简而言之就是使用2-4个字节来编码。数量上肯定是足够了,可是对于ASCII码,无缘无故多出几个字节来编码显然不合算,因此Unicde的一种实现utf-8就诞生了。utf-8兼容ascii方式,可以根据具体情况用1-4个字节来表示一个字符。例如一个汉字unicode编码是一个长度 \u534eutf-8的编码则是三个字符长度\xe5\x8d\x8e

除了utf-8编码,中文世界里常见的是gbk方式编码。gbk和utf-8一样,也是一种编码方式,不过只对中国的汉字和少数几个民族文字兼容。范围上比utf-8要小。

python字符编码

提及编码,python2经常出现UnicodeDecodeError错误,尤其是爬虫的时候这个错误常被人诟病,很多人转向python3。可是如果搞不清编码与解码的问题,python3也会出现UnicodeDecodeError异常。

python3中,所有字串都是unicode实现。也就是str类型。字串可以编码成bytes类型,bytes类型可以解码成字串。

>>> s = 'hello 世界'
>>> type(s)
<class 'str'>
>>> s.encode('utf-8')
b'hello \xe4\xb8\x96\xe7\x95\x8c'
>>> type(s.encode('utf-8'))
<class 'bytes'>
>>> b = b'hello 世界'
  File "<stdin>", line 1
SyntaxError: bytes can only contain ASCII literal characters.
>>> b = b'hello \xe4\xb8\x96\xe7\x95\x8c'
>>> b
b'hello \xe4\xb8\x96\xe7\x95\x8c'
>>> b.decode('utf-8')
'hello 世界'
>>> len(b)
12

对于python2而言,引号定义的字串是utf-8或者gbk的编码(依赖系统)。使用u加字串定义的是unicode。因此py2也有encode和decode的方式。

无论py2还是py3,计算机内存处理的字串都是unicode,当写入文件或者在网络IO流中,都应该编码成utf-8的格式(utf-8国际通用,就不必使用gbk了)。

解码的时候就不能一概而论了。很多爬虫的程序中,被爬的网站比较古老,使用了gbk的编码。若不假思索的就以utf-8的方式decode,肯定会报错。使用requests库的时候,很少出现字符解码错误,因为它内部有一个程序会先判断目标字符的编码,然后再针对性的解码。因此我们写程序的时候,解码也应该先猜除对方编码。至于怎么猜,可以学习requests的方式。

resp 字符编码

说来那么多python的编码,为得是下面RESP做铺垫。根据redis.py 的源码,编码和解码的方法挂载在Connection类的下面。因此我们的客户端调用代码如下:

 args = ('PING',)
 packed_command =  Connection().pack_command(*args)
 print(packed_command)

调用打印的结果为 [b'*1\r\n$4\r\nPING\r\n'],和预期的编码一样。

Connection 类

首先创建一个Connection类,我们需要初始化其编码方式和编码错误。

class Connection(object):
    def __init__(self, encoding='utf-8', encoding_errors='strict'):
        self.encoding = encoding
        self.encoding_errors = encoding_errors
    
    def pack_command(self, *args):
        pass

编码命令

接下来实现pack_command 方法。

    def pack_command(self, *args):
        """将redis命令安装redis的协议编码,返回编码后的数组,如果命令很大,返回的是编码后chunk的数组"""
        output = []
        command = args[0]
        if ' ' in command:
            args = tuple([Token(s) for s in command.split(' ')]) + args[1:]
        else:
            args = (Token(command),) + args[1:]

        buff = SYM_EMPTY.join(
                (SYM_STAR, b(str(len(args))), SYM_CRLF))

        for arg in map(self.encode, args):
            # 数据量特别大的时候,分成部分小的chunk
            if len(buff) > 6000 or len(arg) > 6000:
                buff = SYM_EMPTY.join((buff, SYM_DOLLAR, b(str(len(arg))), SYM_CRLF))
                output.append(buff)
                output.append(arg)
                buff = SYM_CRLF
            else:
                buff = SYM_EMPTY.join((buff, SYM_DOLLAR, b(str(len(arg))), SYM_CRLF, arg, SYM_CRLF))

        output.append(buff)
        return output

该方法首先判断了命令的方式,是单命令(PING)还是复合命令(CONFIG SET)。然后针对这两种方式分别使用Token编码。Token即命令的头标签。

然后使用SYM_EMPTY把字符头标签进行编码。

def b(x):
    '''将`unicode`编码成`bytes` 编码格式位 `latin-1`'''
    return x.encode('latin-1') if not isinstance(x, bytes) else x

SYM_STAR = b('*')
SYM_DOLLAR = b('$')
SYM_CRLF = b('\r\n')
SYM_EMPTY = b('')

因为传输的字串应该是字节串(bytes)类型,并且几个符号都是ascii符号,因此编码成latin-1utf-8都是一样的。

可以看见PING编码的头标签为'*1\r\nCONFIG SET的oken为b'*4\r\n'

接下来就是一个迭代编码除了token之外,编码命令和参数。当buff不大的时候,就直接按照RESP协议串联即可。即token + $ + 字节串长度+CRLF+参数+CRLF的方式

如果token和参数大于6000字节长度,就把编码的命令组合拆分为小长度的chunk数组。

当然,在迭代命令和参数之前,需要将这些字串编码成字节串。即map(self.encode, args)的功能,对应的encode方法如下:

    def encode(self, value):
        if isinstance(value, Token):
            return b(value.value)
        elif isinstance(value, bytes):
            return value
        elif isinstance(value, int):
            value = b(str(value))
        elif not isinstance(value, str):
            value = str(value)
        if isinstance(value, str):
            value = value.encode(self.encoding, self.encoding_errors)
        return value

此时可以看出头标签使用Token封装,便于此时encode成bytes字节串,同时为python2提供了兼容的接口。python2只要重写一个b函数即可。

总结

RESP编码比较简单,源于RESP的协议设计精巧。代码实现的内容并不多。无非就是需要注意头标签token的编码,和当命令参数特别长的时候,拆分字节串为chunk数组来发送数据。此外还需要注意,任何网络传输的数据,都不能是直接的字符串,而是编码成utf-8的字节串。

RESP的编码并不复杂,更多挑战在于如何解码redis服务器的响应。在解析响应之前,我们应该创建redis的连接,将编码的命令发送到redis服务器。

文中相关代码

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343

推荐阅读更多精彩内容