内容管理.md 21 KB

内容管理

本文引用的文件

  • server\src\modules\favorites\favorites.service.ts
  • server\src\modules\history\history.controller.ts
  • server\src\modules\history\history-batch.controller.ts
  • server\src\modules\search\search.controller.ts
  • server\src\modules\comments\comments.controller.ts
  • server\src\modules\categories\categories.controller.ts
  • server\src\modules\preferences\preferences.service.ts
  • server\src\modules\player\player.controller.ts
  • server\prisma\schema.prisma
  • my-uniapp-vue3\src\pages\search\index.vue
  • my-uniapp-vue3\src\pages\history\index.vue
  • my-uniapp-vue3\src\pages\favorites\index.vue

目录

  1. 简介
  2. 项目结构
  3. 核心组件
  4. 架构总览
  5. 详细组件分析
  6. 依赖关系分析
  7. 性能考量
  8. 故障排查指南
  9. 结论
  10. 附录

简介

本指南聚焦于内容管理功能,涵盖收藏、历史记录、评论系统、内容组织(分类与标签)、以及用户行为分析与个性化推荐的实现要点与最佳实践。文档基于仓库现有代码进行梳理,帮助开发者与产品人员快速理解并优化内容管理体验。

项目结构

后端采用模块化路由与服务分离的设计,前端通过 uni-app 页面承载交互逻辑。数据库使用 Prisma 定义模型,统一管理用户、收藏、历史、评论、偏好等数据。

graph TB
subgraph "前端(uni-app)"
FE_Search["搜索页<br/>search/index.vue"]
FE_History["历史页<br/>history/index.vue"]
FE_Fav["收藏页<br/>favorites/index.vue"]
end
subgraph "后端(Koa)"
API_Search["搜索控制器<br/>search.controller.ts"]
API_History["历史控制器<br/>history.controller.ts"]
API_History_Batch["历史批量控制器<br/>history-batch.controller.ts"]
API_Comments["评论控制器<br/>comments.controller.ts"]
API_Categories["分类控制器<br/>categories.controller.ts"]
API_Player["播放控制器<br/>player.controller.ts"]
API_Preferences["偏好服务<br/>preferences.service.ts"]
end
DB["数据库模型<br/>schema.prisma"]
FE_Search --> API_Search
FE_History --> API_History
FE_History --> API_History_Batch
FE_Fav --> API_Search
API_Search --> DB
API_History --> DB
API_History_Batch --> DB
API_Comments --> DB
API_Categories --> DB
API_Player --> DB
API_Preferences --> DB

图表来源

  • server\src\modules\search\search.controller.ts:1-170
  • server\src\modules\history\history.controller.ts:1-67
  • server\src\modules\history\history-batch.controller.ts:1-105
  • server\src\modules\comments\comments.controller.ts:1-59
  • server\src\modules\categories\categories.controller.ts:1-55
  • server\src\modules\player\player.controller.ts:1-344
  • server\src\modules\preferences\preferences.service.ts:1-74
  • server\prisma\schema.prisma:1-470

章节来源

  • server\prisma\schema.prisma:1-470

核心组件

  • 收藏功能:后端提供收藏查询、添加、取消与存在性检查;前端展示收藏列表并支持移除。
  • 历史记录:后端提供历史列表查询与批量删除;前端支持筛选、搜索、批量操作与下载。
  • 搜索与历史:后端提供搜索、热门词、搜索历史的增删查;前端负责渲染与交互。
  • 评论系统:后端提供章节评论查询与新增;前端负责展示与提交。
  • 分类与标签:后端提供分类列表与按分类获取音频;前端负责展示与跳转。
  • 用户偏好:后端提供偏好读取与更新;前端负责设置项。
  • 播放进度:后端提供播放进度的读取、保存、更新与批量删除;前端负责播放器交互。

章节来源

  • server\src\modules\favorites\favorites.service.ts:1-103
  • server\src\modules\history\history.controller.ts:1-67
  • server\src\modules\history\history-batch.controller.ts:1-105
  • server\src\modules\search\search.controller.ts:1-170
  • server\src\modules\comments\comments.controller.ts:1-59
  • server\src\modules\categories\categories.controller.ts:1-55
  • server\src\modules\preferences\preferences.service.ts:1-74
  • server\src\modules\player\player.controller.ts:1-344

架构总览

后端模块通过 Koa 路由暴露 REST 接口,服务层封装业务逻辑,Prisma 作为 ORM 访问 MySQL。前端页面通过统一请求工具调用接口,完成内容管理相关操作。

