From 39df598e3f20997842b1b57d25a27d4a950b0ceb Mon Sep 17 00:00:00 2001 From: ZhuangYumin Date: Tue, 28 Nov 2023 04:01:20 +0000 Subject: [PATCH] docs: update design --- docs/develop/总体设计文档.md | 34 ++++++++++++++++++++++++---------- docs/develop/需求分析文档.md | 1 + 2 files changed, 25 insertions(+), 10 deletions(-) diff --git a/docs/develop/总体设计文档.md b/docs/develop/总体设计文档.md index 4fb6cde..25f5644 100644 --- a/docs/develop/总体设计文档.md +++ b/docs/develop/总体设计文档.md @@ -1,22 +1,36 @@ 计划实现的bonus： - 缓存 - 并发 +- GUI前端和完整部署方案 有时间打算实现的bonus（按优先级次序排序）： -1. GUI前端和完整部署方案 -2. UTF-8中文支持 -3. Validator +1. UTF-8中文支持 +2. Validator + +不打算实现的bonus： +- 快照 +- 文件系统修复 # 模块划分 -整个程序分为核心和前端两部分，核心即主体部分 -## 核心 -核心只有一个可执行文件，书店实例通过配置文件夹来决定（默认为当前目录下`.bookstore`文件夹，亦可通过命令行参数指定）。当书店系统在运行时，有且仅有一个进程，分为interactive模式和server模式。 +整个程序分为后端和前端两部分，后端即主体部分 +## 后端 +后端只有一个可执行文件，书店实例通过配置文件夹来决定（默认为当前目录下`.bookstore`文件夹，亦可通过命令行参数指定）。当书店系统在运行时，有且仅有一个后端进程，分为interactive模式(使用后端自带的交互，单会话模式)和server模式(通过WebUI交互)。 ### 数据库模块 -维护相关数据，支持并发 +维护相关数据，支持并发（API阻塞但可同时运行）。 +#### 数据库设计方案 + ### 引擎模块 -具体执行业务，支持并发 +具体执行业务，支持并发（API阻塞但可同时运行）。 ### 通信模块 -负责对外提供文本模式的交互，解析文本格式的命令，并把内部数据格式的响应翻译成文本格式，向引擎模块发送请求，并把响应返回给session进程。server模式下 支持并发 +负责对外提供文本模式的交互，从流`request`读取文本格式的命令，并把内部数据格式的响应翻译成文本格式，向引擎模块发送请求（调用引擎模块对外提供的API），并把响应返回到流`response`。支持并发：输入子模块从`request`读取指令，依次调用翻译子模块；翻译子模块向引擎模块API发送请求，得到响应后把响应数据传给输出子模块的调用接口(阻塞但可同时运行，处理部分同时运行，上锁后直接输出到`response`，输出本身不同时进行)。注意，输入输出仅保证单个请求/响应是完整的，多个请求/响应之间是完全“混杂”的，通过session token、operation token区分，通过outhentication key鉴权。`request`流和`response`流始终由信模块控制。注意，通讯模块不负责会话管理。 +### 内置交互模块 +当处于server模式下，直接把`std::cin`和`std::cout`绑给通信模块；处于interactive模式下时，提供会话管理，然后再调用通信模块。 +标准输入输出始终由内置交互模块控制。 ## 前端 -~~不清楚有没有时间写~~。WebUI，采用`Node.JS`+`Socket.IO`，~~不打算弄得很好看，不打算支持响应式设计~~，支持图形操作和“云命令行”。 \ No newline at end of file +~~不清楚有没有时间写~~。WebUI，采用`Node.JS`+`Socket.IO`，~~不打算弄得很好看，不打算支持响应式设计~~，支持图形化操作面板和“云命令行”。和interactive模式一样，单个会话的操作不支持并发。对于通讯中断、偶发的服务器未响应，只保证不会彻底崩掉，不保证出问题的业务能恢复。 +### 服务端 +提供会话管理 +### 客户端 +#### 云命令行 +#### 图形化操作面板 \ No newline at end of file diff --git a/docs/develop/需求分析文档.md b/docs/develop/需求分析文档.md index e69de29..a8cde59 100644 --- a/docs/develop/需求分析文档.md +++ b/docs/develop/需求分析文档.md @@ -0,0 +1 @@ +# 预设场景