Python WebSocket 服务器项目教程

1. 项目的目录结构及介绍

python-websocket-server/
├── LICENSE
├── README.md
├── requirements.txt
├── setup.py
└── websocket_server/
    ├── __init__.py
    ├── websocket_server.py
    └── examples/
        ├── chat_server.py
        └── simple_server.py

• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖文件。
• setup.py: 项目安装脚本。
• websocket_server/: 核心代码目录。
  • __init__.py: 模块初始化文件。
  • websocket_server.py: WebSocket 服务器核心实现。
  • examples/: 示例代码目录。
    • chat_server.py: 聊天服务器示例。
    • simple_server.py: 简单服务器示例。

2. 项目的启动文件介绍

项目的启动文件主要是 websocket_server/examples/ 目录下的示例文件。以下是两个主要的启动文件：

• chat_server.py: 这是一个聊天服务器的示例，展示了如何使用 WebSocket 服务器实现一个简单的聊天应用。
• simple_server.py: 这是一个简单的 WebSocket 服务器示例，展示了如何启动一个基本的 WebSocket 服务器。

3. 项目的配置文件介绍

该项目没有显式的配置文件，所有的配置都是通过代码中的参数进行设置的。例如，在 chat_server.py 和 simple_server.py 中，可以通过修改以下参数来配置服务器：

• host: 服务器绑定的 IP 地址。
• port: 服务器监听的端口号。

例如，在 simple_server.py 中，可以这样配置服务器：

from websocket_server import WebsocketServer

def new_client(client, server):
    server.send_message_to_all("Hey all, a new client has joined!")

server = WebsocketServer(host='127.0.0.1', port=9001)
server.set_fn_new_client(new_client)
server.run_forever()

通过修改 host 和 port 参数，可以配置服务器的运行地址和端口。