Go如何实现Websocket服务以及代理_Golang

go 实现 websocket服务以及代理

1. 协议说明

websocket 是一种在单个 tcp 连接上进行全双工通信的协议。websocket 使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。websocket 主要用在b/s架构的应用程序中，在 websocket api 中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。

它的最大特点就是，服务器可以主动向客户端推送信息，客户端也可以主动向服务器发送信息，是真正的双向平等对话，属于服务器推送技术的一种。

websocket 协议在2008年诞生，2011 年成为国际标准。现在最新版本浏览器都已经支持了。

websocket 是一种应用层协议

websocket 的典型特点：

基于 tcp 协议的应用层协议，实现相对简单
单个 tcp 连接上进行全双工通信
兼容 http 协议，默认端口也是 80 和 443

ws://host:port/path/querywss://host:port/path/query

握手阶段采用 http 协议，能通过各种 http 代理服务器
数据格式比较轻量，性能开销小，通信高效
可以发送文本和二进制数据
没有浏览器的同源限制

websocket 的典型场景：

即时通信
协同编辑/编辑
实时数据流的拉取与推送

2. websocket 推送和浏览器轮询

在 b/s 开发领域，若需要浏览器 b 即时得到服务器的状态更新，常使用两个方案：

浏览器端轮询
服务器端推送

浏览器轮询：浏览器端，当需要获取最新数据状态时，利用脚本程序循环向服务端发送请求。

服务器推送，服务器端，当状态改变时，将数据发送到浏览器端。

http/2 版本也支持服务器端推送，但实现上以推送静态资源为主，不能基于业务逻辑推送特定的消息，因此当前的普及使用率 websocket 还是主流。

3. websocket 和 http

相同点

应用层协议
b/s 架构中使用
基于 tcp 协议
端口默认都是：80 和 443

不同点

4. websocket 握手过程

通过 http 请求响应，中的头信息，完成 websocket 握手，如图：

在请求头中添加如下信息

# 升级为 websocket
upgrade: websocket
connection: upgrade
# 一个 base64 encode 的值，有于验证服务器端是否支持websocket
sec-websocket-key: x4jjhmbdl22zlk1gbhxdw==
# 用户协议，可以视为不同业务逻辑的频道
sec-websocket-protocol: chat
# 协议版本，13是当前通用版本，几乎不需要更改
sec-websocket-version: 13

基于以上请求头，服务器端，就知道需要将协议升级为 websocket 协议，并提供一些验证信息。

服务端的响应头

http/1.1 101 switching protocols
# 协议升级
upgrade: websocket
# 连接状态
connection: upgrade
# websocket服务端根据sec-websocket-key生成
sec-websocket-accept: s3pplmbitxaq9kygzzhzrbk+xoo=
# websocket协议用户协议
sec-websocket-protocol: chat

基于以上响应头，浏览器端就知道服务器端升级成功，并通过了验证。

至此，b/s 端可以基于该连接，完成 websocket 双向通信了。

websocket 只能发送 get 请求

5. websocket 状态码和消息类型

5.1 状态码

websocket协议状态码解析

5.2 消息类型

textmessage 和 binarymessage 分别表示发送文本消息和二级制消息

closemessage 关闭帧，接收方收到这个消息就关闭连接

pingmessage 和 pongmessage : 是保持心跳的帧

发送方 -> 接收方是 pingmessage
接收方 -> 发送方是 pongmessage

由服务器发 ping 给浏览器，浏览器返回 pong 消息

6. websocket 服务器实现

使用 github.com/gorilla/websocket 这个库函数

func websocketserver() {
	addr := "localhost:8002"
	http.handlefunc("/wshandler", websocketupgrade)
	log.println("starting websocket server at " + addr)

	go func() {
		err := http.listenandserve(addr, nil)
		if err != nil {
			log.fatal(err)
		}
	}()

	log.println("websocket 服务器正在运行。按ctrl+c退出")
	select {}
}

func websocketupgrade(resp http.responsewriter, req *http.request) {
	// 初始化 upgrader
	upgrader := websocket.upgrader{} // 使用默认的选项
	// 第三个参数是响应头,默认会初始化
	conn, err := upgrader.upgrade(resp, req, nil)
	if err != nil {
		log.println(err)
		return
	}
	defer conn.close()

	// 读取客户端的发送额消息,并返回
	go readmessage(conn)
	select {}
}

// 读取客户端发送的消息,并返回
func readmessage(conn *websocket.conn) {
	for {
		// 消息类型:文本消息和二进制消息
		messagetype, msg, err := conn.readmessage()
		if err != nil {
			log.println(err)
			return
		}
		fmt.println("receive msg:", string(msg))

		err = conn.writemessage(messagetype, msg)
		if err != nil {
			log.println("write error:", err)
			return
		}
	}
}

使用 apifox 测试 websocket 是否能连接并且发送消息

消息发送成功，同时也接收到来服务端的消息

消息接收成功

7. websocket 代理实现

package websocket

import (
	"log"
	"net/http"
	"net/http/httputil"
	"net/url"
)

var (
	// 代理服务器地址
	proxyserver     = "127.0.0.1:8082"
	// 真实websocket服务器地址
	websocketserver = "http://127.0.0.1:8002"
)

func websocketproxy() {
	url, err := url.parse(websocketserver)
	if err != nil {
		log.println(err)
	}
	proxy := httputil.newsinglehostreverseproxy(url)
	log.println("websocket 代理启动, 按ctrl+c退出")
	http.listenandserve(proxyserver, proxy)
}

8. websocket 服务端主动推送功能的实现

websocket 服务器每隔 3 秒会主动向服务器推送消息"heart beat"

func websocketserver() {
	addr := "localhost:8002"
	http.handlefunc("/wshandler", websocketupgrade)
	log.println("starting websocket server at " + addr)

	go func() {
		err := http.listenandserve(addr, nil)
		if err != nil {
			log.fatal(err)
		}
	}()

	log.println("websocket 服务器正在运行。按ctrl+c退出")
	select {}
}

func websocketupgrade(resp http.responsewriter, req *http.request) {
	// 初始化 upgrader
	upgrader := websocket.upgrader{} // 使用默认的选项
	// 第三个参数是响应头,默认会初始化
	conn, err := upgrader.upgrade(resp, req, nil)
	if err != nil {
		log.println(err)
		return
	}
	defer conn.close()

	// 主动向服务端推送消息
	go pushmessage(conn)

	// 读取客户端的发送额消息,并返回
	go readmessage(conn)
	select {}
}

// websocket 服务器主动服务器推送消息
func pushmessage(conn *websocket.conn) {
	for {
		err := conn.writemessage(websocket.textmessage, []byte("heart beat"))
		if err != nil {
			log.println(err)
			return
		}
		time.sleep(time.second * 3)
	}
}

// 读取客户端发送的消息,并返回
func readmessage(conn *websocket.conn) {
	for {
		// 消息类型:文本消息和二进制消息
		messagetype, msg, err := conn.readmessage()
		if err != nil {
			log.println(err)
			return
		}
		fmt.println("receive msg:", string(msg))

		err = conn.writemessage(messagetype, msg)
		if err != nil {
			log.println("write error:", err)
			return
		}
	}
}

每隔三秒可以看到服务推送过来的消息