sequenceDiagram
participant U as "用户"
participant FE as "前端页面"
participant API as "后端控制器"
participant S as "服务层"
participant DB as "数据库"
U->>FE : 触发收藏/历史/搜索/评论等操作
FE->>API : 发起HTTP请求
API->>S : 调用服务层处理业务
S->>DB : 查询/插入/更新/删除
DB-->>S : 返回数据
S-->>API : 返回处理结果
API-->>FE : 返回JSON响应
FE-->>U : 展示结果/更新UI

图表来源

  • server\src\modules\search\search.controller.ts:1-170
  • server\src\modules\history\history.controller.ts:1-67
  • server\src\modules\history\history-batch.controller.ts:1-105
  • server\src\modules\comments\comments.controller.ts:1-59
  • server\src\modules\player\player.controller.ts:1-344
  • server\prisma\schema.prisma:1-470

详细组件分析

收藏功能

  • 实现机制
    • 查询收藏:按用户 ID 查询收藏列表,并关联书籍信息。
    • 去重策略:收藏表对用户与书籍建立唯一索引,防止重复收藏。
    • 添加收藏:若已存在则直接返回,否则创建新记录。
    • 取消收藏:按用户+书籍唯一键删除。
    • 存在性检查:根据唯一键查询是否存在。
  • 前端交互
    • 收藏页展示收藏列表,支持点击播放与移除收藏。
  • 最佳实践

    • 建议在前端展示“已收藏”状态,减少重复请求。
    • 对批量收藏/取消场景,可在服务层增加幂等接口以提升稳定性。

      flowchart TD
      Start(["开始"]) --> CheckExist["检查是否已收藏"]
      CheckExist --> Exists{"已收藏?"}
      Exists --> |是| ReturnExisting["返回现有记录"]
      Exists --> |否| Create["创建收藏记录"]
      Create --> ReturnCreated["返回新建记录"]
      ReturnExisting --> End(["结束"])
      ReturnCreated --> End
      

图表来源

  • server\src\modules\favorites\favorites.service.ts:34-69

章节来源

  • server\src\modules\favorites\favorites.service.ts:1-103
  • my-uniapp-vue3\src\pages\favorites\index.vue:1-45

历史记录系统

  • 播放历史追踪
    • 历史记录模型包含音频标识、标题、字数、时长、音色参数、状态、所属书籍等字段。
    • 前端历史页支持按“全部/今天/本周/本月”筛选,支持关键词搜索与分页。
  • 批量操作
    • 提供批量删除接口,接收音频 ID 数组,后端一次性删除匹配记录。
    • 前端支持编辑模式下的全选、批量删除与批量下载。
  • 清理策略

    • 前端提供清空搜索历史入口(针对搜索历史,非播放历史)。
    • 历史记录按时间范围与关键词过滤,便于用户自助清理。

      sequenceDiagram
      participant FE as "前端历史页"
      participant API as "历史控制器"
      participant Batch as "历史批量控制器"
      participant DB as "数据库"
      FE->>API : GET /history?page&pageSize&startDate&keyword
      API->>DB : 查询AudioRecord并计数
      DB-->>API : 返回列表与总数
      API-->>FE : 返回分页结果
      FE->>Batch : POST /history/batch-delete {ids}
      Batch->>DB : deleteMany(audioId in ids)
      DB-->>Batch : 返回删除数量
      Batch-->>FE : 返回成功与删除数量
      

图表来源

  • server\src\modules\history\history.controller.ts:11-64
  • server\src\modules\history\history-batch.controller.ts:11-49
  • server\prisma\schema.prisma:352-373

章节来源

  • server\src\modules\history\history.controller.ts:1-67
  • server\src\modules\history\history-batch.controller.ts:1-105
  • my-uniapp-vue3\src\pages\history\index.vue:308-360

搜索历史与热门词

  • 搜索历史
    • 前端在每次搜索后保存历史,支持单条删除与清空。
    • 后端提供历史查询、保存、删除单条、清空全部接口。
  • 热门推荐
    • 前端加载热门词并缓存,搜索结果返回后更新缓存。
  • 前端交互

    • 搜索页展示历史与热门词,支持点击回填与搜索。

      sequenceDiagram
      participant FE as "前端搜索页"
      participant API as "搜索控制器"
      participant DB as "数据库"
      FE->>API : GET /search/hot?limit
      API->>DB : 查询热门词
      DB-->>API : 返回热门词列表
      API-->>FE : 返回热门词
      FE->>API : POST /search/history {userId, keyword}
      API->>DB : 插入搜索历史
      DB-->>API : 返回成功
      API-->>FE : 返回成功
      FE->>API : GET /search/history?userId&limit
      API->>DB : 查询历史
      DB-->>API : 返回历史列表
      API-->>FE : 返回历史
      

