类模板 std::optional
管理一个可选 的所含值,即既可以存在也可以不存在的值。
一种常见的 optional
使用情况是作为可能失败的函数的返回值。与如 std::pair<T, bool> 等其他手段相比,optional
可以很好地处理构造开销高昂的对象,并更加可读,因为它明确表达了意图。
optional<T>
的任何实例在任意给定时间点要么含值,要么不含值。
如果一个 optional<T>
含值,那么保证该值作为 optional
对象所用空间的一部分分配,即不会发生动态内存分配。因此,optional
对象模拟的是对象而非指针,尽管定义了 operator*() 和 operator->() 运算符。
当一个 optional<T>
类型的对象被按语境转换到 bool 时,若对象含值 则转换返回 true,若它不含值" 则返回 false。
optional
对象在下列条件下含值:
- 对象被以
T
类型的值或另一含值 的optional
初始化/赋值。
对象在下列条件下不含值:
- 对象被默认初始化。
- 对象被以 std::nullopt_t 类型的值或不含值 的
optional
对象初始化/赋值。 - 调用了成员函数 reset()。
不存在可选的引用、函数、数组或 cv void:如果以这些类型实例化 optional
,那么程序非良构。另外,如果以(可有 cv 限定的)标签类型 std::nullopt_t 或 std::in_place_t 实例化 optional
,那么程序非良构。
成员函数
构造 optional 对象(公开成员函数) | |
销毁容纳的值(如果存在) (公开成员函数) | |
对内容赋值 (公开成员函数) | |
观察器 | |
访问所含值 (公开成员函数) | |
检查对象是否含值 (公开成员函数) | |
返回所含值 (公开成员函数) | |
在所含值可用时返回它,否则返回另一个值 (公开成员函数) | |
修改器 | |
交换内容 (公开成员函数) | |
销毁任何所含值 (公开成员函数) | |
原位构造所含值 (公开成员函数) |
非成员函数
(C++17) | 创建一个 optional 对象(函数模板) |
示例代码:
#include <iostream>
#include <optional>
#include <string>
#include <iomanip>
#include <cstdlib>
#include <vector>
#pragma warning(disable:4996)
// optional 可用作可能失败的工厂的返回类型
std::optional<std::string> create(bool b)
{
if (b)
return "Godzilla";
return {};
}
// 能用 std::nullopt 创建任何(空的)std::optional
auto create2(bool b)
{
return b ? std::optional<std::string>{"Godzilla"} : std::nullopt;
}
std::optional<const char*> maybe_getenv(const char* n)
{
if (const char* x = std::getenv(n))
return x;
else
return {};
}
struct A
{
std::string s;
A(std::string str) : s(std::move(str)) { std::cout << " 已构造\n"; }
~A() { std::cout << " 已析构\n"; }
A(const A& o) : s(o.s) { std::cout << " 被复制构造\n"; }
A(A&& o) : s(std::move(o.s)) { std::cout << " 被移动构造\n"; }
A& operator=(const A& other)
{
s = other.s;
std::cout << " 被复制赋值\n";
return *this;
}
A& operator=(A&& other)
{
s = std::move(other.s);
std::cout << " 被移动赋值\n";
return *this;
}
};
struct B
{
std::string s;
B(std::string str) : s(std::move(str)), id{ n++ } { note("+ 构造"); }
~B() { note("~ 析构"); }
B(const B& o) : s(o.s), id{ n++ } { note("+ 复制构造"); }
B(B&& o) : s(std::move(o.s)), id{ n++ } { note("+ 移动构造"); }
B& operator=(const B& other)
{
s = other.s;
note("= 复制赋值");
return *this;
}
B& operator=(B&& other)
{
s = std::move(other.s);
note("= 移动赋值");
return *this;
}
inline static int n{};
int id{};
void note(std::string s) { std::cout << " " << s << " #" << id << '\n'; }
};
int main()
{
std::cout << "create(false) 返回 "
<< create(false).value_or("empty") << '\n';
// 返回 optional 的工厂函数可用作 while 和 if 的条件
if (auto str = create2(true))
std::cout << "create2(true) 返回 " << *str << '\n';
//operator= example
std::optional<const char*> s1 = "abcefg", s2; // 构造函数
s2 = s1; // 赋值
s1 = "hijklm"; // 衰变赋值(U = char[4], T = const char*)
std::cout << *s2 << ' ' << *s1 << '\n';
//std::optional<T>::operator->, std::optional<T>::operator* example
using namespace std::string_literals;
std::optional<int> opt1 = 1;
std::cout << "opt1: " << *opt1 << '\n';
*opt1 = 2;
std::cout << "opt1: " << *opt1 << '\n';
std::optional<std::string> opt2 = "abc"s;
std::cout << "opt2: " << std::quoted(*opt2) << ", size: " << opt2->size() << '\n';
// 你能通过在到 optional 的右值上调用 operator* “取”其所含值
auto taken = *std::move(opt2);
std::cout << "taken: " << std::quoted(taken) << "\n"
"opt2: " << std::quoted(*opt2) << ", size: " << opt2->size() << '\n';
//std::optional<T>::operator bool, std::optional<T>::has_value example
std::cout << std::boolalpha;
std::optional<int> opt;
std::cout << opt.has_value() << '\n';
opt = 43;
if (opt)
std::cout << "设置值为 " << opt.value() << '\n';
else
std::cout << "未设置值\n";
opt.reset();
if (opt.has_value())
std::cout << "值仍被设为 " << opt.value() << '\n';
else
std::cout << "不再设置值\n";
//std::optional<T>::value example
std::optional<int> opt3 = {};
try
{
[[maybe_unused]] int n = opt3.value();
}
catch (const std::bad_optional_access& e)
{
std::cout << e.what() << '\n';
}
try
{
opt3.value() = 42;
}
catch (const std::bad_optional_access& e)
{
std::cout << e.what() << '\n';
}
opt3 = 43;
std::cout << *opt3 << '\n';
opt3.value() = 44;
std::cout << opt3.value() << '\n';
//std::optional<T>::value_or example
std::cout << maybe_getenv("SHELL").value_or("(none)") << '\n';
std::cout << maybe_getenv("MYPWD").value_or("(none)") << '\n';
//std::optional<T>::swap example
std::optional<std::string> opt4("First example text");
std::optional<std::string> opt5("2nd text");
enum Swap { Before, After };
auto print_opts = [&](Swap e) {
std::cout << (e == Before ? "交换前:\n" : "交换后:\n");
std::cout << "opt1 含有 '" << opt4.value_or("") << "'\n";
std::cout << "opt2 含有 '" << opt5.value_or("") << "'\n";
std::cout << (e == Before ? "---SWAP---\n" : "\n");
};
print_opts(Before);
opt4.swap(opt5);
print_opts(After);
// 在仅一者含值时交换
opt4 = "Lorem ipsum dolor sit amet, consectetur tincidunt.";
opt5.reset();
print_opts(Before);
opt4.swap(opt5);
print_opts(After);
//std::optional<T>::reset example
std::cout << "创建空 optional:\n";
std::optional<A> opt6;
std::cout << "创建并赋值:\n";
opt6 = A("Lorem ipsum dolor sit amet, consectetur adipiscing elit nec.");
std::cout << "重置 optional:\n";
opt6.reset();
std::cout << "A示例结束\n";
//emaplace example
std::optional<B> opt7;
std::cout << "赋值:\n";
opt7 = B("Lorem ipsum dolor sit amet, consectetur adipiscing elit nec.");
std::cout << "放置:\n";
// 由于 opt 含值,这亦将销毁该值
opt7.emplace("Lorem ipsum dolor sit amet, consectetur efficitur. ");
std::cout << "B示例结束\n";
//std::make_optional example
auto op8 = std::make_optional<std::vector<char>>({ 'a','b','c' });
std::cout << "op1: ";
for (char c : op8.value())
std::cout << c << ',';
auto op9 = std::make_optional<std::vector<int>>(5, 2);
std::cout << "\nop2: ";
for (int i : *op9)
std::cout << i << ',';
std::string str{ "hello world" };
auto op10 = std::make_optional<std::string>(std::move(str));
std::cout << "\nop3: " << quoted(op10.value_or("empty value")) << '\n';
std::cout << "str: " << std::quoted(str) << '\n';
}
运行结果:
参考: