Redis设计与实现 学习笔记 第二章 简单动态字符串

第一部分开始 数据结构与对象

Redis没有直接使用C语言传统的字符串表示（以空字符结尾的字符数组，以下简称C字符串），而是自己构建了一种名为简单动态字符串（simple dynamic string，SDS）的抽象类型，并将SDS用作Redis的默认字符串表示。

在Redis里面，C字符串只会作为字符串字面量（string literal）用在一些无须对字符串值进行修改的地方，比如打印日志：

当Redis需要的不仅仅是一个字符串字面量，而是一个可以被修改的字符串值时，Redis就会使用SDS来表示字符串值，比如在Redis的数据库里面，包含字符串值的键值对在底层都是由SDS实现的。

举个例子，如果客户端执行命令：

那么Redis将在数据库中创建一个新的键值对，其中：
1.键值对的键是一个字符串对象，对象的底层是一个保存着字符串"msg"的SDS。

2.键值对的值也是一个字符串对象，对象的底层实现是一个保存着字符串"hello world"的SDS。

又比如，客户端执行命令：

那么Redis将在数据库中创建一个新的键值对，其中：
1.键值对的键是一个字符串对象，对象的底层实现是一个保存了字符串"fruits"的SDS。

2.键值对的值是一个列表对象，列表对象包含了三个字符串对象，这三个字符串对象分别由三个SDS实现：第一个SDS保存着字符串"apple"，第二个SDS保存着字符串"banana"，第三个SDS保存着字符串"cherry"。

除了用来保存数据库中的字符串值之外，SDS还被用作缓冲区（buffer）：AOF模块中的AOF缓冲区，以及客户端状态中的输入缓冲区，都是由SDS实现的，在之后介绍AOF持久化和客户端状态的时候，我们会看到SDS在这两个模块中的应用。

2.1 SDS的定义

每个sds.h/sdshdr结构表示一个SDS值：

struct sdshdr {
    // SDS保存的字符串长度
    int len;
    // buf数组中未使用的字节数
    int free;
    // 字节数组，用于保存字符串
    char buf[];
}

上图是一个SDS示例：
1.free属性值为0，表示这个SDS没有分配任何未使用空间。

2.len属性值为5，表示这个SDS保存了一个5字节长的字符串。

3.buf属性是一个char型数组，最后一个字节保存了空字符’\0’。

SDS遵循C字符串以空字符结尾的惯例，保存空字符的1字节空间不算在SDS的len属性里。为空字符分配额外的1字节空间、添加空字符到字符串末尾等操作，都是由SDS函数自动完成的，这个空字符对于SDS的使用者来说是完全透明的。遵循空字符结尾这一惯例的好处是，SDS可以直接重用一部分C字符串函数库里的函数。

举个例子，如果我们有一个指向图2-1所示SDS的指针s，那么我们可以直接使用<stdio.h>/printf函数打印处SDS保存的字符串值"Redis"，而无须为SDS编写专门的打印函数：

printf("%s", s->buf);

图2-2展示了另一个SDS，它和之前展示的SDS一样，都保存了字符串值"Redis"，但这个SDS为buf数组分配了5字节未使用空间，所以它的free属性值为5。

2.2 SDS与C字符串的区别

根据传统，C语言使用长为N+1的字符数组来表示长为N的字符串，并且字符数组的最后一个元素总是空字符’\0’。

例如，下图就展示了一个值为"Redis"的C字符串：

C语言使用的这种简单的字符串表示方式，并不能满足Redis对字符串在安全性、效率、功能方面的要求，接下来将详细对比C字符串和SDS之间的区别，并说明SDS更适用于Redis的原因。

2.2.1 常数复杂度获取字符串长度

因为C字符串不记录自身长度信息，所以为了获取一个C字符串的长度，程序必须遍历整个字符串，对遇到的每个字符计数，直到遇到代表字符串结尾的空字符为止，这个操作的时间复杂度为O(N)。

举个例子，下图展示了程序计算一个C字符串长度的过程：

而SDS在len属性中记录了SDS本身的长度，所以获取一个SDS长度的复杂度为O(1)。

设置和更新SDS长度的工作由SDS的API在执行时自动完成，使用SDS无须进行任何手动修改长度的工作。

通过使用SDS而不是C字符串，Redis将获取字符串长度所需的时间复杂度从O(N)降低到了O(1)，这确保了获取字符串长度的工作不会成为Redis的性能瓶颈。例如，因为字符串键在底层使用SDS来实现，所以即使我们对一个非常长的字符串键反复执行STRLEN命令，也不会对系统性能造成任何影响，因为STRLEN命令的复杂度为O(1)。

