手写 std::map

手写 std::map

把键值对接入红黑树，实现唯一键映射、operator[]、at 和安全的迭代引用。

本系列代码使用 C++20 和 oc::handmade 命名空间，目标是解释实现机制、复杂度和工程边界，不是替代标准库。普通容器与缓存核心不内置互斥锁；这不代表 lock-free。

---

一、学习目标

• 保持键只读而值可写
• 实现 insert_or_assign/try_emplace
• 理解 operator[] 的默认构造副作用

---

二、前置条件

完成红黑树与 set 篇，熟悉 pair 和 piecewise construction。

Linux/macOS：

cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug
cmake --build build -j
ctest --test-dir build --output-on-failure

Windows PowerShell：

cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug
cmake --build build --config Debug
ctest --test-dir build -C Debug --output-on-failure

---

三、问题与设计选择

树节点分别保存 const 语义的 Key 与可变 T；比较只观察 Key。迭代器返回代理引用，禁止改变键但允许改变 mapped value。

这里刻意保留一条边界：教学实现覆盖构造、复制移动、核心修改、查找和迭代契约，但不复刻标准库全部重载、ABI、constexpr、异构查找或节点句柄。

---

四、内存布局与核心不变量

键按 Compare 唯一有序；修改 mapped value 不影响树结构；任何可观察条目始终同时拥有有效 Key 与 T。

每个修改操作都按“准备资源 → 构造新状态 → 提交连接或指针 → 清理旧状态”的顺序设计。提交点之前发生异常，应保持原对象可继续使用；无法提供强保证时，会在接口说明中明确基本保证。

---

五、核心实现

T& operator[](Key key) {
    if (auto* found = tree_.find(key)) return found->mapped;
    auto [fresh, inserted] =
        tree_.insert(std::move(key), T{});
    (void)inserted;
    return fresh->mapped;
}

上面先聚焦最容易写错的核心步骤；若本篇对应一个独立组件，下一节给出统一工程中的完整教学实现。代码没有放入 std 命名空间，避免未定义行为和名称冲突。

---

六、完整教学实现

下面是统一工程中经过 GCC、Clang、GoogleTest 和 Sanitizer 验证的完整组件。它依赖前序文章已经实现的公共类型以及头文件中的标准库 #include。

namespace oc::handmade {

template<class Key, class T, class Compare = std::less<Key>>
class map {
    rb_tree<Key, T, Compare> tree_;
public:
    std::pair<T*, bool> insert(Key key, T value) {
        auto [entry, inserted] = tree_.insert(std::move(key), std::move(value));
        return {entry.mapped, inserted};
    }
    T& operator[](Key key) {
        if (auto* found = tree_.find(key)) return *found;
        return *tree_.insert(std::move(key), T{}).first.mapped;
    }
    T& at(const Key& key) {
        if (auto* found = tree_.find(key)) return *found;
        throw std::out_of_range("oc::handmade::map::at");
    }
    const T& at(const Key& key) const {
        if (auto* found = tree_.find(key)) return *found;
        throw std::out_of_range("oc::handmade::map::at");
    }
    bool contains(const Key& key) const { return tree_.contains(key); }
    bool erase(const Key& key) { return tree_.erase(key); }
    std::size_t size() const noexcept { return tree_.size(); }
    bool valid() const { return tree_.valid(); }
};

}  // namespace oc::handmade

生产级标准库还要处理完整 allocator 传播、全部重载、ABI、调试迭代器和平台特化；这里保留的是能够独立推导核心数据结构的教学边界。

---

七、使用示例与输出

预期输出或状态：

执行 scores["C++"] += 10 后键被创建且值为 10；at("Rust") 抛出 out_of_range。

示例必须在文章对应的测试目标中实际编译。涉及顺序的输出只依赖接口明确承诺的顺序；无序容器不会把某次桶顺序写成稳定结果。

---

八、复杂度与失效规则

操作	复杂度	说明
find/at	O(log n)	at 缺失时抛出
operator[]	O(log n)	缺失时默认构造
try_emplace	O(log n)	命中时不构造 T
erase	O(log n)	树修复

复杂度中的 O(1) 若标记为“平均”或“摊还”，不能在面试中省略限定词。任何重新分配、节点删除、rehash 或缓存淘汰都必须单独说明迭代器、引用与指针是否失效。

---

九、异常安全与资源管理

• 获取资源后立即交给 RAII 对象或明确记录已构造数量。
• 用户类型构造、复制、移动、比较器和哈希器都可能抛异常。
• 只有在所有后续步骤不会失败时才修改不可回滚的链接。
• 析构、释放和关闭路径不得抛异常。
• 并发包装通过回调在锁内访问，避免返回保护对象的裸引用。

---

十、常见错误

1. 用 operator[] 做只读查询意外插入

用 operator[] 做只读查询意外插入会破坏本篇建立的契约。调试时先检查核心不变量，再缩小到触发该状态的最短操作序列。

2. 节点只存 pair 后错误移动 const Key

节点只存 pair 后错误移动 const Key会破坏本篇建立的契约。调试时先检查核心不变量，再缩小到触发该状态的最短操作序列。

3. 比较器同时比较 value

比较器同时比较 value会破坏本篇建立的契约。调试时先检查核心不变量，再缩小到触发该状态的最短操作序列。

---

十一、面试追问

1. try_emplace 与 insert_or_assign 区别是什么？
2. map 迭代器为何允许改 second 不允许改 first？
3. 何时 flat_map 更合适？

回答时先说数据结构不变量，再给复杂度，最后说明异常、迭代器或并发边界，通常比背诵结论更有说服力。

---

十二、练习与自测

1. 实现 try_emplace
2. 实现 const/non-const 迭代代理
3. 统计命中时避免的构造次数

自测标准：能够不看代码画出内存或节点关系，解释一次成功操作和一次失败回滚，并写出至少一个会击穿错误实现的测试。

---

十三、官方资料与延伸阅读

• C++20 工作草案 N4861
• C++ Core Guidelines

---

上一篇：手写 std::multiset ｜ 下一篇：手写 std::multimap