【C++】vector的迭代器失效问题（什么是迭代器失效？那些操作会导致迭代器失效？如何避免迭代器失效？）

一、前言

二、什么是迭代器失效？

三、哪些操作会导致迭代器失效？

四、如何避免迭代器失效？

🥝 insert迭代器失效

✨迭代器失效 ------ 扩容导致的野指针

✨迭代器失效 ------ 迭代器指向的位置意义发生改变

🍇 erase迭代器失效

五、迭代器失效总结

六、共勉

一、前言

最近我们学习了 vector类 的用法和模拟实现，同时呢也提到了C++中的迭代器失效问题，在之前的文章只是简单的提了一下，由于迭代器失效问题是非常重要的，所以特地整理出来方便后期的复习和学习。如果有老铁还不太清楚 vector类 可以看看这几篇文章：
1️⃣： vector类的使用详解
2️⃣： vector类的模拟实现
这篇文章的要点只有三点：1.什么是迭代器失效？2.vector那些操作会导致迭代器失效？3.如何避免迭代器失效？

二、什么是迭代器失效？

⚡迭代器的作用：主要作用就是让算法能够不用关心底层数据结构，其底层实际就是一个指针，或者是对指针进行了封装
⚡vector的迭代器：就是原生态指针T*
template<class T>
typedef T* iterator;                     // 迭代器某种意义上就是指针
typedef const T* const_iterator;
⚡因此迭代器失效：实际就是迭代器底层对应指针所指向的空间被销毁了，而使用一块已经被释放的空间，造成的后果是程序崩溃（即如果继续使用已经失效的迭代器，程序可能会崩溃）。具体的可以用一下三步来说明：

[1]迭代器的本质就是指针，迭代器失效就是指针失效。
[2]指针失效：指针指向的空间是非法的。
[3]指针指向非法空间：指向了被释放的空间 或者 越界访问。

三、哪些操作会导致迭代器失效？

1️⃣：所有可能会引起扩容的操作都可能会导致迭代器失效。如：resize、reserve、insert、assign、push_back等 -------------- 野指针引起的迭代器失效

2️⃣：指定位置的插入和删除都会都可能会导致迭代器失效。如: insert 、erase ----------------- 迭代器指向的位置意义发生改变

四、如何避免迭代器失效？

接下来，我将会从 insert 和 erase 这两个接口函数来讲解如何避免迭代器失效问题。

🥝 insert迭代器失效

insert迭代器失效分为两类：

扩容导致野指针
迭代器指向的位置意义发生改变

下面我们先给出insert的初始版本，然后再逐渐的完善：

注意：这里呢我们使用的是 vector模拟实现中的代码：vector类的模拟实现

void insert(iterator pos, const T& x)
{
	//检测参数合法性
	assert(pos >= _start && pos <= _finish);
	//检测是否需要扩容
	if (_finish == _end_of_stoage)
	{
		size_t newcapcacity = capacity() == 0 ? 4 : capacity() * 2;
		reserve(newcapcacity);
	}
	//挪动数据
	iterator end = _finish - 1;
	while (end >= pos)
	{
		*(end + 1) = *(end);
		end--;
	}
	//把值插进去
	*pos = x;
	_finish++;
}

✨迭代器失效 ------ 扩容导致的野指针

首先我们给出以下两组测试用例：

这里为什么 push_back 尾插4个后调用insert会出现随机值？而push_back尾插5个调用insert就没有这个问题？
此问题就是迭代器失效，原因就在于pos没有更新，导致非法访问野指针。

上述当尾插4个数字后，再头插一个数字发生扩容。根据reserve扩容机制，_start和_finish都会更新，唯独插入位置pos没有更新，此时pos依旧指向旧空间，reserve后会释放旧空间，此时的pos就是野指针，这也就导致后续执行*pos=x就是非法访问野指针。

解决方法

我们可以设定变量n来计算扩容前pos指针位置和_start指针位置的相对距离，最后在扩容后，让_start再加上先前算好的相对距离n就是更新后的pos指针的位置了。

void insert(iterator pos, const T& x)
{
	//检测参数合法性
	assert(pos >= _start && pos <= _finish);
	/*扩容以后pos就失效了，需要更新一下*/
	if (_finish == _end_of_stoage)
	{
		size_t n = pos - _start;//计算pos和start的相对距离
		size_t newcapcacity = capacity() == 0 ? 4 : capacity() * 2;
		reserve(newcapcacity);
		pos = _start + n;//防止迭代器失效，要让pos始终指向与_start间距n的位置
	}
	//挪动数据
	iterator end = _finish - 1;
	while (end >= pos)
	{
		*(end + 1) = *(end);
		end--;
	}
	//把值插进去
	*pos = x;
	_finish++;
}

✨迭代器失效 ------ 迭代器指向的位置意义发生改变

什么是迭代器指向的位置意义发生改变呢？举个例子来说明一下

比如现在我要在所有的偶数前面插入2，下面我们看测试结果：

