muduo库学习篇-threadPool类的封装

在多线程编程中一般情况下，我们都会使用到线程池，因此muduo库也有对线程池的封装，接下来我们看看muduo库对线程池的实现，基本上和大部分的线程池的实现，大同小异。

ThreadPool.h

// Use of this source code is governed by a BSD-style license
// that can be found in the License file.
//
// Author: Shuo Chen (chenshuo at chenshuo dot com)

#ifndef MUDUO_BASE_THREADPOOL_H
#define MUDUO_BASE_THREADPOOL_H

#include "muduo/base/Condition.h"
#include "muduo/base/Mutex.h"
#include "muduo/base/Thread.h"
#include "muduo/base/Types.h"

#include <deque>
#include <vector>

namespace muduo
{

class ThreadPool : noncopyable
{
 public:
  typedef std::function<void ()> Task;

  explicit ThreadPool(const string& nameArg = string("ThreadPool"));
  ~ThreadPool();

  // Must be called before start().
  void setMaxQueueSize(int maxSize) { maxQueueSize_ = maxSize; }
  void setThreadInitCallback(const Task& cb)
  { threadInitCallback_ = cb; }

  void start(int numThreads);
  void stop();

  const string& name() const
  { return name_; }

  size_t queueSize() const;

  // Could block if maxQueueSize > 0
  // There is no move-only version of std::function in C++ as of C++14.
  // So we don't need to overload a const& and an && versions
  // as we do in (Bounded)BlockingQueue.
  // https://stackoverflow.com/a/25408989
  void run(Task f);

 private:
  bool isFull() const REQUIRES(mutex_);
  void runInThread();
  Task take();

  mutable MutexLock mutex_;
  Condition notEmpty_ GUARDED_BY(mutex_);
  Condition notFull_ GUARDED_BY(mutex_);
  string name_;
  Task threadInitCallback_;
  std::vector<std::unique_ptr<muduo::Thread>> threads_;
  std::deque<Task> queue_ GUARDED_BY(mutex_);
  size_t maxQueueSize_;
  bool running_;
};

}  // namespace muduo

#endif  // MUDUO_BASE_THREADPOOL_H

muduo库线程池的成员变量有：

• 互斥锁mutex,用于线程间数据同步使用
• 两个条件变量，notEmpty_，notFull_用来判断任务池中任务的数量
• 线程名称
• 线程回调函数，用来消费任务
• 线程指针数组
• 任务deque队列
• 任务队列的中允许存放的最多任务个数
• 线程是否启动

muduo ThreadPool框架图：

ThreadPool.cc

// Use of this source code is governed by a BSD-style license
// that can be found in the License file.
//
// Author: Shuo Chen (chenshuo at chenshuo dot com)

#include "muduo/base/ThreadPool.h"

#include "muduo/base/Exception.h"

#include <assert.h>
#include <stdio.h>

using namespace muduo;

ThreadPool::ThreadPool(const string& nameArg)
  : mutex_(),
    notEmpty_(mutex_),
    notFull_(mutex_),
    name_(nameArg),
    maxQueueSize_(0),
    running_(false)
{
}

ThreadPool::~ThreadPool()
{
  if (running_)
  {
    stop();
  }
}

void ThreadPool::start(int numThreads)
{
  assert(threads_.empty());
  running_ = true;
  threads_.reserve(numThreads);
  for (int i = 0; i < numThreads; ++i)
  {
    char id[32];
    snprintf(id, sizeof id, "%d", i+1);
    threads_.emplace_back(new muduo::Thread(
          std::bind(&ThreadPool::runInThread, this), name_+id));
    threads_[i]->start();
  }
  if (numThreads == 0 && threadInitCallback_)
  {
    threadInitCallback_();
  }
}

void ThreadPool::stop()
{
  {
  MutexLockGuard lock(mutex_);
  running_ = false;
  notEmpty_.notifyAll();
  }
  for (auto& thr : threads_)
  {
    thr->join();
  }
}

size_t ThreadPool::queueSize() const
{
  MutexLockGuard lock(mutex_);
  return queue_.size();
}

void ThreadPool::run(Task task)
{
  if (threads_.empty())
  {
    task();
  }
  else
  {
    MutexLockGuard lock(mutex_);
    while (isFull())
    {
      notFull_.wait();
    }
    assert(!isFull());

    queue_.push_back(std::move(task));
    notEmpty_.notify();
  }
}

ThreadPool::Task ThreadPool::take()
{
  MutexLockGuard lock(mutex_);
  // always use a while-loop, due to spurious wakeup
  while (queue_.empty() && running_)
  {
    notEmpty_.wait();
  }
  Task task;
  if (!queue_.empty())
  {
    task = queue_.front();
    queue_.pop_front();
    if (maxQueueSize_ > 0)
    {
      notFull_.notify();
    }
  }
  return task;
}

bool ThreadPool::isFull() const
{
  mutex_.assertLocked();
  return maxQueueSize_ > 0 && queue_.size() >= maxQueueSize_;
}

void ThreadPool::runInThread()
{
  try
  {
    if (threadInitCallback_)
    {
      threadInitCallback_();
    }
    while (running_)
    {
      Task task(take());
      if (task)
      {
        task();
      }
    }
  }
  catch (const Exception& ex)
  {
    fprintf(stderr, "exception caught in ThreadPool %s\n", name_.c_str());
    fprintf(stderr, "reason: %s\n", ex.what());
    fprintf(stderr, "stack trace: %s\n", ex.stackTrace());
    abort();
  }
  catch (const std::exception& ex)
  {
    fprintf(stderr, "exception caught in ThreadPool %s\n", name_.c_str());
    fprintf(stderr, "reason: %s\n", ex.what());
    abort();
  }
  catch (...)
  {
    fprintf(stderr, "unknown exception caught in ThreadPool %s\n", name_.c_str());
    throw; // rethrow
  }
}

muduo库线程池的实现:

• 构造函数对成员变量进行初始化，互斥锁条件变量的构造，任务队列的默认任务数量为0；
• 析构函数对线程池的状态进行判断，如果线程池不是关闭状态关闭线程
• start函数设置线程的数量，并设置线程的状态为running，并且通过 threads_.reserve(numThreads)设置线程池中线程的数量，同时设置线程的回调函数
• stop函数，将线程池的状态修改为停止，同时等待所有的线程结束，看实现代码，没有对任务队列中为处理任务数量进行判断，如果停止，应该保证任务队列中的所有任务都处理结束，而muduo库的代码，只是将每个线程手中执行的任务处理完成，因此个人认为stop函数的实现不是很完美
• run函数将外部的任务放入任务队列，同时在放入任务队列时判断任务队列是否已满，如果已满就阻塞等待，知道任务队列有空余的空间
• take函数，线程从线程池中取任务如果任务队列任务数量为空，那么就阻塞等待，知道有任务进入任务队列
• runInThread函数，线程的工作loop

由于muduo库是基于对象编程的设计理念，所以muduo库的任务队列中存放的都是回调函数，线程池的另外一种实现方式就是将muduo库中任务队列换成一个taskbase的基类指针，通过虚函数多态来实现对任务的动态调用，但是如果是这样设计的话，muduo库就必须提供一个taskbase的基类，外部的使用者就必须继承该基类才能够使用muduo库。各有各的好处吧，如果我们是在一个项目中设计一个ThreadPool的话，个人认为通过基类指针这种方式设计任务队列更好些，如果是封装一个框架类型的话还是muduo库的这种更加合理吧，使外部threadpool的使用者之关系自己的业务设计，而无需与threadpool做匹配。