devbox
羊村懒王
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

线程池【Linux】_linux 线程池

作者：羊村懒王 | 2024-05-25 11:04:48

赞

踩

linux 线程池

文章目录

1. 引入

线程池是一种池化技术，是一种线程的使用方式。对于执行任务的整个过程，执行流的创建与销毁，调度本身就需要花费一定的时间。当线程数量达到一定程度，那么维护线程会消耗一些资源。

在生产者消费者模型中，这两个执行流在任意时刻只有其中之一才会访问临界资源；为了提高对临界资源处理的效率，即使实现了多生产多消费，其本质上也是单生产单消费。本质原因是，由于多线程并发访问临界资源可能会出现问题，所以使用条件变量或信号量，以及互斥锁限制了在同一时间段内，只有一个执行流能够访问临界资源。

线程池是一种以空间换时间的做法，例如在STL中，通常以1.5倍或2倍增长。这样做的目的是减少时间，提高效率。实现创建多个线程，用某个数据结构管理它们（例如队列），让多个线程同时在队列中等待任务的派发。那么当任务很多时，就能直接从队列中取出线程，这就将「创建线程」这一操作从「执行任务」的流程中剔除，从整体上节省了时间。

2. 应用

3. 实现

封装线程

在线程类Thread中用成员函数封装创建线程和销毁线程的接口。并且可以设置要传给线程的各种参数。不可缺少的是线程要执行的任务，即线程函数，除此之外，增加了线程的信息，例如线程的名字。其中线程的信息单独用一个类ThreadData封装。

// #include <functional>

// typedef std::function<void* (void*)> func_t; 
typedef void *(*func_t)(void *);	// 定义一个函数类型
// (要传递给)线程的信息
class ThreadData
{
public:
	void* _args;		// 线程参数
	std::string _name;	// 线程名称
};
// 线程类
class Thread
{
public:
	Thread(int num, func_t callback, void* args)
	: _func(callback)
	{
		char threadName[64];
		snprintf(threadName, sizeof(threadName), "Thread:[%d]", num);
		_name = threadName;
		
		_td._args = args;	// 给线程传递参数
		_td._name = _name;
	}
	~Thread()
	{}
	// 创建线程
	void start()
	{
		pthread_create(&_tid, nullptr, _func, (void*)&_td);
	}
	void join()
	{
		pthread_join(&_tid, nullptr);
	}
	std::string name()
	{
		return _name;
	}
private:
	ThreadData _td;		// 要传递给线程的信息
	std::string _name;	// 线程名称
	pthread_t _tid;		// 线程ID
	func_t _func;		// 线程函数
};

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46

注意，这里只是简单地实现了线程类的框架，稍后还要补充其他内容。它的实现在Thread.hpp中实现。

这里的name()接口稍后会有用，实际上它是后补的，在这里就先给出了。

封装线程池

在ThreadPool.hpp中实现线程池的框架，线程池的本质是一个生产者消费者模型。

线程池的作用是等待任务的派发，所以要在任务执行之前将线程保存起来。在这里可以使用容器vector保存线程，有了线程还不够，所以也要将任务保存起来，在这里使用queue容器保存任务。

  • 构造函数：调用Thread的构造函数，创建线程，创建的线程
  • 析构函数：回收线程的资源。

除了构造函数和析构函数以外， 最重要的两个接口是run()和pushTask()，分别代表线程执行任务和任务入队（等待被执行）。

#pragma once

#include "Thread.hpp"
#include <vector>
#include <queue>

#define THREAD_NUM 5
template<class T>
class ThreadPool
{
public:
	ThreadPool(int thread_num = THREAD_NUM)
	: _num(thread_num)
	{
		for(int i = 1; i <= _num; i++)
		{
			// 参数列表对应着Thread的构造函数
			_threads.push_back(new Thread(i, /*线程函数*/, nullptr));
		}
	}
	~ThreadPool()
	{
		for(auto& it : _threads)
		{
			it->join();
			delete it;
		}
	}
	// 线程执行任务
	void run()
	{
		for(auto& it : _threads)
		{
			it->start();
			std::cout << "线程开始执行任务" << std::endl;
		}
	}
	// 将任务入队列
	void pushTask(const T& task)
	{
		_task_queue.push(task);
	}
private:
	std::vector<Thread*> _threads;		// 保存线程的数组
	std::queue<T> _task_queue;			// 保存任务的队列
	int _num;							// 线程的个数
};

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 构造函数中使用new创建线程时，参数列表和Thread对应。但是此时还未实现线程函数，和传递给线程的参数，因此后面两个参数是暂时不确定的。

