设计模式第三节-观察者模式

前言

由于设计模式章节将贴出大量伪代码，为了压缩代码长度方便大家查看，因此代码段中与设计模式无关的代码，如构造函数、或是成员函数public、private、protect属性等均未写出。文章中若有说明不清晰或是有歧义、错误的地方欢迎大家评论指正，谢谢大家。

---

一、定义

观察者（Observer）模式的定义：指多个对象间存在一对多的依赖关系，当一个对象的状态发生改变时，所有依赖于它的对象都得到通知并被自动更新。这种模式有时又称作发布-订阅模式、模型-视图模式，它是对象行为型模式。

---

二、要素

观察者模式的四种角色
a)Subject（主题）：观察目标
b)ConcreteSubject（具体主题）
c)Observer（观察者）
d)ConcreteObserver(具体观察者）

---

三、一个适用观察者模式的场景

众所周知，在各类网游中，都会出现公会系统（或帮派、联盟等）。公会系统中的聊天频道就是一个典型的适用于观察者模式的场景。多名玩家加入到同一个公会中，当一名公会中的玩家a在公会频道发言时，处于公会中的其它成员将会看到玩家a的发言。

在这个场景中，玩家就扮演着观察者的角色，而公会的聊天频道就是主题。下面我们将这个场景使用观察者模式进行实现。

---

四、使用观察者模式实现公会聊天频道

1、代码功能设计

在该场景下设计如下几个类
1）玩家父类Fighter
战士玩家F_Warrior
法师玩家F_Mage
2）通知器父类Notifier
聊天信息通知器TalkNotifier
玩家父类和通知器父类抽象了真个观察者模式架构，其它类为具体实现。当新增一个玩家时，设置玩家的公会id，然后将玩家加入到通知器中；当一个玩家需要在公会发言时，将信息发送给通知器，通知器会便利内部的玩家列表，向列表中所有和发言玩家公会id相同的玩家发送该消息，实现广播的效果。

//创建游戏玩家
	Fighter* pplayerobj1 = new F_Warrior(10, "张三"); //实际游戏中很多数据取自数据库。
	pplayerobj1->SetFamilyID(100); //假设该玩家所在的家族的家族ID是100
	
	Fighter* pplayerobj2 = new F_Warrior(20, "李四");
	pplayerobj2->SetFamilyID(100);
	
	Fighter* pplayerobj3 = new F_Mage(30, "王五");
	pplayerobj3->SetFamilyID(100);
	
	Fighter* pplayerobj4 = new F_Mage(50, "赵六");
	pplayerobj4->SetFamilyID(200); //赵六和前面三人属于两个不同的家族
	
	//创建通知器
	Notifier* ptalknotify = new TalkNotifier();

	//玩家增加到家族列表中来，这样才能收到家族聊天信息
	ptalknotify->addToList(pplayerobj1);
	ptalknotify->addToList(pplayerobj2);
	ptalknotify->addToList(pplayerobj3);
	ptalknotify->addToList(pplayerobj4);

	//某游戏玩家聊天，同族人都应该收到该信息
	pplayerobj1->SayWords("全族人立即到沼泽地集结，准备进攻！", ptalknotify);

	cout << "王五不想再收到家族其他成员的聊天信息了---" << endl;
	ptalknotify->removeFromList(pplayerobj3); //将王五从家族列表中删除
	pplayerobj2->SayWords("请大家听从族长调遣，前往沼泽地！", ptalknotify);

	//释放资源
	delete pplayerobj1;
	delete pplayerobj2;
	delete pplayerobj3;
	delete pplayerobj4;
	delete ptalknotify;

2、玩家类的实现

//玩家父类
class Fighter
{
public:
	Fighter(int tmpID, string tmpName) :m_iPlayerID(tmpID), m_sPlayerName(tmpName) //构造函数
	{
		m_iFamilyID = -1; //-1表示没有加入任何家族
	}
	virtual ~Fighter() {} //析构函数

public:
	void SetFamilyID(int tmpID) //加入家族的时候要设置家族ID
	{
		m_iFamilyID = tmpID;
	}
	int GetFamilyID() //获取家族ID
	{
		return m_iFamilyID;
	}

public:
	void SayWords(string tmpContent,Notifier *notifier) //玩家说了某句话
	{
		notifier->notify(this, tmpContent);
	}

	//通知该玩家接收到其他玩家发送来的聊天信息，虚函数，子类可以覆盖以实现不同的功能
	virtual void NotifyWords(Fighter* talker, string tmpContent)
	{
		//显示信息
		cout << "玩家：" << m_sPlayerName << "收到了玩家：" << talker->m_sPlayerName << " 发送的聊天信息：" << tmpContent << endl;
	}

private:
	int m_iPlayerID;  //玩家ID，全局唯一
	string m_sPlayerName; //玩家名字
	int m_iFamilyID;  //家族ID
};

//"战士"类玩家，父类为Fighter
class F_Warrior :public Fighter
{
public:
	F_Warrior(int tmpID, string tmpName) :Fighter(tmpID, tmpName) {} //构造函数
};

//"法师"类玩家，父类为Fighter
class F_Mage :public Fighter
{
public:
	F_Mage(int tmpID, string tmpName) :Fighter(tmpID, tmpName) {} //构造函数
};

3、公会频道类的实现

class Fighter; //类前向声明
class Notifier //通知器父类
{
public:
	virtual void addToList(Fighter* player) = 0; //把要被通知的玩家加入到列表中
	virtual void removeFromList(Fighter* player) = 0; //把不想被通知的玩家从列表中去除
	virtual void notify(Fighter* talker, string tmpContent) = 0; //通知的一些细节信息
	virtual ~Notifier() {}
};

//聊天信息通知器
class TalkNotifier :public Notifier
{
public:
	//将玩家增加到家族列表中来
	virtual void addToList(Fighter* player)
	{
		int tmpfamilyid = player->GetFamilyID();
		if (tmpfamilyid != -1) //加入了某个家族
		{
			auto iter = m_familyList.find(tmpfamilyid);
			if (iter != m_familyList.end())
			{
				//该家族id在map中已经存在
				iter->second.push_back(player); //直接把该玩家加入到该家族
			}
			else
			{
				//该家族id在map中不存在
				list<Fighter*> tmpplayerlist;
				m_familyList.insert(make_pair(tmpfamilyid, tmpplayerlist)); //以该家族id为key，增加条目到map中
				m_familyList[tmpfamilyid].push_back(player); //向该家族中增加第一个玩家
			}
		}
	}
	//将玩家从家族列表中删除
	virtual void removeFromList(Fighter* player)
	{
		int tmpfamilyid = player->GetFamilyID();
		if (tmpfamilyid != -1) //加入了某个家族
		{
			auto iter = m_familyList.find(tmpfamilyid);
			if (iter != m_familyList.end())
			{
				m_familyList[tmpfamilyid].remove(player);
			}
		}
	}

	//家族中某玩家说了句话，调用该函数来通知家族中所有人
	virtual void notify(Fighter* talker, string tmpContent) //talker是讲话的玩家
	{
		int tmpfamilyid = talker->GetFamilyID();
		if (tmpfamilyid != -1) //加入了某个家族
		{
			auto itermap = m_familyList.find(tmpfamilyid);
			if (itermap != m_familyList.end())
			{
				//遍历该玩家所属家族的所有成员
				for (auto iterlist = itermap->second.begin(); iterlist != itermap->second.end(); ++iterlist)
				{
					(*iterlist)->NotifyWords(talker, tmpContent);
				}
			}
		}
	}

private:
	//map中的key表示家族id，value代表该家族中所有玩家列表
	map<int, list<Fighter*> > m_familyList;
};