Redis数据结构-简单动态字符串

一、前言

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

• 获取存储的字符串长度时间复杂度从O（N）变为O（1）
• 杜绝缓存溢出
• 减少修改字符串长度时所需的内存重分配次数
• 可以保证二进制安全
• 遵循C语言字符串规则，兼容部分C字符串函数

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

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

除了用来保存数据库中的字符串值之外，SDS还被用作缓冲区（buffer）：AOF模块中的 AOF缓冲区，以及客户端状态中的输入缓冲区，都是由SDS实现的。

二、SDS的定义

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

如图展示了一个SDS示例：

• free属性的值为0，表示这个SDS没有分配任何未使用空间。
• len属性的值为5，表示这个SDS保存了一个五字节长的字符串。
• buf属性是一个char类型的数组，数组的前五个字节分别保存了’R’、‘e’、‘d’、‘i’、‘s’五个 字符，而最后一个字节则保存了空字符’\0’。

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

三、SDS与C字符串的区别

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

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

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

3-1、常数复杂度获取字符串长度

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

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

和C字符串不同，因为SDS在len属性中记录了SDS本身的长度，所以获取一个SDS长度的 复杂度仅为O（1）。

举个例子，下图所示的SDS来说，程序只要访问SDS的len属性，就可以立即知道 SDS的长度为5字节。

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

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

不了解算法复杂度概念的可以查看：算法度量方法—时间复杂度及空间复杂度

3-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"，如下图所示。

如果一个程序员决定通过执行：

strcat(s1, " Cluster");

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

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

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

正如 3-1、3-2 所讲，因为C字符串并不记录自身的长度，所以对于一个包含了N个字符的C字符串来说，这个C字符串的底层实现总是一个N+1个字符长的数组（额外的一个字符空 间用于保存空字符）。因为C字符串的长度和底层数组的长度之间存在着这种关联性，所以每次增长或者缩短一个C字符串，程序都总要对保存这个C字符串的数组进行一次内存重分配操作：

• 如果程序执行的是增长字符串的操作，比如拼接操作（append），那么在执行这个操作 之前，程序需要先通过内存重分配来扩展底层数组的空间大小——如果忘了这一步就会产生 缓冲区溢出。
• 如果程序执行的是缩短字符串的操作，比如截断操作（trim），那么在执行这个操作之 后，程序需要通过内存重分配来释放字符串不再使用的那部分空间——如果忘了这一步就会 产生内存泄漏。

内存重分配涉及复杂的算法，并且可能需要执行系统调用，所以它通常是一个比较 耗时的操作：

• 在一般程序中，如果修改字符串长度的情况不太常出现，那么每次修改都执行一次内存 重分配是可以接受的。
• 但是Redis作为数据库，经常被用于速度要求严苛、数据被频繁修改的场合，如果每次 修改字符串的长度都需要执行一次内存重分配的话，那么光是执行内存重分配的时间就会占 去修改字符串所用时间的一大部分，如果这种修改频繁地发生的话，可能还会对性能造成影响。

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

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

1.空间预分配

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

其中，额外分配的未使用空间数量由以下公式决定：

• 如果对SDS进行修改之后，SDS的长度（也即是len属性的值）将小于1MB，那么程序分 配和len属性同样大小的未使用空间，这时SDS len属性的值将和free属性的值相同。举个例 子，如果进行修改之后，SDS的len将变成13字节，那么程序也会分配13字节的未使用空间，SDS的buf数组的实际长度将变成13+13+1=27字节（额外的一字节用于保存空字符）。
• 如果对SDS进行修改之后，SDS的长度将大于等于1MB，那么程序会分配1MB的未使用 空间。举个例子，如果进行修改之后，SDS的len将变成30MB，那么程序会分配1MB的未使 用空间，SDS的buf数组的实际长度将为30MB+1MB+1by te。

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

2.惰性空间释放

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

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

四、二进制安全

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

举个例子，如果有一种使用空字符来分割多个单词的特殊数据格式，如下图所示，那 么这种格式就不能使用C字符串来保存，因为C字符串所用的函数只会识别出其中的"Redis"， 而忽略之后的"Cluster"。

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

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

例如，使用SDS来保存之前提到的特殊数据格式就没有任何问题，因为SDS使用len属性 的值而不是空字符来判断字符串是否结束，如下图所示。

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

五、兼容部分C字符串函数

虽然SDS的API都是二进制安全的，但它们一样遵循C字符串以空字符结尾的惯例：这些 API总会将SDS保存的数据的末尾设置为空字符，并且总会在为buf数组分配空间时多分配一 个字节来容纳这个空字符，这是为了让那些保存文本数据的SDS可以重用一部分<string.h>库 定义的函数。

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

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

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

与此类似，我们还可以将一个保存文本数据的SDS作为strcat函数的第二个参数，将SDS 保存的字符串追加到一个C字符串的后面：

strcat(c_string, sds->buf);

这样Redis就不用专门编写一个将SDS字符串追加到C字符串之后的函数了。

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

六、总结

C字符串和SDS之间的区别

七、SDS的主要操作API