观察者模式的理解和引用

1.前言

在之前的H5小游戏中，对于长连接发送的不同类型数据包的处理，是通过switch语句进行处理的，于是在自己的代码中出现了大量的case分支，不方便进行维护和后期的版本迭代。于是在老师的指导下，开始寻求使用观察者模式来解决case分支过多、代码冗余的问题。

H5小游戏介绍和代码仓库：基于WebSocket通信的H5小游戏总结-CSDN博客

2.旧代码

		//在信息中枢处根据消息类型进行特定的处理
		
		switch requestPkg.Type {
		case pojo.CertificationType:
			//用户认证
			client.CertificationProcess(requestPkg)

		case pojo.CreateRoomType:
			//创建房间号,并将创建者加入房间
			client.CreateRoomProcess()

		case pojo.JoinRoomType:
			//1.加入房间的前提,先建立连接
			//2.完成用户认证
			//3.发送消息类型和房间号 Type uuid
			//只有完成上述步骤,才可以加入房间
			var data map[string]interface{}
			err = json.Unmarshal([]byte(requestPkg.Data), &data)
			if err != nil {
				fmt.Println("解析 JSON 失败：", err)
				return
			}
			uuidValue, ok := data["uuid"].(string)
			if !ok {
				fmt.Println("uuid 字段不存在或不是字符串类型")
				return
			}
			client.JoinRoomProcess(uuidValue)

		case pojo.RefreshScoreType:
			//什么是否进行分数更新，前端判断 type:RefreshScoreType, data:step、step、score
			//当用户的行为触发前端游戏机制的更新时，前端调用此接口，后端进行分数的转发 不需要做业务处理，直接转发即可
			fmt.Println("游戏交换中数据", client)
			client.RefreshScoreProcess(requestPkg)

		case pojo.DiscontinueQuitType:
			client.DiscontinueQuitProcess()

		case pojo.GameOverType:
			//游戏结束类型好像没有太大用，游戏结束的时候的提醒，通过分数更新就可以实现了
			fmt.Println("GameOverType")

		case pojo.HeartCheckType:
			//开启一个协程遍历hub中的Client，进行健康检测，生命时间是否会过期，如果过期进行逻辑删除和关闭连接
			if requestPkg.Data == "PING" {
				client.HeartCheckProcess()
			}
		}

3.观察者模式的引入

观察者模式是使用频率最高的设计模式之一，用于建立对象与对象之间的依赖关系。一个对象发生改变时将自动通知其他对象，其他对象将响应做出反应。在观察者模式中，发生改变的对象称为观察目标，而被通知的对象称为观察者。一个观察目标可以对应多个观察者，而且这些观察者之间可以没有任何相互联系，可以根据需要增加和删除观察者，使得系统更易于扩展。

比如在我们的日常生活中，红灯停，绿灯行。在这句话描述的场景中，红绿灯是观察目标，即被观察者；而行人和车辆是观察者；红绿灯即观察目标的状态发生变动的时候，行人和车辆会接收到通知，调整自己的行为。这种建立一个红绿灯对象和多个行人车辆对象之间的依赖关系的模式就是观察者模式。

观察者模式结构中通常包括观察目标和观察者两个继承层次结构，具体结构如下图示意：

Subject是抽象观察目标，我们一般定义为抽象类或者接口，在里面我们规定观察目标应该具有的方法，添加观察者，删除观察者，通知观察者。

ConcreteSubject是具体观察目标，是我们抽象类或者接口的具体实现类，在里面我们定义观察目标方法的具体实现即如何添加观察者、删除观察者、通知观察者。

Observer是抽象观察者，同样地我们一般定义为抽象类或者接口，在里面我们规定观察者应该具有的方法，即观察目标发生变动后的行为，一般我们定义为Update()方法。

ConcreteObserver是具体观察对象，是我们抽象类或者接口的具体实现类，在里面我们定义观察者在观察目标的行为发生变动后，应该执行的具体逻辑代码。

