Skip to content

系统架构

项目文件架构说明

服务组成

系统按仓库和职责拆分,在线阅读器的主要调用链为:

genshin-novel-reader-web
        | HTTPS/HTTP + Bearer JWT
        v
genshin-novel-reader-api-node ---- MariaDB
        |                              |
        +------------------------------+ Redis(书籍详情缓存)
        |
        +---- 定时标签任务 ----> genshin-novel-reader-api-python

genshin-novel-reader-scripts:共享数据库、初始化 SQL、配置和开发脚本

阅读器在线业务由 Node API 提供;Python API 仅供 Node 定时任务生成标签使用。

React 阅读器:genshin-novel-reader-web

主要目录位于 src/:

  • App.js:管理当前文件、阅读样式、阅读位置、API 和用户状态,并组合主面板、导航栏和设置面板。
  • features/:按功能组织导航、阅读主面板、导入/搜索对话框和设置。
  • shared/api/:Axios API 封装。
  • shared/i18n/:语言字典和 react-intl-universal 初始化。
  • shared/model/、shared/utils/:文件模型、小说解析、分页/段落转换、键盘及存储等通用逻辑。
  • context.js:通过 React Context 提供 API、用户和移动端状态。

此项目以 React hooks/state 和 Context 管理状态,不使用 Redux,也不以 React Router 管理阅读器页面。Vite 将阅读器构建为可复用的库产物;Node 仓库另有 React 管理界面。

Node 主 API 和 Web:genshin-novel-reader-api-node

  • src/app.js、bin/www:Express 应用和服务启动入口。
  • src/routes/:页面路由及用户、登录、小说、评论、用户书架和管理员 API。
  • src/middlewares/:JWT 验证、角色/资源授权、上传限制、跨域和错误处理。
  • src/utils/:MySQL、Redis、密码、token、Python API 等辅助模块。
  • src/schedule.js:周期性查找缺少标签的书籍并调用 Python 标签 API。
  • src/views/:EJS 页面模板。
  • react/:登录、注册、退出及管理员统计界面的独立 React 前端。
  • tests/:Node 工具和中间件测试。

Python 标签 API:genshin-novel-reader-api-python

app.py 提供 Flask app factory 和 POST /api/tags;tags/ 实现 jieba 分词、停用词过滤、原神角色标签匹配。Node 定时任务调用此服务,书籍数据仍由 Node API 写入 MariaDB。

开发和数据脚本:genshin-novel-reader-scripts

  • docker-compose.yml:本地 MariaDB 和 Redis。
  • sql/init.sql:新数据库完整 schema。
  • scripts/init.sh、scripts/update.sh:仓库初始化/更新和依赖安装。
  • scripts/configure.py:由 .env 生成后端配置。
  • scripts/start-python-api.sh:启动 Python API。

数据库初始化只作用于空数据目录,不包含历史迁移脚本。