MicroWebSrv2 使用教程

MicroWebSrv2 使用教程

MicroWebSrv2 The last Micro Web Server for IoTs (MicroPython) or large servers (CPython), that supports WebSockets, routes, template engine and with really optimized architecture (mem allocations, async I/Os). Ready for ESP32, STM32 on Pyboard, Pycom's chipsets (WiPy, LoPy, ...). Robust, efficient and documented! 项目地址: https://gitcode.com/gh_mirrors/mi/MicroWebSrv2

1. 项目介绍

1.1 项目概述

MicroWebSrv2 是一个为 MicroPython 和 CPython 设计的嵌入式 Web 服务器。它支持路由处理程序、WebSocket、PyhtmlTemplate 等模块，并且具有高度优化的架构，适用于 ESP32、STM32、Pycom 等芯片组。MicroWebSrv2 的设计目标是提供一个高效、稳健且易于使用的 Web 服务器，适用于物联网设备和大型服务器。

1.2 主要特性

• 异步架构：支持处理大量并发请求。
• 多线程支持：可以并行处理多个请求。
• 模块化设计：支持 WebSocket、模板引擎等模块。
• SSL/TLS 支持：支持 HTTPS 安全连接。
• 路由处理：支持定义带有变量参数的路由。
• 资源优化：内存分配和资源使用高度优化。

2. 项目快速启动

2.1 安装

2.1.1 通过 pip 安装

pip3 install --user git+https://github.com/jczic/MicroWebSrv2.git#egg=MicroWebSrv2

2.1.2 通过克隆仓库安装

git clone https://github.com/jczic/MicroWebSrv2.git
cd MicroWebSrv2
pip install --user .

2.2 快速启动示例

以下是一个简单的示例，展示如何在 MicroPython 中启动 MicroWebSrv2 服务器。

from MicroWebSrv2 import *
from time import sleep

# 创建 MicroWebSrv2 实例
mws2 = MicroWebSrv2()

# 启动服务器
mws2.StartManaged()

# 主程序循环
try:
    while True:
        sleep(1)
except KeyboardInterrupt:
    mws2.Stop()

2.3 配置路由

以下是一个简单的路由配置示例，展示如何处理 GET 请求。

@WebRoute(GET, '/hello')
def RequestHello(microWebSrv2, request):
    request.Response.ReturnOkJSON({
        'message': 'Hello, World!'
    })

3. 应用案例和最佳实践

3.1 物联网设备控制

MicroWebSrv2 非常适合用于物联网设备，例如 ESP32 或 STM32。通过 WebSocket 和路由处理，可以轻松实现设备的远程控制和监控。

@WebRoute(GET, '/control')
def RequestControl(microWebSrv2, request):
    # 处理控制请求
    pass

3.2 数据可视化

结合 PyhtmlTemplate 模块，可以轻松实现数据的可视化。以下是一个简单的示例，展示如何使用模板引擎生成动态网页。

@WebRoute(GET, '/data')
def RequestData(microWebSrv2, request):
    data = fetch_data()  # 假设这是一个获取数据的函数
    request.Response.ReturnOkJSON(data)

4. 典型生态项目

4.1 XAsyncSockets

MicroWebSrv2 依赖于 XAsyncSockets 库，这是一个高效的异步套接字管理库，支持大量并发连接。

4.2 PyhtmlTemplate

PyhtmlTemplate 是一个模板引擎模块，允许在 HTML 页面中嵌入 Python 代码，非常适合动态网页生成。

4.3 WebSockets

WebSockets 模块支持实时消息交换，适用于需要实时通信的应用场景，如在线聊天、实时监控等。

通过以上模块的结合使用，MicroWebSrv2 可以构建出功能强大且高效的 Web 服务器，适用于各种嵌入式和物联网应用场景。

MicroWebSrv2 The last Micro Web Server for IoTs (MicroPython) or large servers (CPython), that supports WebSockets, routes, template engine and with really optimized architecture (mem allocations, async I/Os). Ready for ESP32, STM32 on Pyboard, Pycom's chipsets (WiPy, LoPy, ...). Robust, efficient and documented! 项目地址: https://gitcode.com/gh_mirrors/mi/MicroWebSrv2