OFPlayer Main 分支技术文档
本文档为 OFPlayer Web 版(main 分支)的完整技术参考文档,面向开发者和二次开发人员。
文档目录
| 文档 | 内容 |
|---|---|
| 项目概述 | 项目简介、技术栈、核心特性 |
| 架构设计 | 分层架构、数据流、模块职责 |
| 组件文档 | Vue 组件详解、Props/Emit 接口 |
| 状态管理 | Store 设计、响应式状态、数据同步 |
| 服务层 | 业务服务、数据访问层、外部集成 |
| 数据模型 | 实体定义、字段规范、工厂函数 |
| 工具函数 | 通用工具库、解析器、构建器 |
| 主题系统 | 主题架构、CSS 变量、扩展指南 |
| 二次开发指南 | 扩展建议、最佳实践、注意事项 |
快速导航
我想…
- 了解项目整体结构 → 项目概述
- 理解代码如何组织 → 架构设计
- 修改或添加 UI 组件 → 组件文档
- 扩展播放器功能 → 状态管理 + 服务层
- 添加新的数据源 → 服务层 + 数据模型
- 自定义主题外观 → 主题系统
- 进行二次开发 → 二次开发指南
技术栈概览
| 层级 | 技术 |
|---|---|
| 框架 | Vue 3 (Composition API) |
| 构建 | Vite 8 |
| 路由 | Vue Router 4 |
| 图标 | lucide-vue-next |
| 元数据 | music-metadata |
| 播放 | HTMLAudioElement |
| 持久化 | IndexedDB / localStorage |
| 样式 | CSS Custom Properties |
项目定位
OFPlayer 是一个本地优先的网页音乐播放器,核心设计原则:
- 无账号系统 - 所有数据存储在用户设备
- 无云同步 - 完全离线可用
- 极简依赖 - 仅 Vue + Vite + 两个辅助库
- 桌面级体验 - 通过 Tauri 支持原生桌面应用