Beta阶段技术规格说明书

最新推荐文章于 2024-10-08 17:50:05 发布

gg_equal_G

最新推荐文章于 2024-10-08 17:50:05 发布

阅读量134

点赞数

文章标签：规格说明书软件工程

本文链接：https://blog.csdn.net/gg_equal_g/article/details/130746540

版权

Ficus是一款由gg=G团队开发的Markdown文档编辑管理工具，旨在提供类似榕树的浏览和编辑体验。软件采用Vue3和Electron框架，支持多平台。其架构包括应用层、控制层、数据层和系统层，其中控制层实现状态管理，数据层负责IR与Markdown的转换及历史快照，系统层处理文件系统和应用事件。此外，Ficus还包含了单元测试和多种测试方案确保软件质量。

摘要由CSDN通过智能技术生成

一、概述&技术栈

1.1 产品概述

$\tt{Ficus}$ 是一款 markdown 文档的编辑管理软件，由 $\tt{gg=G}$ 团队开发。

$\tt{Ficus}$ 释义为“榕树”，榕树具有“冠盖如伞、一木成林“的特点。这也恰是本款软件想要为用户提供的核心服务：让用户的 md 文档可以像一棵榕树一样被浏览和编辑，同时让用户的多个 md 文档像榕树林一样进行多种形式的关联。

1.2 技术栈

Ficus 基于 Vue3 和 Electron 框架开发，支持 Windows、macOS 和 Linux 系统。

二、软件总体架构

软件总体架构如图所示：

请添加图片描述

整个系统大致可以划分为四个模块：

应用层（Renderer）：包含markdown编辑器、图编辑器。
**控制层（Controller）：**调用其他层接口，控制全局数据流动。
**数据层（FicIR）：**markdown中间表示结构，便于转换成线性或树状格式；渲染进程中的文件管理。
**系统层（Backend）：**对应 Electron 中的主进程，负责文件系统和软件更新。

项目目录架构如下：

.
├── build 构建有关资源
├── public 
├── src
│   ├── IR 数据层
│   │   ├── block
│   │   │   ├── base 基本数据结构
│   │   │   └── factory 工厂方法
│   │   ├── component 高级数据结构
│   │   ├── helper 帮助方法
│   │   ├── history 历史记录
│   │   ├── manager 对外管理接口
│   │   └── utils 插件
│   ├── common 共享资源
│   ├── main 主进程
│   │   ├── app 应用入口
│   │   ├── environment 环境
│   │   ├── filesystem 文件系统
│   │   ├── helper 帮助方法
│   │   ├── menu 菜单
│   │   ├── preferences 偏好设置
│   │   └── update 应用更新
│   └── renderer 渲染进程
│       ├── assets
│       ├── components
│       │   ├── header
│       │   ├── mindEditor 图UI
│       │   ├── richTextEditor 编辑器UI
│       │   ├── sideBar
│       │   └── textArea
│       ├── store 状态管理
│       │   └── dataManager
│       └── utils
│           ├── keyboardbinding 键位绑定
│           └── pathHelpter 路径方法
├── static 静态资源
└── test 测试文件夹
    ├── IR
    │   ├── data
    │   ├── factory
    │   └── manager
    ├── common
    └── main
        ├── data
        └── filesystem

2.1 控制层

本质是 Electron 中的渲染进程在该层次执行各种事件。

与主进程交互：进行文件操作时，通过主进程暴露的ipcMain通信接口，执行对应事件；主进程需要对数据层/应用层进行修改时，也是通过控制层挂载在系统层的监听去执行对应事件。
与应用层交互：当需要对应用层界面进行更新时，通过应用层相关方法对数据进行更新；在应用层执行操作时，控制层通过挂载的监听操作对系统层/数据层进行操作
与数据层交互：调用数据层的接口对数据进行读取/修改操作

控制层的作用在设计上类似于MVC架构中的C，实现上可以做到松耦合。在Vuex中进行状态管理。