使用结构化绑定来解包绑定的返回值

C++17配备了一种新的特性——结构化绑定，其可以结合语法糖来自动推到类型，并可以从组对、元组和结构体中提取单独的变量。其他编程语言中，这种特性也被成为解包。

How to do it…

使用结构化绑定是为了能够更加简单的，为绑定了多个变量的结构体进行赋值。我们先来看下在C++17标准之前是如何完成这个功能的。然后，我们将会看到一些使用C++17实现该功能的例子：

  • 访问std::pair中的一个元素：假设我们有一个数学函数divide_remainder，需要输入一个除数和一个被除数作为参数，返回得到的分数的整数部分和余数。可以使用一个std::pair来绑定这两个值:

    std::pair<int, int> divide_remainder(int dividend, int divisor);

考虑使用如下的方式访问组对中的单个值：

  1. const auto result (divide_remainder(16, 3));
  2. std::cout << "16 / 3 is " <<
  3.           << result.first << " with a remainder of "
  4.           << result.second << '\n';

与上面的代码段不同，我们现在可以将相应的值赋予对应的变量，这样写出来的代码可读性更高:

  1. auto [fraction, remainder] = divide_remainder(16, 3);
  2. std::cout << "16 / 3 is "
  3.           << fraction << " with a remainder of "
  4.           << remainder << '\n';
  • 也能对std::tuple进行结构化绑定：让我们使用下面的实例函数，获取股票的在线信息：
  1. std::tuple<std::string, std::chrono::system_clock::time_point, unsigned>
  2. stock_info(const std::string &name);

我们可以使用如下的方式获取这个例子的各个变量的值：

  1. const auto [name, valid_time, price] = stock_info("INTC");
  • 结构化绑定也能用在自定义结构体上。假设有这么一个结构体：
  1. struct employee{
  2.     unsigned id;
  3.     std::string name;
  4.     std::string role;
  5.     unsigned salary;
  6. };

现在我们来看下如何使用结构化绑定访问每一个成员。我们假设有一组employee结构体的实例，存在于vector中，下面使用循环将其内容进行打印：

  1. int main(){
  2.     std::vector<employee> employees{
  3.         /* Initialized from somewhere */
  4.     };
  6.     for (const auto &[id, name, role, salary] : employees){
  7.         std::cout << "Name: " << name
  8.                   << "Role: " << role
  9.                   << "Salary: " << salary << '\n';
  10.     }
  11. }

How it works…

结构化绑定以以下方式进行应用：

auto [var1, var2, ...] = <pair, tuple, struct, or array expression>;

  • var1, var2, ...表示一个变量列表，其变量数量必须匹配表达式所对应的结构。
  • <pair, tuple, struct, or array expression>必须是下面的其中一种：
    • 一个std::pair实例。
    • 一个std::tuple实例。
    • 一个结构体实例。其所有成员都必须是非静态成员，每个成员以基础类定义。结构体中的第一个声明成员赋予第一个变量的值，第二个声明的编程赋予第二个变量的值，依次类推。
    • 固定长度的数组。
  • auto部分，也就是var的类型，可以是auto,const auto,const auto&和auto&&。

Note:

不仅为了性能，还必须确保在适当的时刻使用引用，尽量减少不必要的副本。

如果中括号中变量不够，那么编译器将会报错:

  1. std::tuple<int, float, long> tup(1, 2.0, 3);
  2. auto [a, b] = tup; // Does not work

这个例子中想要将三个成员值，只赋予两个变量。编译器会立即发现这个错误，并且提示我们:

  1. error: type 'std::tuple<int, float, long>' decomposes into 3 elements, but only 2 names were provided
  2. auto [a, b] = tup;

There’s more…

STL中的基础数据结构都能通过结构结构化绑定直接进行访问，而无需修改任何东西。考虑下面这个例子，循环中打印std::map中的元素：

  1. std::map<std::string, size_t> animal_population {
  2.   {"humans", 7000000000},
  3.   {"chickens", 17863376000},
  4.   {"camels", 24246291},
  5.   {"sheep", 1086881528},
  6.   /* ... */
  7. };
  9. for (const auto &[species, count] : animal_population) {
  10.   std::cout << "There are " << count << " " << species
  11.             << " on this planet.\n";
  12. }

从std::map容器中获取元素的方式比较特殊，我们会在每次迭代时获得一个std::pair<const key_type, value_type>实例。另外每个实例都需要进行结构化绑定(key_type绑定到species字符串上，value_type为一个size_t格式的统计数字)，从而达到访问每一个成员的目的。

在C++17之前，使用std::tie可达到类似的效果:

  1. int remainder;
  2. std::tie(std::ignore, remainder) = divide_remainder(16, 5);
  3. std::cout << "16 % 5 is " << remainder << '\n';

这个例子展示了如何将结果组对解压到两个变量中。std::tie的能力远没有结构化绑定强，因为在进行赋值的时候，所有变量需要提前定义。另外，本例也展示了一种在std::tie中有，而结构化绑定没有的功能：可以使用std::ignore的值，作为虚拟变量。分数部分将会赋予到这个虚拟变量中，因为这里我们不需要用到分数值，所以使用虚拟变量忽略分数值。

Note:

使用结构化绑定时，就不能再使用std::tie创建虚拟变量了，所以我们不得不绑定所有值到命名过的变量上。对部分成员进行绑定的做法是高效的，因为编译器可以很容易的对未绑定的变量进行优化。

回到之前的例子，divide_remainder函数也可以通过使用传入输出参数的方式进行实现：

  1. bool divide_remainder(int dividend, int divisor, int &fraction, int &remainder);

调用该函数的方式如下所示：

  1. int fraction, remainder;
  2. const bool success {divide_remainder(16, 3, fraction, remainder)};
  3. if (success) {
  4.   std::cout << "16 / 3 is " << fraction << " with a remainder of "
  5.             << remainder << '\n';
  6. }

很多人都很喜欢使用特别复杂的结构，比如组对、元组和结构体，他们认为这样避免了中间拷贝过程，所以代码会更快。对于现代编译器来说，这种想法不再是正确的了，这里编译器并没有刻意避免拷贝过程，而是优化了这个过程。(其实拷贝过程还是存在的)。

Note:

与C的语法特征不同，将复杂结构体作为返回值传回会耗费大量的时间，因为对象需要在返回函数中进行初始化，之后将这个对象拷贝到相应容器中返回给调用端。现代编译器支持返回值优化(RVO, return value optimization)技术，这项技术可以省略中间副本的拷贝。