线程函数

在这里暂时用打印语句代替线程要执行的任务：

// 线程函数
static void* routine(void* args)
{
    ThreadData *td = (ThreadData*)args;
    while(1)
    {
        std::cout << td->_name << std::endl;
        sleep(1);
    }
}

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10

注意：这个线程函数中可能会使用到线程池ThreadPool中的成员（虽然在本例没有使用），所以把它定义在类的内部。但是这样可能会出现一些问题：类成员函数的第一个参数实际上是对象的this指针，它是隐藏的，因此在编译时可能会出现参数列表不匹配的问题。

可能出现的报错信息：

ThreadPool.hpp: In instantiation of 'ThreadPool<T>::ThreadPool(int) [with T = int]':
ProdCon.cc:6:44:   required from here
ThreadPool.hpp:20:61: error: no matching function for call to 'Thread::Thread(int&, <unresolved overloaded function type>, void*)'
    _threads.push_back(new Thread(i, routine, (void*)nullptr));

  • 1
  • 2
  • 3
  • 4

解决办法是用static修饰，这样就没有this指针了。实际上可以写在类的外部，这取决于测试环境。

生产消费逻辑

在ThreadPood.hpp在可以定义一个临时的测试函数：

// 测试
void joins()
{
    for(auto& it : _threads)
    {
        it->join();
    }
}

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

main函数启动的线程就是主线程，主线程的作用一般是指派任务给其他线程。在主线程中new一个线程池对象，在对象实例化时，ThreadPool类构造函数会被调用，接着会调用Thread类的构造函数。

#include "ThreadPool.hpp"

// 主线程
int main()
{
	ThreadPool<int>* tp = new ThreadPool<int>();
	tp->run();
	tp->joins();
	// while(1)
	// {
	// 	// 分配任务...
	// }
	
	return 0;
}

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15

在这里只是测试之前的代码有没有问题，只是实现了主线程框架。其中被注释的while代码块中，就是分配任务的逻辑。

测试结果：
在这里插入图片描述

这个结果基本说明前面的代码在逻辑上没什么问题，最可能出现问题的地方就是刚才提到的staticroutine()函数。

互斥锁

上面只是实现了简单的线程池，但是多个执行流并发操作并不是安全的，因此要限制在同一时间段内只有一个执行流能访问临界资源。

在线程池中，哪一部分是临界资源？

临界资源是被所有执行流共享的，在线程池中，每个线程都会从队列中取出数据或任务，因此这个存储数据或任务的队列中的空间对于所有执行流来说是临界资源。

下面将pthread库中的锁的操作用一个类Mutex简单地封装起来，它将被定义在LockGuard.hpp中。

#pragma once

#include <iostream>
#include <pthread.h>
#include <string>

class Mutex
{
public:
    Mutex(pthread_mutex_t* mtx)
    : _pmtx(mtx)
    {}
    void lock() 
    {
        pthread_mutex_lock(_pmtx);
    }
    void unlock()
    {
        pthread_mutex_unlock(_pmtx);
    }
    ~Mutex()
    {}
private:
    pthread_mutex_t* _pmtx;
};

class LockGuard
{
public:
    LockGuard(pthread_mutex_t* mtx)
    : _mtx(mtx)
    {
        _mtx.lock();
        std::cout <<"---加锁---" << std::endl;
    }
    ~LockGuard()
    {
        _mtx.unlock();
        std::cout << "---解锁---" << std::endl;
    }
private:
    Mutex _mtx;
};

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43

为了方便观察现象，在加解锁的逻辑中增加了打印语句，以作提示。

这种将资源的初始化/销毁操作分别交给构造函数和析构函数的做法是常见的，它被称为RAII（Resource Acquisition Is Initialization，资源获取即初始化）。因为局部对象在创建时会调用构造函数，出了作用域以后会调用析构函数，它是一种半自动化的操作，这种编码规范能减少出现内存泄漏、死锁等问题。

条件变量

单纯的加锁只会拖慢速度，互斥锁常常与条件变量协同作用，所以可以设置一个条件变量，表征队列中的任务或数据条件（也就是有没有）是否就绪。条件变量也可以和锁一样，用RAII实现，不过下面为了有所区别，直接用条件变量的相关接口实现。

