LevelDB(v1.3) 源码阅读之 Slice

2023-10-08 11:59:46

LevelDB(v1.3) 源码阅读系列使用 LevelDB v1.3 版本的代码，可以通过如下方式下载并切换到 v1.3 版本的代码：

$ git clone https://github.com/google/leveldb.git
$ cd leveldb
$ git checkout -b v1.3 v1.3

本文涉及的代码文件为：

include/slice.h

1. Slice 简介

LevelDB Slice 对经常使用的字符串进行了简单的封装，它自己不管理内存，仅仅提供对已有字符串的简单操作：这就是不使用 std::string 的原因：避免不必要的内存拷贝。因此，Slice 要求用户：

The user of a Slice must ensure that the slice is not used after the corresponding external storage has been deallocated.

我们需要时刻牢记：Slice 不负责管理内存，它只操作已有的字符串，这些字符串的内存由用户自己管理，还有一点，Slice 不能修改所操作的字符串

本文是 LevelDB(v1.3) 源码阅读系列第一篇文章，并且 Slice 也比较简单，所以这篇文章我会写的尽量详细，以后的文章我会更加注重设计，代码我不会像这篇文章一样贴的那么多

2. Slice 对外提供的接口

2.1. 构造函数

Slice() : data_(""), size_(0) { }
Slice(const char* d, size_t n) : data_(d), size_(n) { }
Slice(const std::string& s) : data_(s.data()), size_(s.size()) { }
Slice(const char* s) : data_(s), size_(strlen(s)) { }

第一个是默认构造函数，它会初始化一个空的 slice 出来，这个 slice 的长度为 0
第二个构造函数要求提供一个 char* 和 size_t 的参数分别来初始化 slice 的两个成员变量
第三个构造函数的参数是一个 string 类型的字符串
第四个构造函数的参数是一个 C 语言类型的字符串，该字符串以 '\0' 结尾，并且用 strlen(s) 来初始化 slice 的长度

通过构造函数我们很清晰的看到：Slice 不对它所操作的字符串进行拷贝复制，仅安排一个指针指向该字符串，并用一个整型变量记录该字符串的长度。事实上，Slice 仅仅只有他们两个成员变量：

const char* data_;
size_t size_;

注意到 data_ 的底层 const 修饰： Slice 不能修改所操作的字符串。

还需要注意的是，Slice 将拷贝构造函数和拷贝赋值函数声明为私有的，也就直接造成了 Slice 对象之间不可以直接的拷贝赋值。实际上也没有这样的必要和使用场景，Slice 仅仅是一个对字符串操作的函数集合，用户根本没必要拷贝两个工具集合。

2.2. 运算符重载

Slice 重载了三个运算符：[]、== 和 !=，[] 是 Slice 的成员函数，== 和 != 是对标准函数的重载，他们的代码如下：

char operator[](size_t n) const {
    assert(n < size());
    return data_[n];
}

inline bool operator==(const Slice& x, const Slice& y) {
    return ((x.size() == y.size()) && (memcmp(x.data(), y.data(), x.size()) == 0));
}

inline bool operator!=(const Slice& x, const Slice& y) {
    return !(x == y);
}

因为 Slice 不能修改其操作的字符串，[] 的重载函数返回的是该位置字符的一个拷贝而不是引用，不能通过 slice[i] = 'a' 的方式来改变 slice 第 i 个字节的内容

对于 == 和 !=：两个 Slice 相等指的是是他们的长度相等，并且所有的字节也相等（一个代码 tip：if 短路，先判断两个字符串的长度，再判断内容）

2.3. 常规函数

const char* data() const     { return data_; }
size_t size() const          { return size_; }
bool empty() const           { return size_ == 0; }
void clear()                 { data_ = ""; size_ = 0; }
std::string ToString() const { return std::string(data_, size_); }

void remove_prefix(size_t n) {
    assert(n <= size());
    data_ += n;
    size_ -= n;
}

inline int Slice::compare(const Slice& b) const {
    const size_t min_len = (size_ < b.size_) ? size_ : b.size_;
    int r = memcmp(data_, b.data_, min_len);
    if (r == 0) {
        if (size_ < b.size_) r = -1;
        else if (size_ > b.size_) r = +1;
    }
    return r;
}

bool starts_with(const Slice& x) const {
    return ((size_ >= x.size_) && (memcmp(data_, x.data_, x.size_) == 0));
}

这几个函数都比较简单：

data() 和 size() 类似于 string 的 data() 和 size()，直接返回成员变量
empty() 用来判断 Slice 中是否有字符串，这是通过判断 size 是否为 0 来实现的
clear() 直接让当前这个 Slice 指向一个空字符串，并设置 size 为 0，再次印证：Slice 不负责内存的管理
ToString() 就直接调用 string 的构造函数生成一个 string 对象，并把这个对象拷贝给调用者
starts_with()，两个 Slice a 和 b，a.start_with(b) 判断 b 是否是 a 的一个前缀
compare()，比较两个 Slice a 和 b 的大小，a.compare(b) 判断的是 a 是否小于 b，采用字典序比较大小

3. 总结

关于 Slice 记住两点就行了：

Slice 不管理内存，它只操作用户提供的字符串，用户需要自己管理该字符串的内存
Slice 不改变所操作字符串的内容

码农公寓