基于 C++11 手写 Promise 实现原理及与 std::promise 对比

Promise 解决的问题

1. 回调地狱：通过链式调用，Promise 解决了传统回调嵌套导致的代码难以阅读和维护的问题。
2. 错误处理：Promise 提供了统一的错误处理机制，通过 catch 方法可以集中处理所有异步操作中的错误。
3. 代码可读性：Promise 使得异步代码的逻辑更加清晰，符合同步代码的书写习惯。
4. 并发控制：通过 Promise.all 和 Promise.race，可以方便地控制多个异步操作的执行顺序和结果。

手写 C++ Promise 实现

类结构与成员变量

template<typename Element>
class CPromise {
private:
    using Resolve = std::function<void(Element)>;
    using Reject = std::function<void(const std::string&)>;
private:
    Element m_element; /**< 异步操作的结果 */
    std::string m_reason; /**< 拒绝的原因 */
    CPromiseState m_state; /**< 当前状态 */
    std::list<Resolve> m_resolves; /**< 成功回调函数列表 */
    std::list<Reject> m_rejects; /**< 失败回调函数列表 */
public:
    CPromise();
    void reject(const std::string& reason);
    void resolve(Element element);
    void onCatch(const Reject& rej);
    CPromise* then(const Resolve& res);
};

• Resolve 和 Reject：定义了成功和失败回调函数的类型。
• m_element 和 m_reason：分别存储 Promise 的结果和拒绝原因。
• m_state：表示 Promise 的当前状态，初始状态为 PENDING。
• m_resolves 和 m_rejects：存储注册的成功和失败回调函数列表。

构造函数

CPromise() : m_state(CPromiseState::PENDING) {}

• 作用：初始化 Promise 的状态为 PENDING。

resolve 方法

void resolve(Element element) {
    m_element = element;
    if (m_state == CPromiseState::PENDING) {
        m_state = CPromiseState::FULFILLED;
        for (Resolve res : m_resolves) {
            res(element);
        }
    }
}

• 作用：将 Promise 的状态设置为 FULFILLED，并执行所有注册的成功回调函数。

reject 方法

void reject(const std::string& reason) {
    m_reason = reason;
    if (m_state == CPromiseState::PENDING) {
        m_state = CPromiseState::REJECTED;
        for (Reject rej : m_rejects) {
            rej(reason);
        }
    }
}

• 作用：将 Promise 的状态设置为 REJECTED，并执行所有注册的失败回调函数。

then 方法

CPromise* then(const Resolve& res) {
    if (m_state == CPromiseState::FULFILLED) {
        res(m_element);
    } else if (m_state == CPromiseState::PENDING) {
        m_resolves.push_back(res);
    }
    return this;
}

• 作用：注册一个成功回调函数。如果 Promise 已经完成，则立即执行回调；否则，将回调添加到成功回调列表中。

onCatch 方法

void onCatch(const Reject& rej) {
    if (m_state == CPromiseState::REJECTED) {
        rej(m_reason);
    } else if (m_state == CPromiseState::PENDING) {
        m_rejects.push_back(rej);
    }
}

• 作用：注册一个失败回调函数。如果 Promise 已经被拒绝，则立即执行回调；否则，将回调添加到失败回调列表中。

链式调用

通过 then 和 onCatch 方法，可以实现链式调用，使得异步操作的处理更加简洁和直观。

promise->then([](int ele) -> void {
    std::cout << ele << std::endl;
})->onCatch([](const std::string& reason) -> void {
    std::cout << reason << std::endl;
});

使用示例

CPromise<int>* promise = new CPromise<int>();
promise->then([](int ele) -> void {
    std::cout << ele << std::endl;
})->onCatch([](const std::string& reason) -> void {
    std::cout << reason << std::endl;
});
promise->reject("网络异常!!!");

std::promise 与 CPromise 对比

1. 基础功能对比

2. 实现细节对比

(1) 状态管理

• CPromise：通过自定义枚举 CPromiseState 管理状态。
• std::promise：状态管理由标准库实现，用户无需关注底层细节。

(2) 回调注册与执行

• CPromise：手动维护回调队列，通过 then 和 onCatch 方法注册回调。
• std::promise：通过 std::future 与 std::promise 配合，回调通过 future 的 get 方法触发。

(3) 异步支持

• CPromise：需要结合 std::thread 或其他异步框架实现异步操作。
• std::promise：内置支持异步操作，通常与 std::async 或 std::thread 结合使用。

(4) 链式调用

• CPromise：支持链式调用，通过返回 this 实现。
• std::promise：不支持链式调用，无法直接链式注册回调。

3. 代码示例对比

(1) CPromise 示例

CPromise<int>* promise = new CPromise<int>();
promise->then([](int ele) -> void {
    std::cout << ele << std::endl;
})->onCatch([](const std::string& reason) -> void {
    std::cout << reason << std::endl;
});
promise->reject("网络异常!!!");

(2) std::promise 示例

#include <future>
#include <thread>
#include <iostream>

int main() {
    std::promise<int> prom;
    std::future<int> fut = prom.get_future();

    // 异步操作
    std::thread([&prom]() {
        // 模拟网络请求
        std::this_thread::sleep_for(std::chrono::seconds(1));
        prom.set_value(42);
    }).detach();

    // 注册回调
    fut.then([](std::future<int> fut) {
        try {
            int result = fut.get();
            std::cout << "结果：" << result << std::endl;
        } catch (const std::exception& e) {
            std::cout << "错误：" << e.what() << std::endl;
        }
    });

    // 主线程阻塞等待
    std::this_thread::sleep_for(std::chrono::seconds(2));
    return 0;
}

4. 优缺点分析

(1) CPromise

• 优点：
  • 代码简洁，易于理解。
  • 支持链式调用，使用方式类似前端 Promise。
  • 可以作为学习 Promise 实现原理的示例。
• 缺点：
  • 不支持内置异步操作，需要结合线程实现。
  • 功能较为基础，缺乏 std::promise 的高级特性（如 then 的链式返回）。

(2) std::promise

• 优点：
  • 内置异步支持，与 std::future 配合使用，功能强大。
  • 标准库实现，性能优化和稳定性有保障。
  • 支持 C++11 及以上标准，兼容性好。
• 缺点：
  • 使用方式较为复杂，缺乏链式调用的支持。
  • 回调机制不够灵活，无法像前端 Promise 那样优雅地处理异步流程。

总结与展望

通过手写 CPromise，我们可以深入理解 Promise 的实现原理，包括状态管理、回调注册与执行等核心机制。然而，在实际开发中，std::promise 仍然是更好的选择，因为它提供了更强大的功能和更好的性能保障。

对于开发者来说，理解 std::promise 的工作原理以及其与手写实现的异同点，有助于更好地选择合适的工具来处理异步操作。同时，手写实现虽然功能有限，但作为学习和探索的工具，仍然具有重要的价值。

希望本文能够帮助读者更好地理解 Promise 的实现原理，并在实际开发中做出更明智的选择。