下面是增加了互斥锁和条件变量的线程池代码：

#define THREAD_NUM 5
template<class T>
class ThreadPool
{
public:
	void waitCond()
	{
		pthread_cond_wait(&_cond, &_lock);
	}
	pthread_mutex_t* getMutex()
	{
		return &_lock;
	}
	T getTask()
	{
		T t = _task_queue.front();
		_task_queue.pop();
		return t;
	}
	bool empty()
	{
		return _task_queue.empty();
	}
	// 测试
	void joins()
	{
		for(auto& it : _threads)
		{
			it->join();
		}
	}
public:
	ThreadPool(int thread_num = THREAD_NUM)
	: _num(thread_num)
	{
		pthread_mutex_init(&_lock, nullptr);
		pthread_cond_init(&_cond, nullptr);
		for(int i = 1; i <= _num; i++)
		{
			// 参数列表对应着Thread的构造函数
			_threads.push_back(new Thread(i, routine, (void*)nullptr));
		}
	}
	~ThreadPool()
	{
		for(auto& it : _threads)
		{
			it->join();
			delete it;
		}
		pthread_mutex_destroy(&_lock);
		pthread_cond_destroy(&_cond);
	}
	// 线程执行任务
	void run()
	{
		for(auto& it : _threads)
		{
			it->start();
			std::cout << "线程开始执行任务" << std::endl;
		}
	}
	// 将任务入队列
	void pushTask(const T& task)
	{
		LockGuard LockGuard(&_lock);
		_task_queue.push(task);
		pthread_cond_signal(&_cond);
	}
	// 线程函数
    static void* routine(void* args)
    {
        ThreadData *td = (ThreadData*)args;
        while(1)
        {
            std::cout << td->_name << std::endl;
            sleep(1);
        }
    }
private:
	std::vector<Thread*> _threads;		// 保存线程的数组
	std::queue<T> _task_queue;			// 保存任务的队列
	int _num;							// 线程的个数
	pthread_mutex_t _lock;				// 互斥锁
	pthread_cond_t  _cond;				// 条件变量
};

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86

除了加解锁逻辑之外，在pushTask()函数中，生产完毕以后至少要唤醒一个线程，所以使用signal接口，如果要唤醒多个线程，可以用board接口唤醒。

由于线程函数被static修饰，那么它是属于所有对象的，因此它不能访问类的普通成员，解决这个问题有两种办法：

  1. 将要访问的成员也设置为static，但是这样做会改变成员变量的属性，可能会出现问题。
  2. 对外开放get方法，这是封装常用的做法。

因此上面顺便封装了waitCond()和empty()配合条件变量使用，以及getMutex()和getTask()，以获取锁的地址和将生产的任务放入队列中。（实际上这个操作应该在下面完成）

线程函数

线程函数routine就是一个消费过程，但是在这里是存在问题的。由于刚才我们用static修饰了它，那么这个静态函数是属于所有成员的，那么它就不能使用类内部的成员属性和方法，如_task_queue。无法读取任务队列，拿不到队列也就无法消费。

这是由于C++的语法限制的，是C++和C在系统编程上的区别。

【拾遗】C++的构造函数中是能够传入this指针的。

得到this指针的前提不应该是对象被实例化之后才能获取的吗？

构造函数分为两部分：

  1. 在初始化列表中申请空间；
  2. 在代码块中赋值。

也就是说，在{}之外就已经完成内存空间的申请了，对象的起始地址在此时就已经能取到了。所以将Thread对象本身作为信息传输给线程，那么构造线程时的最后一个参数可以改成this指针：

_threads.push_back(new Thread(i, routine, this));

  • 1

下面是线程函数中的逻辑：
在Thread类中封装了创建线程的接口，还封装了一个ThreadData的成员变量，它在线程被创建时会被作为参数传入给线程。在线程内部，只要将接收到的void*类型的参数args强转回原来的类型，就能取出线程信息。

信息在线程被创建时被封装了两层，取出信息的过程也要从两个对象中取出。信息中包含了线程池中的互斥锁的地址（它是被所有相关线程共享的），这个接口在上面已经报封装为getMutex()，包括条件变量等接口：

	// 线程函数
	static void* routine(void* args)
	{
		ThreadData *td = (ThreadData*)args;
		ThreadPool<T>* tp = (ThreadPool<T>*)td->_args;
		
		while(1)
		{
			T task;
			{
				LockGuard LockGuard(tp->getMutex());
				while(tp->empty())
				{
					tp->waitCond();
				}
				// 读取任务
				task = tp->getTask(); // 任务[共享空间]->获取[私有空间]
			}
            std:: cout << "消费者" << td->_name;
			task(); // 执行任务
		}
	}

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22

