在Go中使用Websocket创建聊天服务器

最新推荐文章于 2023-12-21 18:59:00 发布

weixin_26746861

最新推荐文章于 2023-12-21 18:59:00 发布

阅读量230

点赞数

文章标签： websocket python

原文链接：https://medium.com/@itgilangprambudi/create-real-time-chatting-server-with-websocket-in-go-e04f2e0f89e8

版权

Dive deeper into Go web socket and concurrency programming

深入研究Go Web套接字和并发编程

Chatting app can be done in various way (theoretically). Like using simple long-polling request that provide half-duplex (one-way communication) or using protocol that provide full-duplex (2 way) communication like TCP Socket. But, website cannot directly connect to TCP, fortunately, there is a wrapper to TCP called Websocket.

聊天应用程序可以通过多种方式(理论上)进行。就像使用提供半双工(单向通信)的简单长轮询请求或使用提供全双工(2路)通信的协议(如TCP套接字)一样。但是，网站不能直接连接到TCP，幸运的是，有一个TCP的包装程序Websocket 。

You may read more explanation of Websocket that spread through internet, and this time, I’ll explain more about how to implement it in Go

您可能会阅读有关通过Internet传播的Websocket的更多说明，这一次，我将详细说明如何在Go中实现它

需要图书馆 (Library needed)

Before we go right into programming, that’s one library that we need:

在开始编程之前，这是我们需要的一个库：

gorilla/websocket is A fast, well-tested and widely used WebSocket implementation for Go. (quoted from the repo itself)

gorilla / websocket是Go的一种快速，经过测试且广泛使用的WebSocket实现。 (从仓库本身引用)

To do that, right in the project root folder, install the library by typing this command:

为此，请在项目根文件夹中，通过键入以下命令来安装库：

go get github.com/gorilla/websocket

项目结构 (The project structure)

You like it simple, right?

您喜欢简单吗？

So, this is the structure:

因此，这是结构：

Yes, just one file. No need to follow SOLID Principle, following best practice, etc. All we need is a minimal working code. And in big picture, the step to make it is as follow:

是的，只有一个文件。无需遵循SOLID原则，遵循最佳实践等。我们需要的是最少的工作代码。概括地说，实现这一目标的步骤如下：

Simple HTTP Server as the receiver of Websocket request
简单的HTTP Server作为Websocket请求的接收者
Websocket connection handler. We call it the Hub. It is a goroutine that save and remove the data of connected client and handle the message broadcast event
Websocket连接处理程序。我们称之为集线器。 这是一个goroutine，用于保存和删除连接的客户端的数据并处理消息广播事件
Websocket client manager. It handle the Read and Write of Websocket of each client. Ideally, we create one goroutine for each. And 2 separate go routine for the reader and writer. (Total 3 goroutine for 1 client)
Websocket客户经理。它处理每个客户端的Websocket读取和写入。理想情况下，我们为每个程序创建一个goroutine。并为读者和作家提供了两个独立的例程。 (1位客户总共3个goroutine)

I will follow the example provided in this folder of repo

我将按照此回购文件夹中提供的示例进行操作

https://github.com/gorilla/websocket/tree/master/examples/chat

Now, let’s go into the code:

现在，让我们进入代码：

Main function and HTTP Endpoint

主要功能和HTTP端点

At this point, we have create a simple HTTP Server that can receive request to http://127.0.0.1:8080/ws

至此，我们已经创建了一个简单的HTTP服务器，可以接收对http://127.0.0.1：8080 / ws的请求

Now, let’s handle the process when user hit the endpoint by using Web socket protocol. Firstly, we create the Hub.

现在，让我们处理用户使用Web套接字协议访问端点时的过程。首先，我们创建中心。

We have created the Hub. Technically we have provided the container and handler of events like client connection, disconnection and message broadcast that triggered from Websocket. Now we create the Client Manager. Add this below the code, or in the same package (main).

我们已经创建了Hub 。从技术上讲，我们提供了事件的容器和处理程序，例如由Websocket触发的客户端连接，断开连接和消息广播。现在，我们创建客户管理器。将其添加到代码下方，或添加到同一程序包(主程序)中。

*don’t forget to import github.com/gorilla/websocket when writing this part of code

* 在编写这部分代码时 不要忘记导入 github.com/gorilla/websocket

Let’s see, from line 1–4 there, Upgrader used as the parameter of memory buffer constraint for each web socket packet.

让我们从第1-4行开始，将Upgrader用作每个Web套接字数据包的内存缓冲区约束参数。

struct Client represent client connection, it holds reference of Hub and Websocket connection, so it can communicate with other client having the same Hub and Websocket connection reference.

struct Client代表客户端连接，它拥有Hub和Websocket连接的引用，因此它可以与具有相同Hub和Websocket连接引用的其他客户端进行通信。

readPump wait for any incoming message send from client. Once it receive a message, it will pass the data to channel send (send <- message) and next, it will be handled by the Hub.

readPump等待客户端发送的任何传入消息。收到消息后，它将把数据传递到通道发送 (发送<-消息)，然后由集线器处理。

writePump will write (show) the message to the client from incoming data from broadcast (<- send) to client output stream

writePump会将消息从广播(<-发送)到客户端输出流的传入数据写入(显示)到客户端。

serveWs is the gateway for connected HTTP request of client to Websocket world. It will create new instance of websocket connection, create new client object, emitting the register event in hub so the client is registered in the Clients map of Hub. And finally start the reader and writer function

serveWs是客户端将HTTP请求连接到Websocket世界的网关。它将创建websocket连接的新实例，创建新的客户端对象，并在集线器中发出register事件，以便客户端在集线器的“客户端”图中注册。最后启动读写器功能

Hub it self identify Client by it’s memory address. So that is why, in the Client map inside Hub struct, the key is the memory address of the client. We don’t have to create a custom ID for every client as it is by nature already unique. (Memory address looks like: 0x2311cc)

集线器通过其内存地址自行识别客户端。这就是为什么在Hub struct内的Client map中，键是客户端的内存地址的原因。我们不必为每个客户端创建自定义ID，因为它本质上已经是唯一的。 (内存地址如下：0x2311cc)

Now. let’s go back to the main function. We finish the code by initializing new Hub and adding websocket handler.

现在。让我们回到主要功能。我们通过初始化新的Hub并添加websocket处理程序来完成代码。

And the complete code:

以及完整的代码：