C++中std::optional的使用指南分享

更新時間：2023年06月25日 08:43:51 作者：YunfengWang

C++?17?引入了std::optional，表示一個可能有值的對象，這篇文章主要來和大家聊聊std::optional的使用，文中的示例代碼講解詳細，感興趣的小伙伴可以了解一下

1. std::optional 是什么

C++ 17 引入了std::optional，表示一個可能有值的對象（沒有值時就是默認的std::nullopt)，例如下面的例子中，創(chuàng)建了一個 std::optional 對象 even_value，如果is_even 為真的話就有整數(shù)值128，否則就是默認值std::nullopt:

#include <iostream>
#include <optiona>
bool is_even = true;
// 在 沒有賦實際值的情況下 std::optional 對象的默認值為 std::nullopt
std::optional<int> even_value = is_even ? std::optional<int>(128) : std::nullopt;
// 可以用 std::optional 對象是否等于 std::nullopt 來判斷 std::optional 對象是否有值
if (even_value != std::nullopt) {
    // 采用.value 獲取 std::optional 對象的值
    std::cout << "has value, which is " << even_value.value() << std::endl;
} else {
    std::cout << "no value" << std::endl;
}

其實std::optional的作用和Python里面的None比較像，例如上面的例子用Python來寫就是這樣：

is_even = True
even_value = 128 if is_even else None
if even_value is not None:
    print("has value, which is", even_value)
else:
    print("no value")

2. 為什么要引入 std::optional

我覺得提出std::optional就是因為C++底層缺少None 這個表示，所以將std::nullopt和某種特定類型的變量合并在一起構(gòu)造成一個std::optional對象，用以解決因為缺少之前None因而存在的一些不怎么直接的用法。

這里舉個例子來說明前面提到的"不直接"的用法。這是一個尋找數(shù)組中的第一個非0元素的函數(shù)：

    int findFirstNonZero(int arr[], int size) {
    for (int i = 0; i < size; i++) {
        if (arr[i] != 0) {
            return arr[i];
        }
    }
    return -1; // 如果數(shù)組中沒有非0元素，則返回-1
}

可以看到，沒找到元素時返回-1，所以當(dāng)拿到-1時，沒法判斷是第一個非0元素為-1還是沒找到非0元素。改進方案是返回一個pair，第一個位置表示是否包含非0元素，第二個位置表示非0元素的值：

#include <utility>
std::pair<bool, int> findFirstNonZero(int arr[], int size) {
    for (int i = 0; i < size; i++) {
        if (arr[i] != 0) {
            return std::make_pair(true, arr[i]);
        }
    }
    return std::make_pair(false, -1); // 如果數(shù)組中沒有非0元素，則返回false和-1
}

但這樣其實比較繁瑣且不直觀，兩個變量的解析和使用成本還是有些高，如果能用一個變量來完成的話就更簡潔了。

采用std::optional可以簡化上面的代碼：

#include <optional>
std::optional<int> findFirstNonZero(int arr[], int size) {
    for (int i = 0; i < size; i++) {
        if (arr[i] != 0) {
            return arr[i];
        }
    }
    return std::nullopt; // 如果數(shù)組中沒有非0元素，則返回std::nullopt
}

使用這個函數(shù)時也只需要判斷一下返回值是否為std::nullopt 就可以。

總之可以將std::optional對象當(dāng)作支持判斷是否為NULL的對象的封裝，在不確定對象是否存在的情況下，建議使用。

3. std::optional 的構(gòu)造

空的 std::optional 對象可以用std::nullopt 或者{} 來構(gòu)造，然后用emplace 函數(shù)來插入數(shù)值：

    // 1.0 采用 std::nullopt 初始化再調(diào)用 emplace 插入值
    std::optional<int> val0 = std::nullopt;
    val0.emplace(128);
    std::cout << val0.value() << std::endl;
    // 1.1 采用 {} 初始化再調(diào)用 emplace 插入值
    std::optional<int> val1 = {};
    val1.emplace(128);
    std::cout << val1.value() << std::endl;

