C++: 如何高效地往unordered_map中插入key-value

C++: unordered_map 花式插入key-value的5种方式

前言

无意中发现std::unordered_map、std::map等插入key-value对在C++17后竟有了 insert() 、operator[] 、 emplace() 、 try_emplace() 和 insert_or_assign() 等超过5种方法，我们可以根据实际场景和对效率的要求，去选择不同的方法。在此不得不夸一夸C++的灵(fù)活(zá)性，不管怎么说，一点无用的知识又增加了。此外发现，Effective STL这本书中对insert()方法的介绍有些过时了。

下文中，使用一个测试类作为关联容器中的 mapped_type 来探究通过不同方法对map进行值插入的开销。

测试类定义

测试类 MyClass 定义如下， id 用于标识不同实例，定义了构造函数、拷贝构造函数、赋值运算符函数，构造函数设置 explicit 不允许隐式构造, 未定义移动构造函数和移动赋值函数。

class MyClass {
private:
    int id = 0;
public:
    MyClass() {
        std::cout << "Default Constructor called " << id << "\n";
    }
    explicit MyClass(int i):id(i) {
        std::cout << "Constructor called " << id << "\n";
    }

    MyClass(const MyClass& my_class) {
        id = my_class.id;
        std::cout<< "Copy Constructor called "<< id << "\n";
    }

    MyClass& operator=(const MyClass& my_class) {
        id = my_class.id;
        std::cout<< "Operator= called "<< id <<"\n";
        return *this;
    }

    ~MyClass() {
        std::cout<<"Destructor called "<<id<<"\n";
    }
};

初始化一个 unordered_map 和一些自定义类 MyClass的对象:

std::unordered_map<std::string, MyClass> myMap;
MyClass m1(1), m2(2),m3(3),m4(4),m5(5),m6(6),m7(7),m8(8),m9(9);

测试对比

将插入元素分为 add(key不存在)和 update (key已存在)两种情况进行讨论，基于 myMap 依次运行以下代码，对比相关函数调用开销。

1. add ，key不存在

依次按以下代码顺序执行插入 key-value对：

• insert() :

myMap.insert({"one", m1});

创建临时的 key-value node 以及将其拷贝进 myMap 容器，二者都会调用MyClass的拷贝构造函数（本应移动MyClass，但未定义移动操作只能拷贝）。调用该方法后输出如下：

Copy Constructor called 1 // Make tmp std::pair
Copy Constructor called 1 // Copy pair to container
Destructor called 1       // tmp MyClass de

• operator[] :

 myMap["two"] = m2;

该方法要求 mapped_type是可默认构造的， 当key不存在时，在myMap 中先分配了一个 {key, MyClass()} node的空间，该运算符返回该 MyClass() 的引用，再用 MyClass(2) 进行赋值，此过程调用默认构造函数和赋值运算符函数。调用该方法后输出如下：

Default Constructor called 0  // Call Default Constructor
Operator= called 2            // Call Operator=()

• emplace() :

myMap.emplace("three", m3);

直接传入key-value，在容器中原地构造 std::pair ，省去了相关函数调用开销。

Copy Constructor called 3      // Copy MyClass(3) to myMap

总结：当对效率要求较高，key不存在时，应优先使用 emplace() 插入key-value，避免临时变量带来的开销。

2.update，key存在

• operator[] :

当Key存在时，value会被替换为新值，

 myMap["one"] = m4;

以上代码仅调用赋值运算符函数。

Operator= called 4

• insert() 和 emplace()

这两种方法，当Key存在时，value不会被替换为新值。但临时值会被创建出来。

myMap.insert(std::make_pair("one", m4));

就 insert() 而言，创建临时key-value node以及拷贝进容器的操作都会执行。

Copy Constructor called 5
Copy Constructor called 5
Destructor called 5
Destructor called 5

就 emplace() 而言，继续做以下插入操作，

myMap.emplace("three", m6);

“three”对应的value仍为 m3 ，但pair的临时变量仍然会被创建，之后便销毁：

Copy Constructor called 6
Destructor called 6

• C++17 try_emplace() :

如果key已经存在，不会创建key-value node。否则，将会将其插入到map中，

myMap.try_emplace("three", m7);

以上代码输出结果如下，未创建pair。

Constructor called 7
Destructor called 7

• C++17 insert_or_assign()

当key存在时，将对应value值进行更新插入key-value对，

myMap.insert_or_assign("three", m8);

运行以上代码后，”three”对应value为 m8 , 输出如下, 仅调用了赋值运算符函数，这与 operator[]是一样的。

Operator= called 8

当key不存在时，插入key-value对，

myMap.insert_or_assign("four", m9);

运行后输出如下，仅调用拷贝构造函数，可见，该方法也支持原地构造。与 operator[] 不同的是，该方法不需要 mapped_type 支持默认构造函数。

Copy Constructor called 9

• operator[] vs insert_or_assign() :

	要求Value可默认构造	返回值
operator[]	true	value
insert_or_assign()	false	pair<iterator, bool>

insert_or_assign() 的返回值为 std::pair<iterator, bool> ，其中 iterator 指向插入或更新的元素， bool 变量的含义为：如果发生插入，值为 true ；如果发生替换，值为 false 。

总之，当key存在时，如果需要替换value值，应使用operator[] ；需要更丰富的返回信息时，可考虑insert_or_assign() 。如果不需要替换value值，为避免临时node创建，可使用 try_emplace() 。

测试程序地址： https://godbolt.org/z/M3KTPhvoY

总结

以上提到的5种方法之间的差异对比可参考下图：

各方法对比如下：

	C++版本	是否覆盖value	构造node前事先查找
insert()	C++03	false	false
operator[]	C++03	true	\
emplace()	C++11	false	false
try_emplace()	C++17	false	true
insert_or_assign()	C++17	true	\

最后总结，当对效率要求较高：

• 当key不存在时，应优先使用 emplace() 插入key-value，避免创建临时变量带来的开销。

• 当key存在时，如果需要替换value值，应使用operator[] ；如果需要更丰富的返回信息时，可考虑insert_or_assign() 。

• 当key存在时，现代C++的 insert()方法已经不能更新值了，Effective STL书中的介绍已经过时。

• 如果不需要替换value值，为避免临时node创建，可使用 try_emplace() 。

References

1. https://en.cppreference.com/w/cpp/container/unordered_map
2. https://www.fluentcpp.com/2018/12/11/overview-of-std-map-insertion-emplacement-methods-in-cpp17/
3. https://en.cppreference.com/w/cpp/container/map/insert_or_assign

---

你好，我是七昂，致力于分享C++、计算机底层、机器学习等系列知识。希望我们能一起探索程序员修炼之道。如果我的创作内容对您有帮助，请点赞关注。如果有问题，欢迎随时与我交流。感谢你的阅读。

公众号： 七昂的技术之旅