# workkkfor2012/binancecryptokline architecture

> Architecture diagram of the GitHub repository workkkfor2012/binancecryptokline, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-23). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/workkkfor2012/binancecryptokline
- Repository: https://github.com/workkkfor2012/binancecryptokline

## Overview

以下说明针对 “币安U本位永续合约K线服务器” 项目，指导如何绘制最准确的系统设计/架构图，并附上中文流程图示例。

##### 项目类型与目的
- 这是一个基于Rust的全栈高性能数据服务项目，包含三大可执行模块：
1) K线下载器（kline_downloader）
2) K线服务器（kline_server，含WebSocket客户端和K线合成器）
3) 网页服务器（kline_web_server，提供Web界面）
- 主要功能：从币安FAPI下载历史与实时K线数据，存储于SQLite（WAL模式），并通过Web/API提供查询服务。

##### 文件结构分析
- src/bin：下载器与服务器程序入口
- src/kldownload：下载器模块，包括API调用、并发处理、存储、错误处理等
- src/klserver：K线服务器模块，包括数据库检查、WebSocket订阅、合成器、Web API
- static：前端静态页面（index.html、test.html）
- docs：架构与启动流程文档
- Cargo.toml/Cargo.lock：依赖与构建配置

##### README 关键信息
- SQLite WAL 模式：实现高并发读写
- 支持多周期、多交易对并发下载
- 三个独立进程／服务：下载历史，实时合成，前端展示
- 启动脚本：.bat 文件或 cargo run

##### 系统设计图绘制要点
a. 主要组件
- 外部服务：币安FAPI (HTTPS REST, WebSocket)
- 本地模块：
· K线下载器
· SQLite 数据库 (WAL)
· K线服务器 (WebSocket 客户端 + 合成器)
· 网页服务器 (HTTP Server + 静态页面)
- 客户端：浏览器或第三方调用者
b. 组件交互
- 下载器 → REST API → Binance → 下载K线 → 写入 SQLite
- K线服务器 → WebSocket API → Binance 实时数据 → 合成 → 写入/读取 SQLite
- 网页服务器 → 读取 SQLite → HTTP 响应 → 浏览器
c. 架构模式
- 多进程分层（Downloader、Processor、Web）
- 发布/订阅（WebSocket 订阅实时流）
- 数据持久化（SQLite WAL）
d. 技术栈/框架
- Rust + Tokio 异步
- reqwest/tokio-tungstenite
- rusqlite (WAL 模式)
- warp 或 actix-web（网页服务器可选）

##### 针对本项目的中文流程图（ASCII 示例）

[启动脚本]
│
▼
+----------------+       +----------------+       +----------------+
|  K线下载器     |──────▶|    SQLite      |◀──────|  K线服务器     |
| (Downloader)   | REST  |  (WAL 模式)    |  WS   | (Server + 合成) |
+----------------+       +----------------+       +----------------+
│
▼
+-----------+
| 网页服务器 |
| (HTTP API) |
+-----------+
│
▼
[浏览器/客户端]

- 箭头说明：
· 实线箭头：数据流（REST/WS/HTTP）
· 组件形状可用矩形区分，颜色区分：
· 蓝色：内部服务
· 绿色：数据库
· 橙色：外部服务／客户端

##### 绘图指南
- 使用清晰的矩形或图标表示各服务组件；
- 用不同颜色/形状区分「下载器」「服务器」「数据库」「网页服务」「外部API」「客户端」；
- 用实线箭头标注数据流方向，并在箭头旁标注协议（REST、WS、SQL、HTTP）；
- 在组件内部或旁边注明主要技术栈（Rust/Tokio、rusqlite、reqwest）；
- 保持图例与说明清晰，统一字号和配色，便于阅读。

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "外部服务"
        Binance["币安 FAPI\n(REST/WS)"]:::external
    end

    subgraph "下载器服务"
        Downloader["K线下载器\n(Downloader)\nRust/Tokio"]:::internal
        subgraph "下载器模块"
            API["API 调用"]:::internal
            Aggregator["并发与聚合"]:::internal
            Storage["数据存储"]:::internal
            WSDownload["WebSocket 下载"]:::internal
        end
    end

    SQLite["SQLite\n(WAL 模式)"]:::db

    subgraph "K线服务器服务"
        Server["K线服务器\n(Server + 合成器)\nRust/Tokio"]:::internal
        subgraph "服务器模块"
            StartupCheck["启动检查"]:::internal
            DBAccess["数据库访问"]:::internal
            Models["合成模型"]:::internal
            APIService["REST/Web API"]:::internal
            WebService["Web 前端服务"]:::internal
        end
    end

    subgraph "网页服务器"
        WebServer["网页服务器\n(HTTP Server)\nRust"]:::internal
        static["静态页面\nindex.html, test.html"]:::internal
    end

    subgraph "启动脚本"
        SKD["start_kldownload.bat"]:::external
        SKS["start_klserver.bat"]:::external
    end

    Client["浏览器/客户端"]:::external

    Binance -->|"REST"| Downloader
    Binance -->|"WS"| Server
    Downloader -->|"写入"| SQLite
    Server -->|"读写"| SQLite
    Server -->|"HTTP API"| WebServer
    WebServer -->|"静态资源"| Client
    Client -->|"访问 HTTP"| WebServer
    SKD --> Downloader
    SKS --> Server

    click Downloader "https://github.com/workkkfor2012/binancecryptokline/blob/main/src/bin/kline_downloader.rs"
    click API "https://github.com/workkkfor2012/binancecryptokline/blob/main/src/kldownload/api.rs"
    click Aggregator "https://github.com/workkkfor2012/binancecryptokline/tree/main/src/kldownload/aggregator/"
    click Storage "https://github.com/workkkfor2012/binancecryptokline/blob/main/src/kldownload/storage.rs"
    click WSDownload "https://github.com/workkkfor2012/binancecryptokline/tree/main/src/kldownload/websocket/"
    click Server "https://github.com/workkkfor2012/binancecryptokline/blob/main/src/bin/kline_server.rs"
    click StartupCheck "https://github.com/workkkfor2012/binancecryptokline/blob/main/src/klserver/startup_check.rs"
    click DBAccess "https://github.com/workkkfor2012/binancecryptokline/blob/main/src/klserver/db.rs"
    click Models "https://github.com/workkkfor2012/binancecryptokline/blob/main/src/klserver/models.rs"
    click APIService "https://github.com/workkkfor2012/binancecryptokline/blob/main/src/klserver/api.rs"
    click WebService "https://github.com/workkkfor2012/binancecryptokline/blob/main/src/klserver/web/handlers.rs"
    click WebService "https://github.com/workkkfor2012/binancecryptokline/blob/main/src/klserver/web/server.rs"
    click static "https://github.com/workkkfor2012/binancecryptokline/tree/main/static/"
    click SKD "https://github.com/workkkfor2012/binancecryptokline/blob/main/start_kldownload.bat"
    click SKS "https://github.com/workkkfor2012/binancecryptokline/blob/main/start_klserver.bat"

    classDef internal fill:#87CEFA,stroke:#333,stroke-width:1px
    classDef db fill:#90EE90,stroke:#333,stroke-width:1px
    classDef external fill:#FFA500,stroke:#333,stroke-width:1px
```