每次調(diào)用emplace 時，會清除掉之前的值，因此可以多次調(diào)用，且能保證每次都是最新的數(shù)值。

也可以用 std::make_optional 函數(shù)來構(gòu)造：

    // 1.7 采用 std::make_optional<T>(val) 初始化
    std::optional<int> val7 = std::make_optional<int>(128);
    std::cout << val7.value() << std::endl;
    // 1.8 采用 std::make_optional(val) 初始化，自動推導(dǎo)變量類型
    std::optional<int> val8 = std::make_optional(128);
    std::cout << val8.value() << std::endl;

除此之外還有很多種初始化 std::optional 對象的方法，都寫在這個示例代碼里面了，記得看注釋：

    // 1.2 采用 std::optional<T>(val) 初始化
    std::optional<int> val2 = std::optional<int>(128);
    std::cout << val2.value() << std::endl;
    // 1.3 采用 std::optional(val) 初始化，自動推導(dǎo)變量類型
    std::optional<int> val3 = std::optional(128);
    std::cout << val3.value() << std::endl;
    // 1.4 采用 std::optional<T>{val} 初始化
    std::optional<int> val4 = std::optional<int>{128};
    std::cout << val4.value() << std::endl;
    // 1.5 采用 std::optional{val} 初始化
    std::optional<int> val5 = std::optional{128};
    std::cout << val5.value() << std::endl;
    // 1.6 采用 {val} 初始化
    std::optional<int> val6 = {128};
    std::cout << val6.value() << std::endl;

4. std::optional 判斷是否有值

判斷 std::optional 對象是否有值可以用 has_value函數(shù)，或者判斷是否不等于std::nullopt，或者直接用if語句對對象進行判斷：

    std::optional<int> result1 = find_the_first_postive_value(pos_values);
    if (result1.has_value()) {
        std::cout << result1.value() << std::endl;
    }
    if (result1 != std::nullopt) {
        std::cout << result1.value() << std::endl;
    }
    if (result1) {
        std::cout << result1.value() << std::endl;
    }

5. std::optional 獲取值

獲取值的話可以用.value() 函數(shù)，或者* 運算符：

    if (result1) {
        std::cout << result1.value() << std::endl;
    }
    if (result1) {
        std::cout << *result1 << std::endl;
    }

如果想在std::optional對象為std::nullopt的情況下設(shè)置默認值的話，可以用value_or 函數(shù)：

    std::optional<int> val9 = std::nullopt;
    std::cout << val9.value_or(-1) << std::endl; // 輸出 -1
    val9.emplace(128);
    std::cout << val9.value_or(-1) << std::endl; // 輸出 128

很明顯，value_or函數(shù)中的默認值需要和optional對象的類型一致，否則會編譯報錯。

6. 沒有值時的異常處理

如果在沒有值的情況下調(diào)用.value 函數(shù)，會在運行時報錯std::bad_optional_access:

std::optional<int> val10 = std::nullopt;
    std::cout << val10.value() << std::endl;

輸出：

libc++abi: terminating due to uncaught exception of type std::bad_optional_access: bad_optional_access

所以建議使用.value_or來處理，如果要強行使用.value的話，需要使用 try-catch 語句：

    std::optional<int> val11 = std::nullopt;
    try {
        std::cout << val11.value() << std::endl;
    } catch (const std::bad_optional_access& e) {
        std::cout << "==> error: " << e.what() << std::endl;
    }

7. 示例代碼

上面的所有示例代碼匯總：

