基于C++11的线程池(threadpool),简洁且可以带任意多的参
数
⼯作这些年,写过很多线程池,有基于IOCP的,也有基于BOOST的ASIO的,也有基于_beginthreadex完全裸写的,还有其它版本。
虽然造过很多轮⼦,但基本上因为⼯期,业务等各种原因,没有实现过完全解耦的线程池,⾃⼰感觉⾮常遗憾,
前⼀段时间⼯作终于忙完了,可以短暂休息⼏周,因为⽼⼤们决定放弃⼀些平台了,
所以,这次技术上,可以⼀次性升级到位,使⽤C++ 11 ,15,17了, 真TMD和谐。
下⾯转载⼀篇关于C++ 11版本线程池的⽂章,个⼈觉得⾮常不错,原⽂链接:
咳咳。C++11 加⼊了线程库,从此告别了标准库不⽀持并发的历史。然⽽ c++ 对于多线程的⽀持还是⽐较低级,稍微⾼级⼀点的⽤法都需要⾃⼰去实现,譬如线程池、信号量等。线程池(thread pool)这个东西,在⾯试上多次被问到,⼀般的回答都是:“管理⼀个任务队列,⼀个线程队列,然后每次取⼀个任务分配给⼀个线程去做,循环往复。” 貌似没有问题吧。但是写起程序来的时候就出问题了。
废话不多说,先上实现,然后再啰嗦。(dont talk, show me ur code !)
代码实现
1 #pragma once
2 #ifndef THREAD_POOL_H
3 #define THREAD_POOL_H
4
5 #include <vector>
6 #include <queue>
7 #include <thread>
8 #include <atomic>
9 #include <condition_variable>
10 #include <future>
11 #include <functional>
12 #include <stdexcept>
13
14 namespace std
15 {
16 #define MAX_THREAD_NUM 256
17
18 //线程池,可以提交变参函数或拉姆达表达式的匿名函数执⾏,可以获取执⾏返回值
19 //不⽀持类成员函数, ⽀持类静态成员函数或全局函数,Opteron()函数等
20 class threadpool
21 {
22 using Task = std::function<void()>;
23 // 线程池
24 std::vector<std::thread> pool;
25 // 任务队列
26 std::queue<Task> tasks;
27 // 同步
28 std::mutex m_lock;
29 // 条件阻塞
30 std::condition_variable cv_task;
31 // 是否关闭提交
32 std::atomic<bool> stoped;
33 //空闲线程数量
34 std::atomic<int> idlThrNum;
35
36 public:
37 inline threadpool(unsigned short size = 4) :stoped{ fal }
38 {
39 idlThrNum = size < 1 ? 1 : size;
39 idlThrNum = size < 1 ? 1 : size;
40 for (size = 0; size < idlThrNum; ++size)
41 { //初始化线程数量
42 place_back(
43 [this]
44 { // ⼯作线程函数
45 while(!this->stoped)
46 {
47 std::function<void()> task;
48 { // 获取⼀个待执⾏的 task
49 std::unique_lock<std::mutex> lock{ this->m_lock };// unique_lock 相⽐ lock_guard 的好处是:可以随时 unlock() 和 lock()
50 this->cv_task.wait(lock,
51 [this] {
52 return this->stoped.load() || !this-&pty();
53 }
54 ); // wait 直到有 task
55 if (this->stoped && this-&pty())
56 return;
57 task = std::move(this->tasks.front()); // 取⼀个 task
58 this->tasks.pop();
59 }
60 idlThrNum--;
61 task();
62 idlThrNum++;
63 }
64 }
65 );
66 }
67 }
68 inline ~threadpool()
69 {
70 stoped.store(true);
71 ify_all(); // 唤醒所有线程执⾏
72 for (std::thread& thread : pool) {
73 //thread.detach(); // 让线程“⾃⽣⾃灭”
74 if(thread.joinable())
75 thread.join(); // 等待任务结束,前提:线程⼀定会执⾏完
76 }
77 }
78
79 public:
80 // 提交⼀个任务
81 // 调⽤.get()获取返回值会等待任务执⾏完,获取返回值
82 // 有两种⽅法可以实现调⽤类成员,
83 // ⼀种是使⽤ bind: .commit(std::bind(&Dog::sayHello, &dog));
84 // ⼀种是⽤ mem_fn: .commit(std::mem_fn(&Dog::sayHello), &dog)
85 template<class F, Args>
86 auto commit(F&& f, Args&&... args) ->std::future<decltype())>
87 {
88 if (stoped.load()) // stop == true ??
89 throw std::runtime_error("commit on ThreadPool is stopped.");
90
91 using RetType = decltype()); // typename std::result_of<)>::type, 函数 f 的返回值类型
92 auto task = std::make_shared<std::packaged_task<RetType()> >(
93 std::bind(std::forward<F>(f), std::forward<Args>(args)...)
94 ); // wtf !
95 std::future<RetType> future = task->get_future();
96 { // 添加任务到队列
97 std::lock_guard<std::mutex> lock{ m_lock };//对当前块的语句加锁 lock_guard 是 mutex 的 stack 封装类,构造的时候 lock(),析构的时候unlock()
98 place(
99 [task]()
100 { // push(Task{...})
101 (*task)();
102 }
103 );
103 );
104 }
105 ify_one(); // 唤醒⼀个线程执⾏
106
107 return future;
108 }
109
110 //空闲线程数量
111 int idlCount() { return idlThrNum; }
112
113 };
114
115 }
116
117 #endif
代码不多吧,上百⾏代码就完成了 线程池, 并且, 看看 commit, 哈, 不是固定参数的, ⽆参数数量限制! 这得益于可变参数模板.怎么使⽤?
1 #include "threadpool.h"
2 #include <iostream>
3
4 void fun1(int slp)
5 {
6 printf(" hello, fun1 ! %d\n" ,std::this_thread::get_id());
7 if (slp>0) {
8 printf(" ======= fun1 sleep %d ========= %d\n",slp, std::this_thread::get_id());
9 std::this_thread::sleep_for(std::chrono::milliconds(slp));
10 }
11 }
12
13 struct gfun {
14 int operator()(int n) {
15 printf("%d hello, gfun ! %d\n" ,n, std::this_thread::get_id() );
16 return 42;
17 }
18 };
19
20 class A {
21 public:
22 static int Afun(int n = 0) { //函数必须是 static 的才能直接使⽤线程池
23 std::cout << n << " hello, Afun ! " << std::this_thread::get_id() << std::endl;
24 return n;
25 }
26
27 static std::string Bfun(int n, std::string str, char c) {
28 std::cout << n << " hello, Bfun ! "<< str.c_str() <<" " << (int)c <<" " << std::this_thread::get_id() << std::endl;
29 return str;
30 }
31 };
32
33 int main()
34 try {
35 std::threadpool executor{ 50 };
36 A a;
37 std::future<void> ff = it(fun1,0);
38 std::future<int> fg = it(gfun{},0);
39 std::future<int> gg = it(a.Afun, 9999); //IDE提⽰错误,但可以编译运⾏
40 std::future<std::string> gh = it(A::Bfun, 9998,"mult args", 123);
40 std::future<std::string> gh = it(A::Bfun, 9998,"mult args", 123);
41 std::future<std::string> fh = it([]()->std::string { std::cout << "hello, fh ! " << std::this_thread::get_id() << std::endl; return "hello,fh ret !"; });
42
43 std::cout << " ======= sleep ========= " << std::this_thread::get_id() << std::endl;
44 std::this_thread::sleep_for(std::chrono::microconds(900));
45
46 for (int i = 0; i < 50; i++) {
47 it(fun1,i*100 );
48 }
49 std::cout << " ======= commit all ========= " << std::this_thread::get_id()<< " idlsize="<<executor.idlCount() << std::endl;
50
51 std::cout << " ======= sleep ========= " << std::this_thread::get_id() << std::endl;
52 std::this_thread::sleep_for(std::chrono::conds(3));
53
54 ff.get(); //调⽤.get()获取返回值会等待线程执⾏完,获取返回值
55 std::cout << fg.get() << " " << fh.get().c_str()<< " " << std::this_thread::get_id() << std::endl;
56
57 std::cout << " ======= sleep ========= " << std::this_thread::get_id() << std::endl;
58 std::this_thread::sleep_for(std::chrono::conds(3));
59
60 std::cout << " ======= fun1,55 ========= " << std::this_thread::get_id() << std::endl;
61 it(fun1,55).get(); //调⽤.get()获取返回值会等待线程执⾏完
62
63 std::cout << " " << std::this_thread::get_id() << std::endl;
64
65
66 std::threadpool pool(4);
67 std::vector< std::future<int> > results;
68
69 for (int i = 0; i < 8; ++i) {
70 place_back(
71 it([i] {
72 std::cout << "hello " << i << std::endl;
73 std::this_thread::sleep_for(std::chrono::conds(1));
74 std::cout << "world " << i << std::endl;
75 return i*i;
76 })
77 );
78 }
79 std::cout << " ======= commit all2 ========= " << std::this_thread::get_id() << std::endl;
80
81 for (auto && result : results)
82 std::cout << () << ' ';
83 std::cout << std::endl;
84 return 0;
85 }
86 catch (std::exception& e) {
87 std::cout << "some " << std::this_thread::get_id() << e.what() << std::endl;
88 }
为了避嫌,先进⾏⼀下版权说明:代码是 me “写”的,但是思路来⾃ Internet, 特别是(基本 copy 了这个实现,加上和解释,好东西值得copy ! 然后综合更改了下,更加简洁)。
实现原理
接着前⾯的废话说。“管理⼀个任务队列,⼀个线程队列,然后每次取⼀个任务分配给⼀个线程去做,
循环往复。” 这个思路有神马问题?线程池⼀般要复⽤线程,所以如果是取⼀个 task 分配给某⼀个 thread,执⾏完之后再重新分配,在语⾔层⾯基本都是不⽀持的:⼀般语⾔的 thread 都是执⾏⼀个固定的 task 函数,执⾏完毕线程也就结束了(⾄少 c++ 是这样)。so 要如何实现 task 和 thread 的分配呢?
让每⼀个 thread 都去执⾏调度函数:循环获取⼀个 task,然后执⾏之。
idea 是不是很赞!保证了 thread 函数的唯⼀性,⽽且复⽤线程执⾏ task 。
即使理解了 idea,代码还是需要详细解释⼀下的。
1. ⼀个线程 pool,⼀个任务队列 queue ,应该没有意见;
2. 任务队列是典型的⽣产者-消费者模型,本模型⾄少需要两个⼯具:⼀个 mutex + ⼀个条件变量,或是⼀个 mutex + ⼀个信号量。
mutex 实际上就是锁,保证任务的添加和移除(获取)的互斥性,⼀个条件变量是保证获取 task 的同步性:⼀个 empty 的队列,线程应该等待(阻塞);
3. atomic<bool> 本⾝是原⼦类型,从名字上就懂:它们的操作 load()/store() 是原⼦操作,所以不需要再加 mutex。
c++语⾔细节
即使懂原理也不代表能写出程序,上⾯⽤了众多c++11的“奇技淫巧”,下⾯简单描述之。
1. using Task = function<void()> 是类型别名,简化了 typedef 的⽤法。function<void()> 可以认为是⼀个函数类型,接受任意原型
是 void() 的函数,或是函数对象,或是匿名函数。void() 意思是不带参数,没有返回值。
2. place_back([this]{...}) 和 pool.push_back([this]{...}) 功能⼀样,只不过前者性能会更好;
3. place_back([this]{...}) 是构造了⼀个线程对象,执⾏函数是拉姆达匿名函数 ;
4. 所有对象的初始化⽅式均采⽤了 {},⽽不再使⽤ () ⽅式,因为风格不够⼀致且容易出错;
5. 匿名函数: [this]{...} 不多说。[] 是捕捉器,this 是引⽤域外的变量 this指针, 内部使⽤死循环, 由cv_task.wait(lock,[this]{...}) 来
阻塞线程;
6. delctype(expr) ⽤来推断 expr 的类型,和 auto 是类似的,相当于类型占位符,占据⼀个类型的位
置;auto f(A a, B b) ->
decltype(a+b) 是⼀种⽤法,不能写作 decltype(a+b) f(A a, B b),为啥?! c++ 就是这么规定的!
7. commit ⽅法是不是略奇葩!可以带任意多的参数,第⼀个参数是 f,后⾯依次是函数 f 的参数!(注意:参数要传struct/class的话,建
议⽤pointer,⼩⼼变量的作⽤域) 可变参数模板是 c++11 的⼀⼤亮点,够亮!⾄于为什么是 和 ,因为规定就是这么⽤的!
8. commit 直接使⽤只能调⽤stdcall函数,但有两种⽅法可以实现调⽤类成员,⼀种是使⽤ bind:
.commit(std::bind(&Dog::sayHello, &dog)); ⼀种是⽤ mem_fn: .commit(std::mem_fn(&Dog::sayHello), &dog);
9. make_shared ⽤来构造 shared_ptr 智能指针。⽤法⼤体是 shared_ptr<int> p = make_shared<int>(4) 然后 *p == 4 。智能指针
的好处就是, ⾃动 delete !
10. bind 函数,接受函数 f 和部分参数,返回currying后的匿名函数,譬如 bind(add, 4) 可以实现类似 add4 的函数!
11. forward() 函数,类似于 move() 函数,后者是将参数右值化,前者是... 肿么说呢?⼤概意思就是:不改变最初传⼊的类型的引⽤类
型(左值还是左值,右值还是右值);
12. packaged_task 就是任务函数的封装类,通过 get_future 获取 future , 然后通过 future 可以获取函数的返回值(());
packaged_task 本⾝可以像函数⼀样调⽤ () ;
13. queue 是队列类, front() 获取头部元素, pop() 移除头部元素;back() 获取尾部元素,push() 尾部添加元素;
14. lock_guard 是 mutex 的 stack 封装类,构造的时候 lock(),析构的时候 unlock(),是 c++ RAII 的 idea;
15. condition_variable cv; 条件变量, 需要配合 unique_lock 使⽤;unique_lock 相⽐ lock_guard 的好处是:可以随时 unlock() 和
lock()。 cv.wait() 之前需要持有 mutex,wait 本⾝会 unlock() mutex,如果条件满⾜则会重新持有 mutex。
16. 最后线程池析构的时候,join() 可以等待任务都执⾏完在结束,很安全!
Git