Appearance
v4 版本文档索引
本文档为筷字输入法 v4(Kotlin 重构版)的文档索引和核心工作说明。v4 版本对 Java 版本进行全面重构,采用 Kotlin 2.3.20 + Jetpack Compose BOM 2026.04.01,目标 SDK 35,最低 SDK 25。
核心工作说明
v4 版本的核心目标是将整个项目从 Java 迁移到 Kotlin,同时:
- 保持功能完整性:Java 版本已实现的每一项功能都必须在 Kotlin 版本中保留,可以改进但不能缺失或遗漏
- 消除历史包袱:利用 Kotlin 特性大胆移除或简化原设计和实现中的不规范、不合理、冗余之处(包括移除 alpha 变体等不再需要的构建类型)
- 现代化架构:采用 MVI 架构、协程 / Flow、Jetpack Compose 等现代 Android 开发技术
- 代码规范:严格遵循「显式优于隐式」、「任其崩溃」等原则
- 新增功能:支持导入 / 导出用户数据到文件,便于换机迁移和数据备份
重构原则
| 原则 | 说明 |
|---|---|
| 显式优于隐式 | 所有公开 API 必须有显式声明,状态变更必须有迹可循 |
| 任其崩溃 | 遇到不可恢复的错误立即失败,不静默降级 |
| 不可变优先 | 数据默认不可变,状态变更通过创建新实例 |
| 单向数据流 | 状态自上而下流动,事件自下而上传递 |
| 组合优于继承 | 优先使用组合和委托,避免深层继承链 |
文档目录
| 目录 | 说明 | 索引 |
|---|---|---|
design/ | 架构和功能设计文档,始终实时更新 | design/index.md |
tests/ | 单元测试用例文档,由软件验收员编写和维护 | tests/index.md |
plans/ | 开发计划文档,始终实时更新 | plans/index.md |
discussions/ | 与用户的讨论记录,只追加不修改 | discussions/index.md |
logs/ | 开发日志,只追加不修改 | logs/index.md |
bugs/ | 缺陷修复记录,只追加不修改 | bugs/index.md |