注意事项：

  • 首先要将参数args强转，才能调用对象的接口。
  • while(1)表示消费者不断地消费，也就是不断地从队列中取出任务，然后执行任务。
  • 由于任务队列对于所有线程而言是临界资源，因此要在访问临界资源之前加锁。
  • 用while([队列为空])配合条件变量，表征临界资源是否就绪，否则让线程挂起。
  • 通过getTask()接口获取队列（头部）中的任务，取出的实际上是任务函数的地址，所以最要通过操作符()执行该地址处的函数。

值得注意的是，这里用一堆{}限定了互斥锁的有效范围：

{
    LockGuard LockGuard(tp->getMutex());
    // ...
}

  • 1
  • 2
  • 3
  • 4

主线程

主线程的作用是分配任务，在这里可以简单地用加减操作作为任务，它将被定义在Task.hpp中：

#pragma once

#include <iostream>
#include <functional>
#define SOL_NUM 2

typedef std::function<int(int, int)> func_t;

int Add(int x, int y)
{
	return x + y;
}
int Sub(int x, int y)
{
	return x - y;
}

func_t sol[SOL_NUM] = {Add, Sub};

class Task
{
public:
	Task(){}
	Task(int x, int y, func_t func)
	: _x(x)
	, _y(y)
	, _func(func)
	{}
	int operator()()
	{
		int res = _func(_x, _y);
		std::cout << "结果是: " << res << std::endl;
	}
public:
	int _x;
	int _y;
	
	func_t _func;
};

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39

在主线程中，可以用Task类创建任务。用一个值域为0或1，表示sol[0]或sol[1]，以选择加法或减法。同时用随机数定义两个操作数，传入函数中，这样就完成了任务的生产，将Task对象存入任务队列中。

#include <iostream>
#include "ThreadPool.hpp"
#include "Task.hpp"
#include <sys/types.h>

// 主线程
int opt = -1;
int main()
{
	srand((unsigned long)time(nullptr) ^ getpid() ^ 0x3f3f3f3f);
	ThreadPool<Task>* tp = new ThreadPool<Task>(); // 创建线程池对象
	tp->run();	// 创建线程
	while(1)
	{
		opt = rand() % 2;
		int x = rand() % 10 + 1;
		int y = rand() % 5 + 1;
		Task task(x, y, sol[opt]);
		// 将任务放到线程池中
		tp->pushTask(task); 

		if(opt) std::cout << "生产者线程: " << x << "-" << y << "= _?_" << std::endl;
		else 	std::cout << "生产者线程: " << x << "+" << y << "= _?_" << std::endl;

		sleep(1);
	}

	return 0;
}

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29

测试1

源代码

测试结果：

在这里插入图片描述

这里的任务函数如果只是为了测试，也可以不用在一个新文件中定义任务函数，直接在主线程内使用lambda表达式也可以：

Task task(x, y, [](int x, int y)->int
{
	return x + y;
 });

  • 1
  • 2
  • 3
  • 4

此处为了更清楚地显示结果，将加解锁的提示语句注释了。而且通过sleep限制了主线程和线程池中的线程生产和消费的速度。

4. 优化

可以用两个队列，分别属于生产者和消费者。当生产者生产任务的任务把其中一个队列存满以后，直接将这个满的队列中的所有任务通过swap，放到消费者的队列中，这样生产者和消费者就能更关注自己的队列。而消费者就不用自己从任务队列中取出任务，然后执行了，这个操作是由程序员完成的。

原来的临界资源是任务队列，在对它操作的整个过程中都需要线程持有锁，但是现在消费者和生产者都有自己的队列，我们知道加锁会降低效率，这样的话也会拖慢整体执行任务的速度，但是优化以后只要对swap操作加锁即可。而swap恰好是消费者取出任务的操作，这就将锁限制的粒度进一步缩到最小，以提高整体效率。

5. 日志

日志的重要性

在学习过程中，我们经常使用打印语句打印提示信息，虽然“打印大法”在很多时候很有用，但产品始终是面向用户的，因此提示信息既要使用用户看得到的话呈现，又要将错误信息保存起来，以供开发者修复。日志信息通常保存在日志文件中，它的文件后缀是.log