4.观察者模式Demo

Demo的目录结构如下：

subject.go 这里我们定义观察目标接口，里面定义三个方法签名，添加、删除观察者和通知观察者

package subject

import "demo/TrafficLightsAndPedestrians/observer"

type Subject interface {
	AddPedestriansAndCars(buyer ...observer.Observer)
	RemovePedestriansAndCars(buyer observer.Observer)
	NotifyPedestriansAndCars(flag bool)
}

TrafficLights.go 观察目标的具体实现，这里我们模拟红绿灯的情景，因为是具体实现类，直接命名为TrafficLights。在这个类中我们实现了subject接口中定义的所有方法。

package impl

import (
	"demo/TrafficLightsAndPedestrians/observer"
	"fmt"
)

type TrafficLights struct {
	pedestriansAndCars []observer.Observer
}

func (p *TrafficLights) AddPedestriansAndCars(buyer ...observer.Observer) {
	p.buyers = append(p.buyers, buyer...)
	fmt.Println("可变参数中加入了", p.buyers)
}

func (p *TrafficLights) RemovePedestriansAndCars(buyer observer.Observer) {
	for index, value := range p.buyers {
		if value == buyer {
			copy(p.buyers[index:], p.buyers[index+1:])
			p.buyers = p.buyers[:len(p.buyers)-1]
			fmt.Println("删除后:", p.buyers)
			break
		}
	}
}
func (p *TrafficLights) NotifyPedestriansAndCars(flag bool) {
	for _, value := range p.buyers {
		value.Update(flag)
	}
}

observer.go 观察者接口，我们定义了一个Update方法，用于更新观察者的行为，当观察目标发生变动的时候，观察者应该执行的行为。

package observer

type Observer interface {
	Update(flag bool)
}

PedestriansAndCars.go 观察者具体方法，由于这里我们模拟的交通信号灯的情景，所以这里观察者的具体实现类直接命名为PedestriansAndCars。这里的Update方法我们实现了当红绿灯发生变动时，行人和车辆应该执行的具体行为，这里我们为了模拟情况，简单地进行打印输出操作。

package impl

import "fmt"

type PedestriansAndCars struct {
	Name string
}

func (b *PedestriansAndCars) Update(flag bool) {
	if flag {
		fmt.Println("绿灯亮", b.Name, "可以走了")
	} else {
		fmt.Println("红灯亮", b.Name, "请站在原地等待")
	}
}

main.go 主函数的场景,在这里我们创建trafficLights观察目标对象，在观察目标中加入行人和车辆，当trafficLights观察目标发生变动的时候，会通知执行所有的已经添加到观察目标切片中的所有行人和车辆。

package main

import (
	impl2 "demo/TrafficLightsAndPedestrians/observer/impl"
	"demo/TrafficLightsAndPedestrians/subject/impl"
)

func main() {
	trafficLights := new(impl.TrafficLights)
	person01 := &impl2.PedestriansAndCars{Name: "小1"}
	person02 := &impl2.PedestriansAndCars{Name: "小2"}
	person03 := &impl2.PedestriansAndCars{Name: "小3"}
	car01 := &impl2.PedestriansAndCars{Name: "车1"}
	car02 := &impl2.PedestriansAndCars{Name: "车2"}
	trafficLights.AddPedestriansAndCars(person01, person02, person03, car01, car02)
	trafficLights.NotifyPedestriansAndCars(false)
}

这里之所以采用接口调用的方式，是为了方便后期代码功能的扩展，如果我们想要在代码中再次添加一个观察目标，直接定义一个结构体去实现subject接口即可，其余代码不需要进行变动;如果·

5.改造后的新代码

本次改造主要是对websocket长连接进行更改，在原有socket包的基础上添加了subject观察目标包和observer观察者，在观察目标发生变动后，会通知所有的观察者，观察者接收到信息后，会执行对应的方法。

