From 0192ed248a5d90699dbbe6ffeb2ae9de09e17179 Mon Sep 17 00:00:00 2001 From: ZhuangYumin Date: Wed, 29 Nov 2023 09:22:05 +0000 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=AE=8C=E6=88=90=E7=AC=AC=E4=B8=80?= =?UTF-8?q?=E9=98=B6=E6=AE=B5=E6=96=87=E6=A1=A3=E5=88=9D=E7=A8=BF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- backend/include/drivemultimap.h | 0 backend/src/drivemultimap.cpp | 0 docs/develop/总体设计文档.md | 52 +++++++++++++++++++++++++++++---- docs/develop/需求分析文档.md | 34 +++++++++++++++++---- 4 files changed, 75 insertions(+), 11 deletions(-) create mode 100644 backend/include/drivemultimap.h create mode 100644 backend/src/drivemultimap.cpp diff --git a/backend/include/drivemultimap.h b/backend/include/drivemultimap.h new file mode 100644 index 0000000..e69de29 diff --git a/backend/src/drivemultimap.cpp b/backend/src/drivemultimap.cpp new file mode 100644 index 0000000..e69de29 diff --git a/docs/develop/总体设计文档.md b/docs/develop/总体设计文档.md index e169d3c..5cd5d9a 100644 --- a/docs/develop/总体设计文档.md +++ b/docs/develop/总体设计文档.md @@ -11,7 +11,7 @@ - 快照 - 文件系统修复 -# 模块划分 +# 功能设计（模块划分）、数据库设计 整个程序分为后端和前端两部分，后端即主体部分 ## 后端 后端只有一个可执行文件，书店实例通过配置文件夹来决定（默认为当前目录下`.bookstore`文件夹，亦可通过命令行参数指定）。当书店系统在运行时，有且仅有一个后端进程，分为interactive模式(使用后端自带的交互，单会话模式)和server模式(通过WebUI交互)。 @@ -30,7 +30,7 @@ #### 数据库设计方案 ##### 需求 - +能够逻辑上并发地响应需求，并且实际上尽可能并行。每秒可响应1e4次请求。 ##### 数据结构 ###### 底层实现 通过B+树或一个有序的块状链表实现一个键值数据库，相当于`std::multimap`，一个键值数据库实例拥有恰好一个文件 @@ -41,7 +41,7 @@ memoryriver类维护一个缓存，简单地缓存高频访问和连续访问；键值数据库根据逻辑缓存最近访问和高频访问；数据库层不设缓存。 ##### 并发安全 - +实际的文件操作只由一个线程负责，万级的IOPS足够应付需求；内存中的资源， ### 引擎模块 具体执行业务，一次请求对应且只对应一次引擎模块API调用，支持并行（API阻塞但可同时运行）。当API入口函数被调用后，执行相关具体操作（包括会话管理），然后返回响应。 @@ -51,7 +51,7 @@ memoryriver类维护一个缓存，简单地缓存高频访问和连续访问； - 输入子模块从`request`读取请求，打上时间戳，分独占式请求和可并行请求按时间戳顺序分批处理。处理一个请求时，启动一个工作线程调用翻译子模块。同一个会话的请求不可并行，把`std::thread`move进相应的该会话的工作线程句柄队列，下一个join前一个。成批执行可并行请求时，启动完当前批次所有工作线程后join每个session的最后一个工作线程，结束之后就可以执行下一批了。为了在服务模式下处理时有时无的请求，两个流在读取时是阻塞的（自己封装一个，用`std::condition_variable`通讯），并且读一个处理一个，碰到“不属于自己批次”的东西才算一批结束。 - 翻译子模块(入口函数本身阻塞)join完同一个session的上一个请求后，向引擎模块API发送请求，得到响应后把响应数据传给输出子模块的调用接口(阻塞但可并行，处理部分同时运行，上锁后直接输出到`response`，输出本身不同时进行)。 -注意，在`request`流和`response`流中，输入输出仅保证单个请求/响应是完整的，多个请求/响应之间是完全“混杂”的，通过session token、operation token区分，通过outhentication key鉴权。`request`流和`response`流始终由信模块控制。注意，通讯模块不负责会话管理。 +注意，在`request`流和`response`流中，输入输出仅保证单个请求/响应是完整的，多个请求/响应之间是完全“混杂”的，通过`session token`、`operation token`（操作标识由用户侧会话管理器维护，~~反正`session token`已经划分频道了，用户开F12瞎改后果自负~~）区分，通过`outhentication key`鉴权。`request`流和`response`流始终由信模块控制。注意，通讯模块不负责会话管理。 ### 内置交互模块 当处于server模式下，不负责会话管理，直接把`std::cin`和`std::cout`的内容转发给通信与调度模块；处于interactive模式下时，提供用户侧会话管理，然后再调用通信与调度模块。 @@ -67,4 +67,46 @@ memoryriver类维护一个缓存，简单地缓存高频访问和连续访问； 云命令行和图形化操作面板分两个页面，通过超链接关联。历史记录、会话信息存储于IndexDB中。负责用户侧会话管理。 #### 云命令行 #### 图形化操作面板 -实际上是一个页面，不同模式下动态绘制。 \ No newline at end of file +实际上是一个页面，不同模式下动态绘制。 + +# 用户交互设计 +## 内置命令 +- `# OpenSession `：向引擎申请一个新会话 +- `# CloseSession `：显示地告知引擎停止某个会话 +- `# ReRequest `：向服务端重新请求调取某次操作响应的缓存 +- `# Request # `：向引擎发送一个请求 + +## 向用户提供的命令 +- `SU `：登录某个用户（登录栈+1） +- `LOGOUT`：退出当前用户（登录栈-1） +- `EXIT`：退出当前会话 +- `$SHUTDOWN`：关闭整个系统（需要最高权限） +- `$REBOOT`：重启整个系统（需要最高权限） +- `REGISTER `：注册用户 +- `ADDUSER [Power]`：添加用户（至少需要销售员权限），权限缺省为客户，且不可超过当前用户的权限 +- `QUERY ( [-ISBN=] | [-AuthorName=] | [-BookName=] | [-KeyWords=] )`：查询图书 +- `BUY [Number]`：购买图书，默认数量是1 +- `IMPORT `：进货（至少需要销售员权限） +- `ADDBOOK `：添加图书信息（至少需要销售员权限） +- `MODIFY [ [-NewISBN=] | [-BookName=] | [-Author=] | [-KeyWordList=] ]`：修改图书信息（至少需要销售员权限） +- `$QUERYIMPORT [-from=] [-till=]`：查看采购情况（需要最高权限） +- `$QUERYSELL [-from=] [-till=]`：查看销售情况（需要最高权限） +- `$QUERYBENEFIT [-from=] [-till=]`：查看盈利情况（需要最高权限） +- `$QUERYOPT [-from=] [-till=] [-operator=]`：查看操作情况（需要最高权限） +- `$QUERYLOG [-from=] [-till=]`：查看日志情况（需要最高权限） + +# 底层数据接口约定（类、结构体设计） +## 请求 +- 引擎接受：内部数据`struct RequestType { std::string SessionToKen, OperationToken, AuthenticationKey; std::any content; };` +- 调度模块接受：`! ! ` +- 内置交互模块（interactive模式）接受：字符串，`` +- 云命令行接受：字符串，`` +- WebUI：图形界面 + +## 响应 +注意，对于申请Session时，响应用``替代` ! ` +- 内置交互模块（interactive模式）返回：字符串，`` +- 云命令行返回：字符串，`` +- WebUI：图形界面 \ No newline at end of file diff --git a/docs/develop/需求分析文档.md b/docs/develop/需求分析文档.md index 722ad4e..b3337c7 100644 --- a/docs/develop/需求分析文档.md +++ b/docs/develop/需求分析文档.md @@ -1,8 +1,30 @@ -# 预设场景 -一个中小规模的书店，个体总量不超过1e5，会话数不超过1e4，每秒请求数不超过1e2，总操作量不超过1e9（~~平均每个个体1e4，回头客很多；1e9除以1e2为1e7，百年老店~~） -# 客户需求 +# 大致预设场景 +一个中小规模的书店，后台运行一个服务端，使得用户、店员、店主可以方便地在电脑端或移动端上完成相关业务操作 +## 功能需求 +### 游客 +- 注册用户 +- 登录用户 +### 客户 通过这个系统，完成图书查询和购买操作 -# 销售员需求 +- 查询图书 +- 购买图书 +### 销售员 通过这个系统，完成进货、图书信息录入、图书信息修改、用户创建操作 -# 店长需求 -系统维护+数据报表查询 \ No newline at end of file +- 进货 +- 图书信息录入 +- 图书信息修改 +- 用户创建 + +### 店长 +系统维护+数据报表查询 +- 按时间段查询采购信息 +- 按销售顺序(时间段)查询销售信息 +- 按时间段查询盈利信息 +- 按操作顺序和员工姓名查看操作记录 +- 查看系统的整体工作日志 + +## 非功能需求 +### 性能要求 +个体总量不超过1e5，会话数不超过1e4，平均每秒请求数不超过1e2，峰值不超过1e3，总操作量不超过1e9 +### 成本要求 +开发时间成本不超过80人·时 \ No newline at end of file