2.2.2 杜绝缓冲区溢出

C字符串不记录自身长度导致容易造成缓冲区溢出（buffer overflow）。举个例子，<string.h>/strcat函数可以将src字符串中的内容拼接到dest字符串的末尾：

char *strcat(char *dest, const char *src);

因为C字符串不记录自身的长度，所以strcat假定用户在执行这个函数时，已经为dest分配了足够多的内存，可以容纳src字符串中的所有内容，而一旦这个假定不成立时，就会产生缓冲区溢出。

举个例子，假设程序里有两个在内存中紧邻的C字符串s1和s2，其中s1保存了字符串"Redis"，s2保存了字符串"MongoDB"，如图2-7所示：

如果一个程序员决定执行以下代码：

strcat(s1, " Cluster");

将s1的的内容修改为"Redis Cluster"，但粗心的他却忘了在执行strcat前为s1分配足够的空间，那么在strcat函数执行后，s1的数据将溢出到s2所在的空间中，导致s2保存的内容被意外修改：

与C字符串不同，SDS的空间分配策略完全杜绝了发生缓冲区溢出的可能性：当SDS API需要对SDS进行修改时，API会先检查SDS的空间是否满足修改所需的要求，如果不满足，API会自动将SDS的空间扩展至执行修改所需的大小，然后才执行实际的修改操作，所以使用SDS既不需要手动修改SDS的空间大小，也不会出现前面所说的缓冲区溢出问题。

举个例子，SDS的API里也有一个用于执行拼接操作的sdscat函数，它可以将一个C字符串拼接到给定SDS所保存的字符串后面，但在执行拼接操作前，sdscat会先检查给定SDS的空间是否足够，如果不够的话，sdscat就会先扩展SDS的空间，然后才执行拼接操作。

例如，如果我们执行：

sdscat(s, " Cluster");

其中SDS值s如图2-9所示：

那么sdscat将在执行拼接操作前检查s的长度是否足够，在发现s目前的空间不足以拼接" Cluster"后，sdscat就会先扩展s的空间，然后才执行拼接操作，拼接操作完成后的SDS如图2-10所示：

注意，图2-10所示的SDS表明，sdscat不仅对这个SDS进行了拼接操作，还为SDS分配了13字节的未使用空间，且拼接后的字符串也正好是13字节长，这不是巧合，它和SDS的空间分配策略有关，接下来的小节将介绍这一策略。

2.2.3 减少修改字符串时带来的内存重分配次数

对于C字符串，每次增长或缩短一个C字符串，程序总要对保存这个C字符串的数组进行一次内存重分配操作：
1.如果是增长字符串，程序需要先通过内存分配来扩展底层数组的空间大小——如果忘了就会产生缓冲区溢出。

2.如果是缩短字符串，程序需要通过内存重分配来释放字符串不再使用的那部分空间——如果忘了就会产生内存泄漏。

因为内存重分配涉及复杂的算法，且可能需要执行系统调用，所以它通常是一个比较耗时的操作：
1.在一般程序中，修改字符串长度的情况不太常出现，那么每次修改都执行一次内存重分配是可以接受的。

2.Redis作为数据库，常被用于速度要求严苛、数据被频繁修改的场合，如果每次修改字符串长度都需要执行一次内存重分配，那么光是执行内存重分配就会占去修改字符串所用时间的一大部分，如果这种修改频繁发生的话，可能还会对性能造成影响。

为了避免C字符串的这种缺陷，SDS通过未使用空间解除了字符串长度和底层数组长度之间的关联：在SDS中，buf数组的长度不一定就是字符数量加1，数组里面可以包含未使用的字节，而这些字节的数量就由SDS的free属性记录。

通过未使用空间，SDS实现了空间预分配和惰性空间释放两种优化策略。

1.空间预分配

空间预分配用于优化SDS字符串增长操作：当SDS的SPI对一个SDS进行修改，且需要对SDS进行空间扩展的时候，程序会为SDS多分配一些额外的未使用空间。

其中，额外分配的未使用空间由以下公式决定：
（1）如果对SDS修改后的len属性值小于1MB，那么分配后的len和free相同，即分配和len同样大小的空闲空间。如图2-10，修改后的buf数组长度为13+13+1=27字节。

（2）如果修改后SDS的len属性大于等于1MB，那么程序会分配1MB的未使用空间。

通过空间预分配策略，Redis可以减少连续执行字符串增长操作所需的内存重分配次数。

如果我们对图2-10的SDS执行：

sdscat(s, " Tutorial");