日志文件是用于记录系统操作事件的记录文件或文件集合，可分为事件日志和消息日志。它具有处理历史数据、诊断问题的追踪以及理解系统的活动等重要作用。日志文件中的记录可提供以下用途：监控系统资源；审计用户行为；对可疑行为进行告普；确定入侵行为的范围；为恢复系统提供帮助；生成调查报告等等。

实现

使用上面的例子来实现日志信息的生成，它将在log.hpp文件中被实现。

日志的设计可以根据需要，但是日志需要实现最基本的功能：日志等级、日期和时间、内容，以及支持用户自定义等（可以使用可变参数实现用户自定义的日志信息）。

日志级别

根据日志的重要性，赋予日志以优先级，以保证重要的问题最先被处理。

#define DEBUG   0
#define NORMAL  1
#define WARNING 2
#define ERROR   3
#define FATAL   4
const char* LevelMap[] = 
{
    "DEBUG",
    "NORMAL",
    "WARNING",
    "ERROR",
    "FATAL"
};

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13

通过不同数值的宏表示日志的等级，其中：

  • 值为0的宏DEBUG是用于调试的日志，仅用于调试，在产品发布时可以删除它。
  • NORMAL：日常日志。
  • WARNING：告警日志。
  • ERROR：错误但不影响任务执行。
  • FATAL：致命错误。

用一个数组LevelMap[]保存这些宏，以便使用，且下标和它们的值对应。

提取参数

首先介绍一下可变参数，在C语言中，常用的函数printf就是可变参数，它的参数可以任意长。main函数也是可变参数：

int main (int argc, const char * argv[])
{}
// argc表示参数的个数, 数组argv保存参数

  • 1
  • 2
  • 3
stdarg.h 头文件

stdarg 是由 standard（标准） arguments（参数）简化而来，主要目的是让函数能够接收可变参数。它定义了一个变量类型 va_list 和三个宏，这三个宏可用于在参数个数未知（即参数个数可变）时获取函数中的参数。

这3个宏分别是：

  • va_start 宏初始化 va_list 类型的变量，它与 va_arg 和 va_end 宏一起使用。这个宏必须在使用 va_arg 和 va_end 之前被调用。
  • va_arg 宏检索函数参数列表中类型为 type 的下一个参数。
  • va_end 宏允许使用了 va_start 宏的带有可变参数的函数返回。如果在从函数返回之前没有调用 va_end，则结果为未定义。

用例：

当然可以。下面是一个简单的例子，它演示了如何使用 stdarg.h 头文件中的宏来定义一个接受可变数量参数的函数。这个函数计算传递给它的所有整数参数的平均值。

#include <stdio.h>
#include <stdarg.h>

double average(int count, ...) 
{
    va_list args;
    va_start(args, count);

    double sum = 0;
    for (int i = 0; i < count; i++) 
    {
        sum += va_arg(args, int);
    }
    va_end(args);

    return sum / count;
}

int main() 
{
    printf("Average of 2, 3, 4, 5 = %f\n", average(4, 2, 3, 4, 5));
    printf("Average of 5, 10, 15 = %f\n", average(3, 5, 10, 15));
}


  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24

在上面的代码中，我们定义了一个名为 average 的函数，它接受一个名为 count 的参数，表示可变参数的数量，后面跟着 count 个整数参数。我们使用 va_start 宏初始化 va_list 类型的变量 args，然后使用 va_arg 宏在循环中检索每个参数。最后，我们使用 va_end 宏结束可变参数的处理。

当我们运行上面的代码时，它会输出以下内容：

Average of 2, 3, 4, 5 = 3.500000
Average of 5, 10, 15 = 10.000000

  • 1
  • 2

实际上，它们是一个char*类型的指针，指向的是参数在栈帧中的位置，本质上是宏。例如va_start将第一个参数指向第二个参数。

这些宏可以配合stdio中的vprintf函数族使用。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-2DX21fsg-1682520228561)(IMG/image-20230426172250722.png)]

例如vsnprintf 是一个标准库函数，它在 stdio.h 头文件中定义。它与 snprintf 函数类似，但接受一个 va_list 类型的参数，而不是可变数量的参数。

vsnprintf 函数用于将格式化输出写入字符串。它接受一个目标缓冲区、缓冲区大小、格式字符串和一个 va_list 类型的参数。它会根据格式字符串和 va_list 中的参数将格式化输出写入目标缓冲区，最多写入 size - 1 个字符，然后在末尾添加一个空字符。

