docs: 添加了需求文档,并简单设计了前端

This commit is contained in:
2023-11-28 11:07:58 +00:00
parent 6f290c551d
commit cf834d88ba
2 changed files with 15 additions and 6 deletions

View File

@ -34,23 +34,25 @@
### 引擎模块
具体执行业务一次请求对应且只对应一次引擎模块API调用支持并行API阻塞但可同时运行。当API入口函数被调用后执行相关具体操作然后返回响应。
具体执行业务一次请求对应且只对应一次引擎模块API调用支持并行API阻塞但可同时运行。当API入口函数被调用后执行相关具体操作(包括会话管理),然后返回响应。
### 通信与调度模块
负责对外提供文本模式的交互,以及维护请求级的并行。从流`request`读取文本格式的命令并把内部数据格式的响应翻译成文本格式向引擎模块发送请求调用引擎模块对外提供的API并把响应返回到流`response`。支持条件允许时的并行:
- 输入子模块从`request`读取请求,打上时间戳,分独占式请求和可并行请求按时间戳顺序分批处理。处理一个请求时,启动一个工作线程调用翻译子模块。同一个会话的请求不可并行,把`std::thread`move进相应的该会话的工作线程句柄队列下一个join前一个。成批执行可并行请求时启动完当前批次所有工作线程后join每个session的最后一个工作线程结束之后就可以执行下一批了。为了在服务模式下处理时有时无的请求两个流在读取时是阻塞的并且读一个处理一个碰到“不属于自己批次”的东西才算一批结束。
- 输入子模块从`request`读取请求,打上时间戳,分独占式请求和可并行请求按时间戳顺序分批处理。处理一个请求时,启动一个工作线程调用翻译子模块。同一个会话的请求不可并行,把`std::thread`move进相应的该会话的工作线程句柄队列下一个join前一个。成批执行可并行请求时启动完当前批次所有工作线程后join每个session的最后一个工作线程结束之后就可以执行下一批了。为了在服务模式下处理时有时无的请求两个流在读取时是阻塞的(自己封装一个,用`std::condition_variable`通讯),并且读一个处理一个,碰到“不属于自己批次”的东西才算一批结束。
- 翻译子模块(入口函数本身阻塞)join完同一个session的上一个请求后向引擎模块API发送请求得到响应后把响应数据传给输出子模块的调用接口(阻塞但可并行,处理部分同时运行,上锁后直接输出到`response`,输出本身不同时进行)。
注意,在`request`流和`response`流中,输入输出仅保证单个请求/响应是完整的,多个请求/响应之间是完全“混杂”的通过session token、operation token区分通过outhentication key鉴权。`request`流和`response`流始终由信模块控制。注意,通讯模块不负责会话管理。
### 内置交互模块
当处于server模式下直接把`std::cin``std::cout`给通信与调度模块处于interactive模式下时提供会话管理然后再调用通信与调度模块。
当处于server模式下不负责会话管理,直接把`std::cin``std::cout`的内容转发给通信与调度模块处于interactive模式下时提供用户侧会话管理,然后再调用通信与调度模块。
标准输入输出始终由内置交互模块控制。
## 前端
~~不清楚有没有时间写~~。WebUI采用`Node.JS`+`Socket.IO`~~不打算弄得很好看,不打算支持响应式设计~~支持图形化操作面板和“云命令行”。和interactive模式一样单个会话的操作支持并行。对于通讯中断、偶发的服务器未响应,只保证不会彻底崩掉,不保证出问题的业务能恢复。
~~不清楚有没有时间写~~。WebUI采用`Node.JS`+`Socket.IO`~~不打算弄得很好看,不打算支持响应式设计~~支持图形化操作面板和“云命令行”。和interactive模式一样单个会话的操作支持逻辑上并发(上一操作未结束可以发出下一操作)但后端实际上是串行的。对于通讯中断、偶发的服务器未响应,只保证不会彻底崩掉,不保证出问题的业务能恢复。会话管理方面,只负责信息准确投送。
### 服务端
提供会话管理
提供会话管理。虽然有log但后端的响应只会发送一次用于防止客户端掉线的缓存由服务端维护。
### 客户端
云命令行和图形化操作面板分两个页面通过超链接关联。历史记录、会话信息存储于IndexDB中。负责用户侧会话管理。
#### 云命令行
#### 图形化操作面板
实际上是一个页面,不同模式下动态绘制。

View File

@ -1 +1,8 @@
# 预设场景
一个中小规模的书店个体总量不超过1e5会话数不超过1e4每秒请求数不超过1e2总操作量不超过1e9~~平均每个个体1e4回头客很多1e9除以1e2为1e7百年老店~~
# 客户需求
通过这个系统,完成图书查询和购买操作
# 销售员需求
通过这个系统,完成进货、图书信息录入、图书信息修改、用户创建操作
# 店长需求
系统维护+数据报表查询