项目架构
项目文件架构说明¶
整体结构¶
这是小说阅读系统整体架构图,展示了系统从下到上不同层次的组成和功能。

项目整体可按职责概括为以下四层:
- 数据层:使用 MySQL(或兼容数据库)存储用户、书籍、评论等业务数据,并使用 Redis 缓存部分数据。
- 服务层:
novel-reader-server基于 Express,处理业务逻辑和 API 请求,并通过数据库模块访问数据。 - 应用层:
novel-reader基于 React,负责呈现界面并响应用户操作。 - 业务功能层:包含阅读器、用户管理、书籍管理和评论管理等面向用户的功能。
前端结构¶
下面是小说阅读器前端架构图(Novel Reader 2.0)。图中展示了项目代码和功能模块的组织方式。
主要目录和功能:
- App 主入口:作为整个应用的起始点,负责初始化应用程序,加载其他必要的模块和组件,是整个项目运行的关键起点。
- pages 页面:管理应用中的不同页面,每个页面可能对应着小说阅读器的不同功能视图,方便进行页面级别的开发和管理。
- model 数据模型:定义应用中的数据模型和业务逻辑对象,例如书籍信息模型,帮助规范数据结构并为其他模块提供数据交互基础。
- reducer 状态更新:配合 Redux 处理应用状态变化。集中管理共享状态有助于追踪状态更新。
- router 路由管理:负责管理应用中的路由,决定用户在不同 URL 路径下看到的页面内容,实现页面之间的跳转和导航功能。
- main 中间阅读区组件:
- API 接口:用于与后端服务器进行数据交互,获取书籍内容、用户信息等数据,或者向服务器发送操作请求,如评论等。
- locale 国际化支持:实现多语言功能,使应用能够根据用户的语言设置显示不同语言的界面内容,扩大应用的使用范围。
- common 公共组件:包含可复用组件,如文本预览(text viewer)、登录(login)和提示消息(toast)等。
- 其他功能:还包括页面滚动、高级入口等功能组件,丰富阅读体验。
- nav 左侧导航栏组件:提供用户快速访问不同功能的入口,如章节列表、小说列表、添加小说、在线搜索,方便用户操作。
- settings 右侧设置栏:
- basic settings 基本设置:包含主题、文字和全屏等个性化选项。
- advanced settings 高级设置:包含语言、分享等选项。
- admin - settings 管理员设置:专门为管理员提供的功能,如管理页面、处理用户书籍评论等,有助于维护应用的秩序和内容管理。
- utils 工具目录:提供各种实用工具函数,如快捷键处理、事件处理、格式转换、章节提取、本地存储管理等,为项目的各个部分提供功能性支持。

其他目录:
- media:存放字体图标和图片等静态资源。
- public:包含入口 HTML 文件,是整个 Web 应用的基础页面结构,所有的 JavaScript 和 CSS 等资源都会在这个 HTML 文件中进行加载和初始化。
- 开发配置文件:涵盖了多个开发和测试工具的配置文件,如 webpack 用于项目的打包和构建,cypress 用于端到端测试,babel 用于代码的转译等,确保项目在不同环境下能够正常运行和测试。
- tests 测试:包含多种测试功能,如 API 测试、镜像测试等,以及工具函数测试,通过这些测试可以保证项目的质量和稳定性,及时发现和修复潜在的问题。
后端结构¶
这是基于 Express 的小说阅读器服务器(Novel Reader Express Server 2.0)项目架构图:
- bin:存放启动脚本,用于启动整个服务器应用。
- public:存储公共样式文件,负责网页的外观显示风格。
- src 主要代码
- app:程序主入口,初始化应用并加载其他模块。
- config:包含配置文件,如处理跨域和错误处理等设置。
- middlewares:中间件目录,包含监听 API、令牌验证等功能,在请求处理过程中发挥作用。
- utils:工具目录,提供标签提取、日志记录、数据库连接等工具函数。
- routes:路由目录,定义各类 API 接口,如测试路由、用户管理、小说管理等。
- views:视图函数,管理不同页面,如主页、登录、登出和错误页面。
- schedule:设置定期任务,自动执行特定操作。
- tests:用于单元测试,保证各功能模块正常运行。
- upgrade:存放数据库升级语句,方便更新数据库结构和内容。
- 其他配置:涉及 docker 和 babel 相关配置,用于项目的容器化部署和代码转换。