下面是一个简单的例子，演示了如何使用 vsnprintf 函数：

#include <stdio.h>
#include <stdarg.h>

void format_string(char *buffer, size_t size, const char *format, ...) {
    va_list args;
    va_start(args, format);
    vsnprintf(buffer, size, format, args);
    va_end(args);
}

int main() {
    char buffer[100];
    format_string(buffer, sizeof(buffer), "Hello, %s!", "world");
    printf("%s\n", buffer);
}

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15

在上面的代码中，我们定义了一个名为 format_string 的函数，它接受一个目标缓冲区、缓冲区大小、格式字符串和可变数量的参数。我们使用 va_start 宏初始化 va_list 类型的变量 args，然后将其传递给 vsnprintf 函数。最后，我们使用 va_end 宏结束可变参数的处理。

当我们运行上面的代码时，它会输出以下内容：

Hello, world!

  • 1
日志文件

下面使用文件接口，将日志信息写入到ThreadPool.log日志文件中：

#pragma once

#include <iostream>
#include <cstdarg>
#include <ctime>
#include <string>

// 日志级别
#define DEBUG   0
#define NORMAL  1
#define WARNING 2
#define ERROR   3
#define FATAL   4

const char *LevelMap[] = 
{
    "DEBUG",
    "NORMAL",
    "WARNING",
    "ERROR",
    "FATAL"
};


#define LOGFILE "./ThreadPool.log"


void logMessage(int level, const char *format, ...)
{

#ifndef DEBUG_SHOW
    if(level == DEBUG) return;
#endif

    char stdBuffer[1024]; // 标准部分(一定要有的)
    time_t timestamp = time(nullptr); // 时间
    snprintf(stdBuffer, sizeof stdBuffer, "[%s] [%ld] ", LevelMap[level], timestamp);

    char logBuffer[1024]; // 自定义部分(因需求)
    va_list args;
    va_start(args, format);
    vsnprintf(logBuffer, sizeof logBuffer, format, args);
    va_end(args);

    FILE *fp = fopen(LOGFILE, "a");
    fprintf(fp, "%s%s\n", stdBuffer, logBuffer);
    
    fclose(fp);
}

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49

其中，这是一个预处理命令，DEBUG_SHOW是编译选项，例如g++ ... -DDEBUG_SHOW，就会启用这个日志文件重程序，否则不会执行。

#ifndef DEBUG_SHOW
    if(level == DEBUG) return;
#endif

  • 1
  • 2
  • 3

现在有了记录日志的逻辑，就可以使用它来程序主体中使用：

源文件(有日志版本)

ThreadPool.log的一部分：

[NORMAL] [1682508157] Thread:[1] 启动成功
[NORMAL] [1682508157] Thread:[2] 启动成功
[NORMAL] [1682508157] Thread:[3] 启动成功
[NORMAL] [1682508157] Thread:[4] 启动成功
[NORMAL] [1682508157] Thread:[5] 启动成功
[WARNING] [1682508157] Thread:[1]处理完成: 2+2=4 | Task.hpp | 35
[WARNING] [1682508158] Thread:[1]处理完成: 6+3=9 | Task.hpp | 35
[WARNING] [1682508159] Thread:[2]处理完成: 5+4=9 | Task.hpp | 35

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

懒汉实现单例模式

什么是懒汉模式

懒汉模式是一种实现单例模式的方法，它在第一次使用单例实例时才创建该实例。这种方法的优点是可以延迟单例实例的创建，直到真正需要它为止。

下面是一个简单的示例，演示了如何使用懒汉模式来实现单例模式：

#include <mutex>

class Singleton {
public:
    static Singleton& getInstance() {
        std::call_once(flag, [] { instance = new Singleton(); });
        return *instance;
    }

private:
    Singleton() {}
    static Singleton *instance;
    static std::once_flag flag;
};

Singleton *Singleton::instance = nullptr;
std::once_flag Singleton::flag;

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17

在上面的代码中，我们定义了一个名为 Singleton 的类，它包含一个静态成员函数 getInstance 来返回单例实例。我们使用一个静态成员变量 instance 来存储单例实例，并使用一个静态成员变量 flag 来保证只创建一个实例。

在 getInstance 函数中，我们使用 std::call_once 函数来保证只调用一次 lambda 表达式来创建 Singleton 实例。这样可以确保只创建一个单例实例，即使在多线程环境中也是如此。

