Simple WebSockets Chat App 教程

Simple WebSockets Chat App 教程

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

Simple WebSockets Chat App 项目的目录结构如下：

simple-websockets-chat-app/
├── README.md
├── buildspec.yml
├── template.yml
├── websocket_chat_app/
│   ├── app.py
│   ├── requirements.txt
│   ├── static/
│   │   ├── index.html
│   │   └── styles.css
│   └── tests/
│       └── test_chat_app.py

目录结构介绍

• README.md: 项目说明文档。
• buildspec.yml: AWS CodeBuild 配置文件。
• template.yml: AWS CloudFormation 模板文件。
• websocket_chat_app/: 项目主目录。
  • app.py: 主应用程序文件。
  • requirements.txt: 项目依赖文件。
  • static/: 静态文件目录。
    • index.html: 聊天应用的 HTML 文件。
    • styles.css: 聊天应用的 CSS 文件。
  • tests/: 测试文件目录。
    • test_chat_app.py: 聊天应用的测试文件。

2. 项目的启动文件介绍

项目的启动文件是 websocket_chat_app/app.py。这个文件包含了 WebSocket 聊天应用的主要逻辑。

app.py 文件介绍

from flask import Flask, render_template
from flask_socketio import SocketIO

app = Flask(__name__)
app.config['SECRET_KEY'] = 'secret!'
socketio = SocketIO(app)

@app.route('/')
def index():
    return render_template('index.html')

@socketio.on('message')
def handle_message(message):
    print('received message: ' + message)
    socketio.emit('message', message)

if __name__ == '__main__':
    socketio.run(app)

启动文件功能介绍

• Flask 和 Flask_SocketIO 库用于创建 Web 应用和 WebSocket 连接。
• index 路由返回 index.html 文件，作为聊天应用的入口。
• handle_message 函数处理接收到的消息，并将其广播给所有连接的客户端。

3. 项目的配置文件介绍

项目的配置文件主要包括 buildspec.yml 和 template.yml。

buildspec.yml 文件介绍

buildspec.yml 文件用于配置 AWS CodeBuild 的构建过程。

version: 0.2

phases:
  install:
    commands:
      - echo Installing dependencies...
      - pip install -r websocket_chat_app/requirements.txt
  build:
    commands:
      - echo Build started on `date`
      - echo Compiling the Python code...
  post_build:
    commands:
      - echo Build completed on `date`

template.yml 文件介绍

template.yml 文件用于定义 AWS CloudFormation 的资源。

AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
Resources:
  WebSocketChatApp:
    Type: AWS::Serverless::Function
    Properties:
      Handler: app.lambda_handler
      Runtime: python3.8
      CodeUri: websocket_chat_app/
      Events:
        WebSocket:
          Type: Api
          Properties:
            Path: /{proxy+}
            Method: ANY

配置文件功能介绍

• buildspec.yml 定义了构建阶段的操作，包括安装依赖和编译代码。
• template.yml 定义了 AWS Lambda 函数和 API Gateway 事件，用于部署 WebSocket 聊天应用。