Attention:This blog is a translation of Modern C++ Features - std:optional,which is written by Arne Mertz.
一、前言
有时我们会用一个值来表示一种“没有什么意义”的状态,这就是C++17的std::optional
的用处。
在编写程序时,我们常常遇到一种情况,那就是我们不总是有一个固定值来表示一个事物。例如,找出文本中的第一个偶数(如果存在的话)。或者一个类有一个可选的成员函数,即一个不是总需要被设置的成员函数。
在以前的代码中,这些情况一般使用魔术值(magic value)或者空指针(null pointers)来表示。一个魔术值可以是一个空的字符串、0、-1或者一个最大的非负值(例如std::string::npos
)。
这两个方法都有他们的缺点。魔术值人为地限制了可获得的值得范围,它也仅仅按照惯例与那些合法、正常的值分开来。对于一些类型,没有明显的魔术值,或者无法用常规手段创建魔术值。用空指针表示没有意义的值意味着其他合法的值必须被分配一个地址空间,这是一个代价高昂的操作并且难以实现。
另一种方法是提供两次查询:首先询问是否有一个有意义的值,如果答案是正的(positive),就查找这个值。实现这个会导致查找代码的不必要的重复,并且他的使用也不够安全。如果要查找的值不存在,第二次查询的实现就必须要做点什么,例如返回一个容易被误解的值,这个值会引起未定义的行为,或者直接抛出一个异常,后者通常是唯一明智的行为。
二、std::optional
C++17引入了std::optional<T>
,类似于std::variant
,std:optional
是一个和类型(译者注:和类型即sum type,如果你熟悉C++中的union
,那么就不难理解这里的sum。如果一个union
包含两个类型,一个bool
类型和一个uint8_t
类型,那么这个union
一共会有2+2^8 = 258种值,所以我们称之为和类型,因为它们的类型数量是用各个类型的类型数量累加求得的。如果换成struct
,那么这里的类型数量就是2*2^8=512种),它是类型T
的所有值和一个单独的“什么都没有”的状态的和。
后者有专门的名字:它的类型是std::nullopt_t
,并且它有一个值std::nullopt
。那听上去很熟悉,它和nullptr
的概念相同,不同的是后者是C++内置的关键词。
使用std::optional
std::optional
具有我们所期望的所有特性:我们可以用任何可以被转化为T
的类型来构造和赋值,我们也可用std::nullopt
和默认构造函数来构造和赋值。我们还能从其他类型的std::optional
初始化一个另外类型的std::optional
,只要这两个类型可以相互转化。结果会包含被转换的值或者会为空,跟我们的预期相符。
我们可以像上面描述的那样查询std::optional
,has_value()
告诉我们是否有一个值,value()
则返回这个值。如果没有值并且我们还调用了value()
,会抛出一个类型为std::bad_optional_access
的异常。或者我们可以使用value_or(U&& default)
来得到值,如果std::optional
为空,则得到default
。
int main()
{
std::string text = /*...*/;
std::optional<unsigned> opt = firstEvenNumberIn(text);
if (opt.has_value())
{
std::cout << "The first even number is "
<< opt.value()
<< ".\n";
}
}
除了这些显式的方法,std::optional
还有一个类似于智能指针的接口,它可以显式转化为bool
来表示std::optional
是否有一个值。指针的解引用操作符*
和->
都实现了,但是没有std::bad_optional_access
,用这种方式访问一个空的std::optional
是一个未定义的行为。最后,reset()
清除std::optional
包含的对象,让它为空。
上面的代码因此可以写成这样:
int main()
{
std::string text = /*...*/;
std::optional<unsigned> opt = firstEvenNumberIn(text);
if (opt)
{
std::cout << "The first even number is "
<< *opt
<< ".\n";
}
}
为了解决问题,类似于std::make_unique
和std::make_shared
,std::make_optional
可以在一个新的std::optional
内构造T
,emplace(Args...)
方法也可以对一个已经存在的std::optioanl
做同样的事情。
auto optVec = std::make_optional<std::vector<int>>(3, 22); //{22, 22, 22}
std::set<int> ints{4, 7, 1, 41};
optVec.emplace(std::begin(ints), std::end(ints));
std::copy(optVec->begin(), optVec->end(), std::ostream_iterator<int>(std::cout, ", "));
三、结论
std::optional
是一个很方便的库特性,虽小却很有力量。在你下次想要弄清楚应该用什么魔术值来表示“nothing”的时候,记得使用std::optional
。