这种方法可以实现懒汉模式，即在第一次使用单例实例时才创建该实例。

什么是单例模式

简单介绍一下单例模式：

单例模式是一种常用的软件设计模式，它用于限制一个类只能创建一个实例，并提供一个全局访问点来访问这个实例。这种模式通常用于管理共享资源，例如数据库连接或线程池。

在多线程环境中，实现单例模式需要特别注意，因为多个线程可能会同时尝试创建单例实例。如果没有正确地同步这些线程，可能会导致创建多个实例，从而破坏单例模式的目的。

有几种方法可以在多线程环境中安全地实现单例模式。一种常用的方法是使用双重检查锁定（Double-Checked Locking）模式。这种方法使用一个锁来保护对单例实例的访问，并在创建实例之前检查两次实例是否已经存在。这样可以确保只有一个线程能够创建单例实例，并且其他线程在访问实例时不会被阻塞。

下面是一个简单的示例，演示了如何在多线程环境中使用双重检查锁定模式来实现单例模式：

#include <mutex>

class Singleton 
{
public:
    static Singleton& getInstance() 
    {
        if (instance == nullptr) 
        {
            std::lock_guard<std::mutex> lock(mutex);
            if (instance == nullptr) 
            {
                instance = new Singleton();
            }
        }
        return *instance;
    }

private:
    Singleton() 
    {}
    static Singleton *instance;
    static std::mutex mutex;
};

Singleton *Singleton::instance = nullptr;
std::mutex Singleton::mutex;

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27

在上面的代码中，我们定义了一个名为 Singleton 的类，它包含一个静态成员函数 getInstance 来返回单例实例。我们使用一个静态成员变量 instance 来存储单例实例，并使用一个静态成员变量 mutex 来保护对 instance 的访问。

在 getInstance 函数中，我们首先检查 instance 是否为 nullptr。如果是，则获取锁并再次检查 instance 是否为 nullptr。如果仍然是，则创建一个新的 Singleton 实例并将其赋值给 instance。最后，我们返回对 instance 的引用。

这种方法可以确保在多线程环境中安全地创建和访问单例实例。

为什么要限制它的成员函数？

在单例模式中，我们通常会限制类的构造函数、拷贝构造函数和赋值运算符，以防止外部代码创建多个实例或复制单例实例。

例如，在上一个示例中，我们将 Singleton 类的构造函数声明为私有，以防止外部代码直接创建 Singleton 实例。我们还可以将拷贝构造函数和赋值运算符声明为删除，以防止外部代码复制或赋值 Singleton 实例：

class Singleton 
{
public:
    static Singleton& getInstance() 
    {
        // ...
    }

private:
    Singleton() 
    {}
    Singleton(const Singleton&) = delete;
    Singleton& operator=(const Singleton&) = delete;

    // ...
};

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16

在上面的代码中，我们将拷贝构造函数和赋值运算符声明为删除，这意味着外部代码不能复制或赋值 Singleton 实例。

限制这些成员函数的目的是确保单例模式的正确性。如果我们允许外部代码创建多个实例或复制单例实例，那么单例模式就失去了意义。

为什么成员变量要设置为静态？

在单例模式的示例中，我们使用了一个静态的互斥锁来保护对单例实例的访问。这个锁是静态的，因为它需要在整个程序运行期间存在，并且需要在所有线程之间共享。

如果锁不是静态的，那么每个 Singleton 实例都会有自己的锁。但是，在单例模式中，我们只允许创建一个 Singleton 实例，因此只需要一个锁来保护对这个实例的访问。此外，由于 Singleton 类的构造函数是私有的，外部代码无法创建 Singleton 实例，因此也无法创建非静态锁。

实现

为了演示的简单，上例用C++内置Mutex库实现单例模式，下面仍然使用pthread库中的接口。

首先， 在ThreadPool类中增加两个成员变量，并且使用static修饰：

static ThreadPool<T> *thread_ptr;
static pthread_mutex_t mutex;

  • 1
  • 2
  • thread_ptr的作用：保存对象的地址；
  • mutex的作用：定义全局的互斥锁对象。

由于要实现单例模式，这个指针一定不能是属于某个类私有的，要是属于全局的（这里的全局指的是所有线程中），因此这个指针要设置为静态的，这样它就被线程池中所有线程共享。互斥锁也是类似的，稍后会解释它的具体作用。