图表来源

  • server\src\modules\search\search.controller.ts:64-167
  • my-uniapp-vue3\src\pages\search\index.vue:167-250
  • server\prisma\schema.prisma:220-240

章节来源

  • server\src\modules\search\search.controller.ts:1-170
  • my-uniapp-vue3\src\pages\search\index.vue:1-468

评论系统

  • 架构设计
    • 评论模型包含章节、用户、内容与评分,支持按章节查询评论列表。
    • 控制器提供按章节获取评论与新增评论接口。
  • 前端交互

    • 前端页面可展示评论列表,结合章节详情页进行评论发布与查看。

      sequenceDiagram
      participant FE as "前端评论页"
      participant API as "评论控制器"
      participant S as "评论服务"
      participant DB as "数据库"
      FE->>API : GET /api/comments/ : chapterId
      API->>S : getCommentsByChapterId
      S->>DB : 查询评论
      DB-->>S : 返回评论列表
      S-->>API : 返回评论
      API-->>FE : 返回评论数据
      FE->>API : POST /api/comments {chapterId, content, rating}
      API->>S : addComment
      S->>DB : 插入评论
      DB-->>S : 返回评论
      S-->>API : 返回评论
      API-->>FE : 返回成功与评论
      

图表来源

  • server\src\modules\comments\comments.controller.ts:13-56
  • server\prisma\schema.prisma:107-119

章节来源

  • server\src\modules\comments\comments.controller.ts:1-59
  • server\prisma\schema.prisma:107-119

内容组织:分类与标签

  • 分类列表与分类下音频
    • 控制器提供获取分类列表与按分类获取音频的接口。
    • 前端可展示分类与对应内容,支持跳转到详情或播放。
  • 标签映射

    • 服务层提供分类到标签的映射逻辑,便于前端展示。

      sequenceDiagram
      participant FE as "前端分类页"
      participant API as "分类控制器"
      participant S as "分类服务"
      participant DB as "数据库"
      FE->>API : GET /api/categories
      API->>S : 获取分类列表
      S->>DB : 查询分类
      DB-->>S : 返回分类
      S-->>API : 返回分类列表
      API-->>FE : 返回分类
      FE->>API : GET /api/categories/ : id?page&pageSize
      API->>S : 按分类获取音频
      S->>DB : 查询音频
      DB-->>S : 返回音频列表
      S-->>API : 返回音频
      API-->>FE : 返回音频列表
      

图表来源

  • server\src\modules\categories\categories.controller.ts:10-52
  • server\prisma\schema.prisma:130-192

章节来源

  • server\src\modules\categories\categories.controller.ts:1-55
  • server\prisma\schema.prisma:130-192

用户行为分析与个性化推荐

  • 播放统计与偏好
    • 播放进度接口支持读取、保存、更新与批量删除,可用于统计播放时长、频率与偏好。
    • 偏好服务提供播放速度、音质、主题、默认音色、音量、自动下一首、仅WiFi下载等设置。
  • 个性化推荐

    • 建议基于播放历史、收藏、搜索历史与偏好设置构建简单协同过滤或基于内容的推荐。
    • 可在播放器页或首页展示“为你推荐”卡片,引导用户发现内容。

      sequenceDiagram
      participant FE as "前端播放器/首页"
      participant API as "播放控制器"
      participant Pref as "偏好服务"
      participant DB as "数据库"
      FE->>API : GET /api/player/progress?audioId
      API->>DB : 查询播放进度
      DB-->>API : 返回进度
      API-->>FE : 返回进度
      FE->>API : POST /api/player/progress {audioId, progress, duration}
      API->>DB : 保存/更新进度
      DB-->>API : 返回记录
      API-->>FE : 返回成功
      FE->>Pref : GET /api/preferences
      Pref->>DB : upsert用户偏好
      DB-->>Pref : 返回偏好
      Pref-->>FE : 返回偏好
      

图表来源

  • server\src\modules\player\player.controller.ts:14-132
  • server\src\modules\preferences\preferences.service.ts:8-73
  • server\prisma\schema.prisma:63-92

章节来源

  • server\src\modules\player\player.controller.ts:1-344
  • server\src\modules\preferences\preferences.service.ts:1-74