#include <iostream>
#include <optional>
#include <vector>
std::optional<int> find_the_first_postive_value(const std::vector<int>& values) {
    for (auto& val : values) {
        if (val > 0) {
            return std::optional<int>(val);
        }
    }
    return std::nullopt;
}
std::optional<int> find_the_first_postive_value_v2(const std::vector<int>& values) {
    auto it = std::find_if(values.begin(), values.end(), [](int val) { return val > 0; });
    return it != values.end() ? std::make_optional(*it) : std::nullopt;
}
void show_backend(std::optional<std::string> backend) {
    if (backend) {
        std::cout << "==> use set backend: " << backend.value() << std::endl;
    } else {
        std::cout << "==> use default backend: CPU" << std::endl;
    }
}
int main() {
    // std::optional 簡單例子
    bool is_even = true;
    std::optional<int> even_value = is_even ? std::optional<int>(128) : std::nullopt;
    if (even_value != std::nullopt) {
        std::cout << "has value, which is " << even_value.value() << std::endl;
    } else {
        std::cout << "no value" << std::endl;
    }
    // 1. std::optional 對象的構(gòu)造
    // 1.0 采用 std::nullopt 初始化再調(diào)用 emplace 插入值
    std::optional<int> val0 = std::nullopt;
    val0.emplace(128);
    val0.emplace(129);
    std::cout << val0.value() << std::endl;
    // 1.1 采用 {} 初始化再調(diào)用 emplace 插入值
    std::optional<int> val1 = {};
    val1.emplace(128);
    std::cout << val1.value() << std::endl;
    // 1.2 采用 std::optional<T>(val) 初始化
    std::optional<int> val2 = std::optional<int>(128);
    std::cout << val2.value() << std::endl;
    // 1.3 采用 std::optional(val) 初始化，自動推導(dǎo)變量類型
    std::optional<int> val3 = std::optional(128);
    std::cout << val3.value() << std::endl;
    // 1.4 采用 std::optional<T>{val} 初始化
    std::optional<int> val4 = std::optional<int>{128};
    std::cout << val4.value() << std::endl;
    // 1.5 采用 std::optional{val} 初始化
    std::optional<int> val5 = std::optional{128};
    std::cout << val5.value() << std::endl;
    // 1.6 采用 {val} 初始化
    std::optional<int> val6 = {128};
    std::cout << val6.value() << std::endl;
    // 1.7 采用 std::make_optional<T>(val) 初始化
    std::optional<int> val7 = std::make_optional<int>(128);
    std::cout << val7.value() << std::endl;
    // 1.8 采用 std::make_optional(val) 初始化，自動推導(dǎo)變量類型
    std::optional<int> val8 = std::make_optional(128);
    std::cout << val8.value() << std::endl;
    std::optional<int> val9 = std::nullopt;
    std::cout << val9.value_or(-1) << std::endl;
    val9.emplace(128);
    std::cout << val9.value_or(-1) << std::endl;
    //    std::optional<int> val10 = std::nullopt;
    //    std::cout << val10.value() << std::endl;
    std::optional<int> val11 = std::nullopt;
    try {
        std::cout << val11.value() << std::endl;
    } catch (const std::bad_optional_access& e) {
        std::cout << "==> error: " << e.what() << std::endl;
    }
    // 函數(shù)調(diào)用例子
    std::vector<int> neg_values = {-1, -3, -5};
    std::vector<int> pos_values = {1, 3, 5};
    auto result1 = find_the_first_postive_value_v2(pos_values);
    if (result1.has_value()) {
        std::cout << result1.value() << std::endl;
    }
    if (result1 != std::nullopt) {
        std::cout << result1.value() << std::endl;
    }
    if (result1) {
        std::cout << result1.value() << std::endl;
    }
    if (result1) {
        std::cout << *result1 << std::endl;
    }
    // try-catch 示例
    try {
        std::cout << result1.value() << std::endl;
    } catch (const std::bad_optional_access& e) {
        std::cout << "==> error: " << e.what() << std::endl;
    }
    show_backend(std::nullopt);
    show_backend(std::make_optional("CUDA"));
    auto my_backend = std::optional<std::string>{"MPS"};
    show_backend(my_backend);
    my_backend.emplace("DSP");
    show_backend(my_backend);
    std::optional<std::vector<int>> res = std::optional<std::vector<int>>({1, 2, 3});
    std::cout << res.value()[0] << std::endl;
}

可以通過g++ -std=c++17 main.cpp && ./a.out 來編譯運行。

到此這篇關(guān)于C++中std::optional的使用指南分享的文章就介紹到這了,更多相關(guān)C++ std::optional內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: