C++11实用技术（三）std::future、std::promise、std::packaged_task、async

C++进阶系列目录

C++ operator关键字的使用（重载运算符、仿函数、类型转换操作符）

C++11实用技术（一）auto与decltype的使用

C++11实用技术（二）std::function和bind绑定器

C++11实用技术（三）std::future、std::promise、std::packaged_task、async

简介

C++的多线程指令是thread。例如

#include 
#include 

// 线程函数，打印一条消息
void printMessage(const std::string& message) {
    std::cout << "Message: " << message << std::endl;
}
int main() {
    // 创建线程对象，并指定线程函数及其参数
    std::thread t(printMessage, "Hello, world!");
    // 等待线程执行完毕
    t.join();
    return 0;
}

我们可以通过thread创建多线程。并把执行任务函数以回调函数的形式传入多线程中去执行。但是通过thread有个问题：

我们没有获取任务函数的接口，也就是我们很难在主线程中拿到我们任务函数的返回值或者内部参数值。（可以通过全局变量来获取，但是有一定的并发风险，并且不优雅）。

而std::future、std::promise就是可以处理这类场景。

std::future&std::async

要想在thread中获得std::future对象还要结合std::promise使用，下面会讲到。
而C++11可以通过std::async来更方便地异步创建执行task，也就是多线程执行task（和thread功能一样）。并且async返回的结果可以用std::future接收。
例如：

#include 
#include 
int calculateSum(int a, int b) {
    return a + b;
}
int main() {
    std::future<int> result = std::async(calculateSum, 2, 3);
    // 执行其他操作...
    // 获取异步任务的结果
    int sum = result.get();
    // 输出结果
    std::cout << "Sum: " << sum << std::endl;
    return 0;
}

可以看到我们的async创建的异步task可以用std::future接收，并且可以在主线程使用.get()来获取返回值。
注意：
result.get()这里是阻塞的，会等到task执行完成才会拿到返回值。（拿到返回值后async就会被回收，不像thread还需要使用join()）。

---

包含.get()在内，获取future结果有3种应用不同场景的方式（有兴趣可以多了解一下）：

• get:阻塞等待异步操作结束并返回结果。
• wait:只是等待异步操作完成，没有返回值。
• wait_for:轮询定时查询future状态，知道任务完成。

---

std::async还有两种线程的创建策略：

• std::launch::async:在调用async时就开始创建线程，默认的就是这种。
• std::launch::deferred:延迟加载方式创建线程。调用async时不创建线程，知道调用了future的get或者wait时才创建线程。

使用示例：

std::future<int> result = std::async(std::launch::async, calculateSum, 2, 3);
std::future<int> result = std::async(std::launch::deferred, calculateSum, 2, 3);

---

future注意点：
用.get()获取任务返回值，只能获取一次。多次获取会报错。

#include 
#include 
int calculateSum(int a, int b) {
	return a + b;
}
int main() {
	std::future<int> result = std::async(calculateSum, 2, 3);
	// 执行其他操作...
	// 获取异步任务的结果
	int sum = result.get();
	// 输出结果
	std::cout << "Sum: " << sum << std::endl;

	int sum1 = result.get();//这里第二次使用get会报错
	return 0;
}

上述int sum = result.get();和int sum1 = result.get();第二次使用会报错。

如果想多次获取异步任务的返回结果可以使用std::shared_future;

shared_future

future可以通过.share()来拿到shared_future对象。

#include 
#include 

// 异步任务函数，返回一个结果
int asyncTask() {
	// 模拟耗时操作
	std::this_thread::sleep_for(std::chrono::seconds(5));
	return 42;
}

int main() {
	// 创建异步任务，并获取 std::future 对象
	std::future<int> fut = std::async(std::launch::async, asyncTask);

	// 创建共享的 std::shared_future 对象
	std::shared_future<int> sharedFut = fut.share();

	// 在多个线程中获取共享的异步任务结果
	std::thread t1([&sharedFut]() {
		int result = sharedFut.get();
		std::cout << "Thread 1 Result: " << result << std::endl;
		});

	std::thread t2([&sharedFut]() {
		int result = sharedFut.get();
		std::cout << "Thread 2 Result: " << result << std::endl;
		});

	t1.join();
	t2.join();

	return 0;
}

上述使用 fut 创建了一个共享的 std::shared_future 对象 sharedFut，并将其传递给两个线程。这两个线程分别调用 sharedFut.get() 来获取共享的异步任务结果。

注意，std::shared_future 可以在多个线程中同时访问结果，而不会阻塞等待。这使得多个线程可以并发地获取异步任务的结果。

std::promise

上述future可以获取我们的异步task返回结果，而promise可以获取我们异步task的中间值。用于在一个线程中产生一个值，并在另一个线程中获取该值。它允许你在一个线程中设置一个值，并将其与一个 std::future 关联起来，以便在另一个线程中获取该值。
例如在主线程获取异步线程task任务中的局部函数sum值：

#include 
#include 

void calculateSum(std::promise<int>& promise, int a, int b) {
    int sum = a + b;
    // 设置值
    promise.set_value(sum);
}
int main() {
    std::promise<int> promise;
    std::future<int> result = promise.get_future();
    // 启动异步任务
    std::thread thread(calculateSum, std::ref(promise), 2, 3);//这里用std::async也是一样的，但这里我们不需要获取task的返回值，所以就使用thread。
    // 执行其他操作...
    // 获取异步任务的结果
    int sum = result.get();
    // 输出结果
    std::cout << "Sum: " << sum << std::endl;
    // 等待线程结束
    thread.join();
    return 0;
}

上述创建了一个 std::promise 对象 promise，并通过调用 promise.get_future() 获取与之关联的 std::future 对象 result。然后启动一个新线程，将 calculateSum 函数作为参数传递给它，并传递 promise 对象和两个整数参数。

在执行其他操作后，我们通过调用 result.get() 来获取异步任务的结果。这会阻塞当前线程，直到task任务内promise.set_value(sum)执行完成。

std::packaged_task

std::packaged_task 是一个类模板，用于包装可调用对象（如函数、函数对象或lambda表达式），并将其与 std::future 关联起来，以便在另一个线程中获取该可调用对象的结果。

例如：

#include 
#include 
int calculateSum(int a, int b) {
    return a + b;
}
int main() {
    std::packaged_task<int(int, int)> task(calculateSum);
    std::future<int> result = task.get_future();
    // 启动异步任务
    std::thread thread(std::move(task), 2, 3);
    // 执行其他操作...
    // 获取异步任务的结果
    int sum = result.get();
    // 输出结果
    std::cout << "Sum: " << sum << std::endl;
    // 等待线程结束
    thread.join();
    return 0;
}

使用 std::packaged_task 类模板创建了一个 task 对象，将 calculateSum 函数作为参数传递给它。然后，我们通过调用 task.get_future() 获取与之关联的 std::future 对象 result。

上面看起来packaged_task和promise有点像，promise是保存一个值，而packaged_task保存了一个函数。

std::promise、std::packaged_task和std::future的关系

上述可以看出promise和packaged_task都可以使用.get_future()获取对象，是因为它们内部都有future，以便访问操作结果。
promise是保存一个值，而packaged_task保存了一个函数。如果想获取某个值，就是用promise，如果想获取返回值，就使用packaged_task（获取返回值也可以使用async，上面有讲到）。