依赖关系分析

  • 数据模型依赖
    • 用户与收藏、评论、播放记录、偏好等存在一对多/一对一关系。
    • 历史记录与书籍存在可选关联,便于跳转详情。
  • 控制器耦合
    • 控制器主要负责参数校验与响应封装,业务逻辑集中在服务层,降低耦合度。
  • 外部依赖

    • 前端通过统一请求工具调用后端接口,接口风格一致,便于扩展。

      erDiagram
      USER {
      int id PK
      string phone
      string openid
      int memberLevel
      int dailyUsage
      string lastUsageDate
      }
      FAVORITE {
      int id PK
      int userId FK
      int bookId FK
      datetime createdAt
      }
      COMMENT {
      int id PK
      int userId FK
      int chapterId FK
      int rating
      text content
      datetime createdAt
      }
      PLAYRECORD {
      int id PK
      int userId FK
      int chapterId FK
      float progress
      float duration
      datetime createdAt
      datetime updatedAt
      }
      USERPREFERENCE {
      int id PK
      int userId FK
      float playSpeed
      string quality
      string theme
      string defaultVoiceId
      int defaultVolume
      bool autoPlayNext
      bool wifiOnlyDownload
      }
      AUDIORECORD {
      int id PK
      int userId
      string audioId
      string title
      int wordCount
      string voiceId
      int audioDuration
      int audioSize
      string status
      int bookId
      datetime createdAt
      datetime updatedAt
      }
      BOOKCHAPTER {
      int id PK
      int bookId FK
      int parentId
      int level
      int number
      string title
      int wordCount
      string audioUrl
      int audioDuration
      bool isPublic
      }
      BOOK {
      int id PK
      int userId
      string title
      string description
      int totalChapters
      int estimatedWords
      bool isPublished
      }
      USER ||--o{ FAVORITE : "收藏"
      USER ||--o{ COMMENT : "发表评论"
      USER ||--o{ PLAYRECORD : "播放记录"
      USER ||--o{ AUDIORECORD : "生成历史"
      USER ||--o{ USERPREFERENCE : "偏好设置"
      BOOK ||--o{ FAVORITE : "被收藏"
      BOOK ||--o{ BOOKCHAPTER : "包含章节"
      BOOKCHAPTER ||--o{ COMMENT : "被评论"
      BOOKCHAPTER ||--o{ PLAYRECORD : "被播放"
      

图表来源

  • server\prisma\schema.prisma:10-470

章节来源

  • server\prisma\schema.prisma:1-470

性能考量

  • 分页与索引
    • 历史与分类接口均使用分页与索引,建议在高频查询字段上保持索引策略。
  • 批量操作
    • 批量删除使用 deleteMany,减少多次往返,提升性能。
  • 前端缓存
    • 搜索页对热门词进行本地缓存,降低重复请求与后端压力。
  • 数据一致性
    • 收藏与播放进度使用唯一键约束,避免重复与脏数据。

故障排查指南

  • 搜索历史异常
    • 若搜索历史为空,检查前端缓存读取与后端历史接口返回。
    • 单条删除与清空接口需确保 userId 与 keyword 参数正确传递。
  • 历史批量删除失败
    • 确认 ids 数组格式与长度,后端会拒绝非数组或空数组。
  • 评论接口报错
    • 新增评论需提供合法的章节 ID、内容与评分,后端会进行参数校验。
  • 播放进度异常
    • 保存/更新进度需提供 audioId、progress、duration,后端会抛出参数错误。
  • 偏好设置未生效
    • 确认前端 PUT 请求体字段与后端 upsert 逻辑一致。

章节来源

  • server\src\modules\search\search.controller.ts:88-167
  • server\src\modules\history\history-batch.controller.ts:17-49
  • server\src\modules\comments\comments.controller.ts:35-56
  • server\src\modules\player\player.controller.ts:42-74
  • server\src\modules\preferences\preferences.service.ts:33-73

结论

本项目在内容管理方面具备清晰的模块划分与完善的数据库模型支撑。收藏、历史、搜索、评论、分类与偏好等功能均已具备基础实现,建议后续在以下方面持续优化:

  • 引入更丰富的用户行为指标与推荐算法,提升个性化体验。
  • 完善内容审核与合规检查流程,保障内容质量。
  • 优化前端交互细节,如加载态、错误提示与批量操作反馈。
  • 增强日志与监控,定位性能瓶颈与异常路径。

附录

  • 前端页面与接口对照
    • 搜索页:调用搜索、热门词、搜索历史接口,支持历史删除与清空。
    • 历史页:调用历史列表与批量删除接口,支持筛选与搜索。
    • 收藏页:展示收藏列表,支持移除收藏。
  • 数据模型要点
    • 收藏、评论、播放记录、历史记录与用户偏好均有明确的外键与索引。
    • 历史记录与书籍存在可选关联,便于跳转详情。