那么这次sdscat将不需要执行内存重分配，因为未使用空间有13字节，足以保存9字节的" Tutorial"，执行后的SDS如图2-13所示：

在扩展SDS空间前，SDS API会先检查未使用空间是否足够，如果足够，API就会直接使用未使用空间，无须执行内存重分配。

通过这种预分配策略，SDS将连续增长N次字符串所需的内存重分配次数从必定N次降低为最多N次。

2.惰性空间释放

惰性空间释放用于优化SDS的字符串缩短操作：当SDS的API需要缩短SDS保存的字符串时，程序并不立即使用内存重分配来回收缩短后多出来的字节，而是使用free属性将这些字节的数量记录起来，并等待将来使用。

举个例子，sdstrim函数接受一个SDS和一个C字符串作为参数，从SDS的左右两端分别移除所有在C字符串中出现过的字符。

比如对于图2-14所示的SDS值s来说：


执行：

sdstrim(s, "XY"); // 移除SDS字符串两端的所有X和Y

会将SDS修改成图2-15所示的样子：

注意执行sdstrim后的SDS并没有释放多出来的8字节空间，而是将这8字节空间加到了free上。如果将来要对SDS进行增长操作，这些未使用空间就可能会派上用场。

举个例子，如果现在对s执行：

sdscat(s, " Redis");

那么完成这次sdscat操作将不需要执行内存重分配，因为空间还足够，如图2-16所示：

通过惰性空间释放策略，SDS避免了缩短字符串时所需的内存重分配操作，并为将来可能有的增长操作提供了优化。

与此同时，SDS也提供了相应的API，让我们在有需要时，真正地释放SDS的未使用空间，所以不用担心惰性空间释放策略会造成内存浪费。

2.2.4 二进制安全

C字符串中的字符必须符合某种编码（比如ASCII），且除了字符串的末尾外，字符串里不能包含空字符，否则最先被程序读入的空字符将被误认为是字符串结尾，这些限制使得C字符串只能保存文本数据，而不能保存图片、音频、视频、压缩文件这样的二进制数据。

举个例子，如果有一种使用空字符来分割多个单词的特殊数据格式，如图2-17所示：

那么这种格式就不能使用C字符串来保存，因为C字符串所用的函数只会识别出其中的"Redis"，而忽略之后的内容。

虽然数据库一般用于保存文本数据，但使用数据库来保存二进制数据的场景也不少见，因此，为了确保Redis可以适用于各种不同的使用场景，SDS的API都是二进制安全的（binary-safe），所有SDS API都会以处理二进制的方式来处理存放在buf数组里的数据，程序不会对其中的数据做任何限制、过滤、假设，数据在写入时是什么样的，它被读取时就是什么样。

这也是我们将SDS的buf属性称为字节数组的原因——Redis不是用这个数组来保存字符，而是用它来保存一系列二进制数据。

SDS保存图2-17中的特殊数据格式就没有任何问题，因为SDS使用len属性而非空字符来判断字符串是否结束：

通过使用二进制安全的SDS，而不是C字符串，使得Redis不仅可以保存文本数据，还可以保存任意格式的二进制数据。

2.2.5 兼容部分C字符串函数

虽然SDS的API都是二进制安全的，但它们在将数据存放到buf数组时一样会遵循C字符串以空字符结尾的惯例，这是为了让那些保存文本数据的SDS可以重用一部分<string.h>库定义的函数。

举个例子，如图2-19所示，如果我们有一个保存文本数据的SDS值sds，我们就可以重用<string.h>/strcasecmp函数，使用它来对比SDS保存的字符串和另一个C字符串：

strcasecmp(sds->buf, "hello world");

这样Redis就不用自己专门写一个函数来对比文本SDS值和C字符串值了。

与此类似，我们还可以将一个保存文本数据的SDS直接使用strcat函数进行追加：

strcat(c_string, sds->buf);

通过遵循C字符串以空字符结尾的惯例，SDS可以在有需要时重用<string.h>函数库，避免了不必要的代码重复。

2.2.6 总结

2.3 SDS API


上图有个错误，sdstrim函数的时间复杂度为O(MN)，M为SDS串长度，N为给定C串的长度。

2.4 重点回顾

1.Redis只将C字符串作为字面量使用，在大多数情况下，Redis使用SDS（Simple Dynamic String，简单动态字符串）作为字符串表示。

2.比起C字符串，SDS具有以下优点：
（1）常数复杂度获取字符串长度。

（2）杜绝缓冲区溢出。

（3）减少修改字符串长度时所需的内存重分配次数。

（4）二进制安全。

（5）兼容部分C字符串函数。