跳转到内容

ChsocWiki项目设计方案

来自MyWiki

模板:项目信息

ChsocWiki项目设计方案[编辑 | 编辑源代码]

项目概述[编辑 | 编辑源代码]

ChsocWiki 是一个基于Flutter的现代化跨平台MediaWiki客户端,支持Android、Linux和Web平台。

核心价值[编辑 | 编辑源代码]

  • 🚀 跨平台:一次开发,多端部署
  • 📱 移动优先:为移动设备优化的用户体验
  • 🔗 无缝集成:与现有MediaWiki服务器完美对接
  • 🎨 现代化界面:Material Design设计语言
  • 🔧 完整功能:涵盖Wiki所有核心功能

技术架构[编辑 | 编辑源代码]

技术栈[编辑 | 编辑源代码]

前端框架: Flutter 3.27.1
编程语言: Dart 3.6.0
状态管理: Riverpod 2.4.9
路由管理: GoRouter 14.1.4
网络请求: Dio 5.4.3
本地存储: SharedPreferences + Hive
构建目标: Android, Linux, Web

架构模式[编辑 | 编辑源代码]

┌─────────────────────────────────────────┐
│            Presentation Layer           │
│  ┌─────────┐  ┌─────────┐  ┌─────────┐ │
│  │  Pages  │  │ Widgets │  │ Themes  │ │
│  └─────────┘  └─────────┘  └─────────┘ │
├─────────────────────────────────────────┤
│             Domain Layer                │
│  ┌─────────┐  ┌─────────┐  ┌─────────┐ │
│  │ Models  │  │  Use    │  │  Error  │ │
│  │         │  │  Cases  │  │ Handler │ │
│  └─────────┘  └─────────┘  └─────────┘ │
├─────────────────────────────────────────┤
│              Data Layer                 │
│  ┌─────────┐  ┌─────────┐  ┌─────────┐ │
│  │   API   │  │  Local  │  │ Repo-   │ │
│  │ Clients │  │ Storage │  │ sitory  │ │
│  └─────────┘  └─────────┘  └─────────┘ │
└─────────────────────────────────────────┘

核心功能[编辑 | 编辑源代码]

1. 用户认证[编辑 | 编辑源代码]

  • ✅ 传统MediaWiki API登录
  • ✅ 会话持久化(Remember Me)
  • ✅ 自动刷新和状态管理
  • ✅ 安全退出和多设备同步

2. 文章浏览[编辑 | 编辑源代码]

  • ✅ 文章内容获取和显示
  • ✅ Markdown格式渲染
  • ✅ 6种显示风格切换(GFM、Material、极简、Wiki、深色、多彩)
  • ✅ 渐进式加载和缓存

3. 搜索功能[编辑 | 编辑源代码]

  • ✅ 全文搜索
  • ✅ 搜索建议
  • ✅ 搜索历史记录
  • ✅ 热门搜索推荐
  • ✅ 搜索结果分页

4. 编辑功能[编辑 | 编辑源代码]

  • ✅ Markdown编辑器
  • ✅ 实时预览
  • ✅ 语法高亮
  • ✅ 编辑历史
  • ✅ 冲突检测

5. 个人资料[编辑 | 编辑源代码]

  • ✅ 用户信息显示
  • ✅ 贡献统计
  • ✅ 编辑历史
  • ✅ 成就系统
  • ✅ 偏好设置

6. 设置系统[编辑 | 编辑源代码]

  • ✅ 主题设置(浅色/深色/系统)
  • ✅ 字体大小调整
  • ✅ Markdown显示风格
  • ✅ 图片质量设置
  • ✅ 数据管理(清除缓存/历史)

项目状态[编辑 | 编辑源代码]

当前版本[编辑 | 编辑源代码]

  • 版本号: v1.0.0-beta
  • 构建时间: 2026-03-08
  • 代码行数: ~15,000行
  • 测试覆盖率: 85%+
  • APK大小: 93MB (Debug)

开发进度[编辑 | 编辑源代码]

  • 已完成 (100%): 基础架构搭建、用户认证系统、文章浏览功能、搜索功能、编辑功能
  • 🔄 进行中 (80%): 高级搜索功能、Markdown显示风格、性能优化
  • 📅 计划中 (0%): 离线阅读、图片管理、通知系统

快速开始[编辑 | 编辑源代码]

开发环境[编辑 | 编辑源代码]

# 克隆项目
git clone ssh://git@192.168.2.99/volume1/git_repos/chsoc-wiki-app.git
cd chsoc-wiki-app

# 安装依赖
flutter pub get

# 运行应用
flutter run              # 默认设备
flutter run -d chrome    # Web浏览器
flutter run -d linux     # Linux桌面

构建命令[编辑 | 编辑源代码]

# 调试版本
flutter build apk --debug

# 发布版本
flutter build apk --release
flutter build appbundle --release
flutter build web --release
flutter build linux --release

测试信息[编辑 | 编辑源代码]

详细文档[编辑 | 编辑源代码]

完整的项目设计方案、技术文档和API文档请查看项目Git仓库:

  • `CHSOCWIKI_PROJECT_DESIGN.md` - 详细设计方案
  • `CHSOCWIKI_PROJECT_OVERVIEW.md` - 项目概览
  • `CHSOCWIKI_QUICK_REFERENCE.md` - 快速参考

联系和支持[编辑 | 编辑源代码]

更新记录[编辑 | 编辑源代码]

  • 2026-03-08: 创建项目设计方案页面
  • 2026-02-28: 完成基础版本开发
  • 2026-02-26: 实现核心功能模块
  • 2026-02-25: 项目初始化