3.7 KiB
3.7 KiB
YaYa
纯 Android + Jetpack Compose 日历应用。功能:农历/节气/节日、个人班次排期(WORK/OFF 循环)、月/周/年三视图。
README 与实际不符:README 提及 "Kotlin Multiplatform / iOS",实际为纯 Android 项目。模块名为
:core和:app,无:shared或:androidApp。
模块结构
| 模块 | 类型 | 职责 |
|---|---|---|
:core |
com.android.library |
所有 Compose UI、ViewModel、业务逻辑 |
:app |
com.android.application |
薄壳:MainActivity + Manifest + 主题 |
:macrobenchmark |
com.android.test |
Baseline Profile 生成 |
铁律::app 不添加业务逻辑,所有代码写在 :core。
常用命令
./gradlew :app:assembleDebug # 构建 debug APK
./gradlew :app:installDebug # 安装到设备
./gradlew :core:testDebugUnitTest # 运行全部单元测试
./gradlew :core:testDebugUnitTest --tests "plus.rua.project.ui.CalendarUtilsTest" # 单类
./gradlew spotlessApply # 格式化(ktlint)
Baseline Profile 和性能追踪需连接设备:
./gradlew :macrobenchmark:updateBaselineProfile # 生成 + 自动复制到 core/src/main/baseline-prof.txt
./scripts/profile.sh # 默认 8 秒,输出到 logs/
构建配置
- AGP 9.2.1 · Kotlin 2.3.21 · JVM target 17
- compileSdk/targetSdk 37 · minSdk 24
- 版本目录:
gradle/libs.versions.toml - 构建类型:
debug(默认)、release(R8 混淆 + 资源压缩)、trace(release + trace 标记保留)、benchmark(macrobenchmark 专用) - R8:
android.enableR8.fullMode=true(gradle.properties) - 缓存:configuration cache + build cache 已启用
- 版本号:动态
baseVersion_gitHash_buildDate(例:1.0.0_a1b2c_010626) - 格式化:Spotless + ktlint,覆盖
src/**/*.kt和*.gradle.kts(根build.gradle.kts)
包名
:core逻辑层:plus.rua.project:coreUI 层:plus.rua.project.ui:coreandroid.namespace实际为plus.rua.project.shared(build.gradle.kts),但代码包名用plus.rua.project:app:plus.rua.project
代码规范
- 公共
@Composable函数必须有 KDoc(参数说明 + 回调触发时机),见COMMENTS.md Modifier参数始终放签名最后- 回调参数用
on前缀(onDateClick) - 可点击列表项用
Card(onClick = ...)+CardDefaults.cardElevation(defaultElevation = 0.dp),不要用Modifier.clickable()裸包 @Suppress("DEPRECATION")必须附带行内注释说明原因(当前主要用于monthNumber)- UI 文本使用中文
- 禁止
java.util.Calendar,日期逻辑全部用kotlinx-datetime
关键依赖
- Compose BOM
2026.05.01+ Material 3 kotlinx-datetime0.8.0 — 所有日期逻辑tyme4kt1.4.5 — 农历、节气、传统节日sketch4.4.0 — GIF 显示(sketch-compose+sketch-animated-webp)
性能追踪标记
ComposeTrace.kt 提供自定义 Perfetto/Systrace 标记,关键标记名:
MonthView:Compose/YearView:ComposeCalendarPager:Page:*/WeekPager:PageVM:collapseProgress:*YearGridView:*
详见 DEVELOPMENT.md。
参考文档
| 文件 | 内容 |
|---|---|
CLAUDE.md |
完整架构说明、组件树、动画机制、Pager 映射逻辑 |
DEVELOPMENT.md |
性能追踪、Baseline Profile、模拟器启动参数 |
COMMENTS.md |
KDoc 规范、注释原则、反模式清单 |
app/AGENTS.md |
:app 模块细则 |
core/AGENTS.md |
:core 模块细则 |
macrobenchmark/AGENTS.md |
Baseline Profile 模块细则 |