WebSockets是向网站用户发送实时更新的极好方法。在这篇文章中，我们将向你展示如何在基于Starlette的web应用程序中设置websockets。

WebSockets是什么?

在基本级别上，WebSockets表示客户机和服务器之间的双向连接，这意味着客户机和服务器都能够互相发送消息。当建立这样的连接时，客户端首先打开到服务器的“正常”HTTP连接，然后请求服务器将连接“升级”为WebSocket连接。

服务器可能接受也可能不接受此升级请求，这取决于后端运行的是什么软件。在Python生态系统中，Django使用channels包支持WebSockets。在撰写本文时，这个包是一个官方的Django项目，但并不包含在默认的Django发行版中。

Starlette从v0.6.0开始支持WebSockets。在这篇博文中，我们将看到如何使用Starlette编写一个简单的WebSockets服务器。

Starlette HTTP端点

让我们从一个普通的web服务器开始讨论。

在Starlette应用程序中，可以通过映射到URL的Endpoint访问服务器上的所有内容。端点可以被认为是一个表示用户请求的类。HTTP资源尤其可以通过HTTPEndpoint获得。

让我们快速看看一个非常简单的Starlette应用程序:

将上面的代码放在一个名为main.py的文件中，并使用uvicorn main:instance——port 8000运行它。您应该能够在浏览器中访问http://localhost:8000/hello，并看到屏幕上写着的壮观的“Hello, World!”消息。

在本例中，HelloEndpoint是一个“普通的”HTTP端点。由于WebSocket连接的工作方式略有不同，Starlette为编写这样的端点提供了一个特殊的基类。让我们接下来探讨这个问题。

Starlette WebSocket端点

正如我们前面提到的，WebSocket连接与普通连接稍有不同。出于这个原因，Starlette提供了一个不同的基本端点类供您扩展，该类被恰当地称为WebSocketEndpoint。

让我们使用这个类在前一个示例中的服务器上添加另一个端点，该端点将响应WebSocket连接。

正如您所看到的，WSEndpoint类看起来与我们之前的基于httpendpoint的类有点不同。其中一个不同之处是没有get或post处理程序方法。相反，我们有on_connect、on_receive和on_disconnect。这三个方法大致对应客户机WebSocket连接的生命周期阶段。

on_connect

每当新客户机连接到服务器时，框架就会调用on_connect方法。它接受一个表示连接对象本身的websocket参数。调用websocket.accept()让服务器接受客户端的连接请求。

on_receive

on_receive方法是主要通信发生的地方。每当客户机向服务器发送任何数据时，将调用此方法以及作为参数传递的已发送数据。

在上面的例子中，我们要求服务器向客户端返回一个简单的“OK!”，作为对客户端所说的任何事情的一般响应。

on_disconnect

Starlette在客户机/服务器连接关闭时调用on_disconnect方法。如果您希望服务器在客户端断开连接后执行任何清理，这是调整的方法。

close_code参数也被传递给该方法，其中包含关闭连接的原因。您可能想知道的所有可能的关闭代码的完整列表在星号中。模块状态。如果您想根据应用程序的性质调整清理代码，这是很有帮助的。

基本上就是这样!只需要几行代码，我们就构建了一个可用于生产的WebSocket服务器，它能够与多个客户机实时通信!

测试WebSocket连接

在结束之前，让我们快速了解一下如何测试整个设置。

当然，我们可以编写一些HTML和JavaScript代码，从浏览器通过WebSocket连接连接到我们的后端，并在客户机和服务器之间来回发送一些消息，以确保一切都按预期工作。这将是一个完全有效的测试方法。

让我们试试不同的东西。让我们试着多了解一点Starlette，并使用它的测试功能来确保我们的WebSocket服务器按预期工作。

Starlette提供了一个TestClient类，用作HTTP客户端。顾名思义，我们通常在编写应用程序测试时使用这个类。我们将为这篇博客文章做一个例外，使用这个类与我们的WebSocket服务器通信。

正如我们所看到的，这个代码片段使用我们在主应用程序文件中构造的Starlette应用程序实例实例化了一个TestClient。然后我们使用websocket_connect上下文管理器来获取一个websocket对象，我们可以用它来与服务器通信。连接建立后，我们要做的第一件事是向服务器发送一个“Hello!”，然后等待服务器发回一些东西。在下一行中，我们打印从服务器返回的内容。

将这段代码粘贴到一个名为ws_test.py的文件中，并使用python ws_test.py运行它。你应该会看到类似如下的输出行:

输出的第一行和最后一行是我们在端点定义中调用logger.info的日志消息。第二行是服务器返回的“OK!”消息。

结论

WebSockets是一项非常有用的技术，它可以帮助您实现丰富的终端用户体验。

能够将数据从服务器推送到客户机，而不是客户机总是需要向服务器请求数据，这是非常强大的功能。构建聊天应用程序是WebSockets启用的一个经典用例，但WebSockets应用的用例数量可能是无限的。

Starlette是一个原生支持该技术的Python框架。因此，如果您正在构建一个SaaS，这是您应该考虑使用Starlette的另一个原因!