既然互斥锁和单例对象的指针都是静态的，那么它们的初始值必须在类的外部赋值：

template <typename T>
ThreadPool<T> *ThreadPool<T>::thread_ptr = nullptr;

template <typename T>
pthread_mutex_t ThreadPool<T>::mutex = PTHREAD_MUTEX_INITIALIZER;

  • 1
  • 2
  • 3
  • 4
  • 5

同时，要将所有能构造对象的函数都设置为私有的（具体原因已经介绍了），将原先的构造函数设置为private，将拷贝构造函数和赋值运算符重载函数设置为delete，告诉编译器不要生成：

ThreadPool(const ThreadPool<T> &other) = delete;
const ThreadPool<T> &operator=(const ThreadPool<T> &other) = delete;

  • 1
  • 2

现在，在主线程中（main函数）就不能通过new来构造线程池了，所以可以封装一个get接口：

public:
	static ThreadPool<T> *getThreadPool(int num = THREAD_NUM)
    {
        if (nullptr == thread_ptr)
        {
            thread_ptr = new ThreadPool<T>(num);
        }
        return thread_ptr;
    }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9

注意，这个get函数是有问题的。

同样地，将它设置为静态成员，那么返回给任何一个线程的指针就是同一个对象的地址，同时静态成员函数才能访问类的静态成员变量。

在主函数中，获取单例对象的地址就不能使用new了，由于上面的get函数是静态的，静态成员函数属于类，因此可以用::调用它：

ThreadPool<Task> *tp = ThreadPool<Task>::getThreadPool(); // 获取单例对象
tp->run();	// 创建线程
// ...
tp->pushTask(task); // 生成任务

  • 1
  • 2
  • 3
  • 4

下面生产消费逻辑是不变的。

实际上常用的操作是这样的：

ThreadPool<Task>::getThreadPool()->run();
// ...
ThreadPool<Task>::getThreadPool()->pushTask(task);

  • 1
  • 2
  • 3

虽然麻烦一点，但是这样做反而更清晰了一些，反正调用的是同一个对象的成员函数。

单例对象在执行任务中，只有一个，假如有多个执行流都在申请使用这同一个对象呢？

多线程使用单例，也就是多个线程会在它们自己的线程函数中调用getThreadPool接口。可能会出现多个线程同时new的情况，所以可能会因为多线程创建多个单例对象，这就不单例了，也就不线程安全了。因此上面写的getThreadPool的逻辑如果不加锁的话，就不是线程安全的。加个锁？

static ThreadPool<T> *getThreadPool(int num = THREAD_NUM)
{
    {
        LockGuard Lockguard(&mutex);
        if (thread_ptr == nullptr)
        {
            thread_ptr = new ThreadPool<T>(num);
        }
    }
    return thread_ptr;
}

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11

注意被{}划定的范围，它是互斥锁对象Lockguard的作用域，限制了它的生命周期。

请注意，需要被互斥锁限制的操作只有new线程池对象的时候。实际上以后任何一个线程想获取单例，都必须调用getThreadPool接口。但是只有第一次new的时候才可能出现隐患。但是以后这个指针就不为空了，加解锁中什么都没做，存在大量申请和释放锁的行为，无用且浪费资源的。因为除了第一次之外，资源已经安全了

所以在外部再增加一个判断：

static ThreadPool<T> *getThreadPool(int num = THREAD_NUM)
{
    if (thread_ptr == nullptr) 
    {
        LockGuard Lockguard(&mutex);
        if (thread_ptr == nullptr)
        {
            thread_ptr = new ThreadPool<T>(num);
        }
    }
    return thread_ptr;
}

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12

这个判断操作非常巧妙，虽然从代码上看它俩长得一样，但是作用却不同。最外层的if语句直接限制了线程申请互斥锁，除了第一次以外，所有线程都会被第一个if判断过滤。

源代码(单例模式-线程安全版本)

注意上面的等号不要写成赋值符号，本笨b被它搞了1个小时…
学到一个实用的调试技巧，这也是将不同逻辑写在不同文件中，模块化地层层调用接口，使mai()简洁的好处：
就是每次只开放一小部分语句，注释掉其他的。看是否运行或编译出现问题，不断缩小范围。要是main函数中的逻辑很复杂的话，还是蛮难查错的。
这就好像一个树状的执行流程，在main函数中的某个语句只会执行某个文件中的语句。

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/羊村懒王/article/detail/621772
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号