mirror of
https://github.com/CnTransGroup/EffectiveModernCppChinese.git
synced 2025-01-08 19:30:32 +08:00
94 lines
8.2 KiB
Markdown
94 lines
8.2 KiB
Markdown
## 条款十三：优先考虑`const_iterator`而非`iterator`
|
||
|
||
**Item 13: Prefer `const_iterators` to `iterators`**
|
||
|
||
STL `const_iterator`等价于指向常量的指针（pointer-to-`const`）。它们都指向不能被修改的值。标准实践是能加上`const`就加上，这也指示我们需要一个迭代器时只要没必要修改迭代器指向的值，就应当使用`const_iterator`。
|
||
|
||
上面的说法对C++11和C++98都是正确的，但是在C++98中，标准库对`const_iterator`的支持不是很完整。首先不容易创建它们，其次就算你有了它，它的使用也是受限的。假如你想在`std::vector<int>`中查找第一次出现1983（C++代替C with classes的那一年）的位置，然后插入1998（第一个ISO C++标准被接纳的那一年）。如果*vector*中没有1983，那么就在*vector*尾部插入。在C++98中使用`iterator`可以很容易做到：
|
||
|
||
```cpp
|
||
std::vector<int> values;
|
||
…
|
||
std::vector<int>::iterator it =
|
||
std::find(values.begin(), values.end(), 1983);
|
||
values.insert(it, 1998);
|
||
```
|
||
|
||
但是这里`iterator`真的不是一个好的选择，因为这段代码不修改`iterator`指向的内容。用`const_iterator`重写这段代码是很平常的，但是在C++98中就不是了。下面是一种概念上可行但是不正确的方法：
|
||
|
||
```cpp
|
||
typedef std::vector<int>::iterator IterT; //typedef
|
||
typedef std::vector<int>::const_iterator ConstIterT;
|
||
|
||
std::vector<int> values;
|
||
…
|
||
ConstIterT ci =
|
||
std::find(static_cast<ConstIterT>(values.begin()), //cast
|
||
static_cast<ConstIterT>(values.end()), //cast
|
||
1983);
|
||
|
||
values.insert(static_cast<IterT>(ci), 1998); //可能无法通过编译，
|
||
//原因见下
|
||
```
|
||
|
||
`typedef`不是强制的，但是可以让代码中的*cast*更好写。（你可能想知道为什么我使用`typedef`而不是[Item9](https://github.com/kelthuzadx/EffectiveModernCppChinese/blob/master/3.MovingToModernCpp/item9.md)提到的别名声明，因为这段代码在演示C++98做法，别名声明是C++11加入的特性）
|
||
|
||
之所以`std::find`的调用会出现类型转换是因为在C++98中`values`是non-`const`容器，没办法简简单单的从non-`const`容器中获取`const_iterator`。严格来说类型转换不是必须的，因为用其他方法获取`const_iterator`也是可以的（比如你可以把`values`绑定到reference-to-`const`变量上，然后再用这个变量代替`values`），但不管怎么说，从non-`const`容器中获取`const_iterator`的做法都有点别扭。
|
||
|
||
当你费劲地获得了`const_iterator`，事情可能会变得更糟，因为C++98中，插入操作（以及删除操作）的位置只能由`iterator`指定，`const_iterator`是不被接受的。这也是我在上面的代码中，将`const_iterator`（我那么小心地从`std::find`搞出来的东西）转换为`iterator`的原因，因为向`insert`传入`const_iterator`不能通过编译。
|
||
|
||
老实说，上面的代码也可能无法编译，因为没有一个可移植的从`const_iterator`到`iterator`的方法，即使使用`static_cast`也不行。甚至传说中的牛刀`reinterpret_cast`也杀不了这条鸡。（它不是C++98的限制，也不是C++11的限制，只是`const_iterator`就是不能转换为`iterator`，不管看起来对它们施以转换是有多么合理。）不过有办法生成一个`iterator`，使其指向和`const_iterator`指向相同，但是看起来不明显，也没有广泛应用，在这本书也不值得讨论。除此之外，我希望目前我陈述的观点是清晰的：`const_iterator`在C++98中会有很多问题，不如它的兄弟（译注：指`iterator`）有用。最终，开发者们不再相信能加`const`就加它的教条，而是只在实用的地方加它，C++98的`const_iterator`不是那么实用。
|
||
|
||
所有的这些都在C++11中改变了，现在`const_iterator`既容易获取又容易使用。容器的成员函数`cbegin`和`cend`产出`const_iterator`，甚至对于non-`const`容器也可用，那些之前使用*iterator*指示位置（如`insert`和`erase`）的STL成员函数也可以使用`const_iterator`了。使用C++11 `const_iterator`重写C++98使用`iterator`的代码也稀松平常：
|
||
```cpp
|
||
std::vector<int> values; //和之前一样
|
||
…
|
||
auto it = //使用cbegin
|
||
std::find(values.cbegin(), values.cend(), 1983);//和cend
|
||
values.insert(it, 1998);
|
||
```
|
||
现在使用`const_iterator`的代码就很实用了！
|
||
|
||
唯一一个C++11对于`const_iterator`支持不足（译注：C++14支持但是C++11的时候还没）的情况是：当你想写最大程度通用的库，并且这些库代码为一些容器和类似容器的数据结构提供`begin`、`end`（以及`cbegin`，`cend`，`rbegin`，`rend`等）作为**非成员函数**而不是成员函数时。其中一种情况就是原生数组，还有一种情况是一些只由自由函数组成接口的第三方库。（译注：自由函数*free function*，指的是非成员函数，即一个函数，只要不是成员函数就可被称作*free function*）最大程度通用的库会考虑使用非成员函数而不是假设成员函数版本存在。
|
||
|
||
举个例子，我们可以泛化下面的`findAndInsert`：
|
||
|
||
```cpp
|
||
template<typename C, typename V>
|
||
void findAndInsert(C& container, //在容器中查找第一次
|
||
const V& targetVal, //出现targetVal的位置，
|
||
const V& insertVal) //然后在那插入insertVal
|
||
{
|
||
using std::cbegin;
|
||
using std::cend;
|
||
|
||
auto it = std::find(cbegin(container), //非成员函数cbegin
|
||
cend(container), //非成员函数cend
|
||
targetVal);
|
||
container.insert(it, insertVal);
|
||
}
|
||
```
|
||
|
||
它可以在C++14工作良好，但是很遗憾，C++11不在良好之列。由于标准化的疏漏，C++11只添加了非成员函数`begin`和`end`，但是没有添加`cbegin`，`cend`，`rbegin`，`rend`，`crbegin`，`crend`。C++14修订了这个疏漏。
|
||
|
||
如果你使用C++11，并且想写一个最大程度通用的代码，而你使用的STL没有提供缺失的非成员函数`cbegin`和它的朋友们，你可以简单的写下你自己的实现。比如，下面就是非成员函数`cbegin`的实现：
|
||
|
||
```cpp
|
||
template <class C>
|
||
auto cbegin(const C& container)->decltype(std::begin(container))
|
||
{
|
||
return std::begin(container); //解释见下
|
||
}
|
||
```
|
||
|
||
你可能很惊讶非成员函数`cbegin`没有调用成员函数`cbegin`吧？我也是。但是请跟逻辑走。这个`cbegin`模板接受任何代表类似容器的数据结构的实参类型`C`，并且通过reference-to-`const`形参`container`访问这个实参。如果`C`是一个普通的容器类型（如`std::vector<int>`），`container`将会引用一个`const`版本的容器（如`const std::vector<int>&`）。对`const`容器调用非成员函数`begin`（由C++11提供）将产出`const_iterator`，这个迭代器也是模板要返回的。用这种方法实现的好处是就算容器只提供`begin`成员函数（对于容器来说，C++11的非成员函数`begin`调用这些成员函数）不提供`cbegin`成员函数也没问题。那么现在你可以将这个非成员函数`cbegin`施于只直接支持`begin`的容器。
|
||
|
||
如果`C`是原生数组，这个模板也能工作。这时，`container`成为一个`const`数组的引用。C++11为数组提供特化版本的非成员函数`begin`，它返回指向数组第一个元素的指针。一个`const`数组的元素也是`const`，所以对于`const`数组，非成员函数`begin`返回指向`const`的指针（pointer-to-`const`）。在数组的上下文中，所谓指向`const`的指针（pointer-to-`const`），也就是`const_iterator`了。
|
||
|
||
回到最开始，本条款的中心是鼓励你只要能就使用`const_iterator`。最原始的动机——只要它有意义就加上`const`——是C++98就有的思想。但是在C++98，它（译注：`const_iterator`）只是一般有用，到了C++11，它就是极其有用了，C++14在其基础上做了些修补工作。
|
||
|
||
**请记住：**
|
||
|
||
+ 优先考虑`const_iterator`而非`iterator`
|
||
+ 在最大程度通用的代码中，优先考虑非成员函数版本的`begin`，`end`，`rbegin`等，而非同名成员函数
|