void test2()
{
	xas_vector::vector<int> v1;
	v1.Push_back(1);
	v1.Push_back(2);
	v1.Push_back(3);
	v1.Push_back(4);
	v1.Push_back(5);
	v1.Push_back(6);
	for (auto ch : v1)
	{
		cout << ch << " ";
	}
	cout << endl;

	xas_vector::vector<int>::iterator it = v1.begin();
	while (it != v1.end())
	{
		if (*it % 2 == 0)
		{
			v1.insert(it, 20);
			it++;
		}
		it++;
	}
	for (auto ch : v1)
	{
		cout << ch << " ";
	}
	cout << endl;
}

这里发生了断言错误，这段代码发生了两个错误：

it是指向原空间的，当insert插入要扩容时，原空间的数据拷贝到新空间上，但这也就意味着旧空间全是野指针，而it是一直指向旧空间的，随后遍历it时就非法访问野指针，也就失效了。形参的改变不会影响实参，即使你内部pos指向改变了，但是并不会影响我外部的it。
为了解决上述问题，有人觉得提前reserve开辟足够大的空间即可避免发生野指针的现象，但是又会出现一个新的问题，我们看下图：

此时insert以后虽然没有扩容，it也并没有成为野指针，但是it指向位置意义变了，导致我们这个程序重复插入20。

解决方法：

给insert函数加上返回值即可解决，返回指向新插入元素的位置。

iterator insert(iterator pos, const T& x)
{
	//检测参数合法性
	assert(pos >= _start && pos <= _finish);
	//检测是否需要扩容
	/*扩容以后pos就失效了，需要更新一下*/
	if (_finish == _end_of_stoage)
	{
		size_t n = pos - _start;//计算pos和start的相对距离
		size_t newcapcacity = capacity() == 0 ? 4 : capacity() * 2;
		reserve(newcapcacity);
		pos = _start + n;//防止迭代器失效，要让pos始终指向与_start间距n的位置
	}
	//挪动数据
	iterator end = _finish - 1;
	while (end >= pos)
	{
		*(end + 1) = *(end);
		end--;
	}
	//把值插进去
	*pos = x;
	_finish++;
	return pos;
}

我们实际调用的时候也需要改动，让it自己接收insert后的返回值：

🍇 erase迭代器失效

我们先给出 erase的初始版本，然后再逐渐的完善：

void erase(iterator pos)
{
	//检查合法性
	assert(pos >= _start && pos < _finish);
	//从pos + 1的位置开始往前覆盖，即可完成删除pos位置的值
	iterator it = pos + 1;
	while (it < _finish)
	{
		*(it - 1) = *it;		
        it++;
	}
	_finish--;
}

erase的失效都是迭代器指向的位置意义发生改变，或者不在有效访问数据的有效范围内
erase一般不会使用缩容的方案，那么也就导致erase的失效一般不存在野指针的失效。

我们现在对下面代码进行测试：

void test_vector()
{
	vector<int> v;
	v.push_back(1);
	v.push_back(2);
	v.push_back(3);
	v.push_back(4);
	cout << v.size() << ":" << v.capacity() << endl;
	auto it = find(v.begin(), v.end(), 2);
	if (it != v.end())
	{
		v.erase(it);
	}
	cout << *it << endl;
	*pos = 10;
	cout << *it << endl << endl;
	cout << v.size() << ":" << v.capacity() << endl;
	for (auto e : v)
	{
		cout << e << " ";
	}
}

我们尾插4个数字，比较size和capacity的大小，此时是相等的，接下来删除值为2的数，此时*it就是删除数字的下一个数据也就是3，此时有效数据也少了一个，后续修改*it也就不存在问题。
如果我们这里要删除的值为4，那么结果会是怎么样的呢？

我们这里一共有4个数据，按理说把最后一个数字删除以后，有效数字-1，不存在还会访问最后一个值的现象，但是此结果却是删除4以后又访问了4，而且还修改4为10，这就是典型的erase迭代器失效。

我们再用另外一组例子来测试一下：

void test_vector()
{
	//删除所有的偶数
	vector<int> v;
	v.push_back(1);
	v.push_back(2);
    v.push_back(2);
	v.push_back(3);
	v.push_back(4);
	v.push_back(5);
	auto it = v.begin();
	while (it != v.end())
	{
		if (*it % 2 == 0)
		{
			v.erase(it);
		}
		it++;
	}
	for (auto e : v)
	{
		cout << e << " ";
	}
 
}

画图演示错误过程：

解决方案如下：

给 erase函数加上返回值即可解决，返回指向新插入元素的位置。

iterator erase(iterator pos)
{
	//检查合法性
	assert(pos >= _start && pos < _finish);
	//从pos + 1的位置开始往前覆盖，即可完成删除pos位置的值
	iterator it = pos + 1;
	while (it < _finish)
	{
		*(it - 1) = *it;		
        it++;
	}
	_finish--;
	return pos;
}

void test_vector()
{
	//删除所有的偶数
	vector<int> v;
	v.push_back(1);
	v.push_back(2);
    v.push_back(2);
	v.push_back(3);
	v.push_back(4);
	v.push_back(5);
	auto it = v.begin();
	while (it != v.end())
	{
		if (*it % 2 == 0)
		{
			it = v.erase(it);
		}
		else
        {
             it++;
	    }
	for (auto e : v)
	{
		cout << e << " ";
	}
 
}