在这里观察目标为客户端不断发送的websocket数据包，观察者是原先switch语句下的各个分支。一旦观察目标接收到websocket数据包，就通知所有的观察者，观察者是否否执行，取决于观察者内部信息类型的判断是否符合传送数据包的类型。

subject.go

package observed

import (
	"klotski/pojo"
	"klotski/socket/subscriber"
)

type Observed interface {
	AddProcess(process subscriber.Subscriber)
	RemoveProcess(process subscriber.Subscriber)
	Notify(client *pojo.Client, request *pojo.RequestPkg)
}

controller.go

package impl

import (
	"klotski/pojo"
	"klotski/socket/subscriber"
)

type Controller struct {
	processes []subscriber.Subscriber
}

func (c *Controller) AddProcess(process ...subscriber.Subscriber) {
	c.processes = append(c.processes, process...)

}

func (c *Controller) RemoveProcess(process subscriber.Subscriber) {
	for i, o := range c.processes {
		if o == process {
			c.processes = append(c.processes[:i], c.processes[i+1:]...)
			break
		}
	}
}

func (c *Controller) Notify(client *pojo.Client, request *pojo.RequestPkg) {
	for _, observer := range c.processes {
		observer.Update(client, request)
	}
}

observer.go

package subscriber

import "klotski/pojo"

type Subscriber interface {
	Update(client *pojo.Client, request *pojo.RequestPkg)
}

process.go

package impl

import (
	"encoding/json"
	"fmt"
	"klotski/pojo"
)

// CertificationObserver 用户认证观察者
type CertificationObserver struct{}

func (o *CertificationObserver) Update(client *pojo.Client, request *pojo.RequestPkg) {
	if request.Type == pojo.CertificationType {
		client.CertificationProcess(*request)
	}
}

// CreateRoomObserver 创建房间观察者
type CreateRoomObserver struct{}

func (o *CreateRoomObserver) Update(client *pojo.Client, request *pojo.RequestPkg) {
	if request.Type == pojo.CreateRoomType {
		client.CreateRoomProcess()
	}
}

// JoinRoomObserver 加入房间观察者
type JoinRoomObserver struct{}

func (o *JoinRoomObserver) Update(client *pojo.Client, request *pojo.RequestPkg) {
	if request.Type == pojo.JoinRoomType {
		var data map[string]interface{}
		if err := json.Unmarshal([]byte(request.Data), &data); err != nil {
			fmt.Println("解析 JSON 失败：", err)
		}
		if uuidValue, ok := data["uuid"].(string); !ok {
			fmt.Println("uuid 字段不存在或不是字符串类型")
			return
		} else {
			client.JoinRoomProcess(uuidValue)
		}
	}
}

// RefreshScoreObserver 刷新游戏分数观察者
type RefreshScoreObserver struct{}

func (o *RefreshScoreObserver) Update(client *pojo.Client, request *pojo.RequestPkg) {
	if request.Type == pojo.RefreshScoreType {
		client.RefreshScoreProcess(*request)
	}
}

// DiscontinueQuitObserver 主动断开连接观察者
type DiscontinueQuitObserver struct{}

func (o *DiscontinueQuitObserver) Update(client *pojo.Client, request *pojo.RequestPkg) {
	if request.Type == pojo.DiscontinueQuitType {
		client.DiscontinueQuitProcess()
	}
}

// GameOverObserver 游戏结束观察者
type GameOverObserver struct{}

func (o *GameOverObserver) Update(client *pojo.Client, request *pojo.RequestPkg) {
	if pojo.GameOverType == request.Type {
		fmt.Println("GameOverType")
	}
}

// HeartCheckObserver 健康检测观察者
type HeartCheckObserver struct{}

func (o *HeartCheckObserver) Update(client *pojo.Client, request *pojo.RequestPkg) {
	if pojo.HeartCheckType == request.Type {
		if request.Data == "PING" {
			client.HeartCheckProcess()
		}
	}
}