zijunchiang/maidong-ktv
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases 9 Wiki Activity
Files
221516f3194cf31ee4be5da1ae13dd2568436526
maidong-ktv/AGENTS.md
T

8.8 KiB
Raw Blame History

麦动 KTV — 项目开发约定

本文件供后续开发（含 AI 助手会话）遵循，优先级高于默认习惯。

一、代码同步与发布策略（2026-09-14 更新）

代码主仓库：Gitea https://gitea.kasugano.cn/zijunchiang/maidong-ktv

远端 地址 用途
origin https://gitea.kasugano.cn/zijunchiang/maidong-ktv.git ✅ 代码主仓库，唯一的代码同步目标
gitee https://gitee.com/zijunchiang/maidong-ktv.git 📦 不推代码，只用于发布 Release；仓库内只保留 README 文档 + Releases 附件

四条硬性规则

  1. 推送失败只重试 3 次：Gitea 不可用（网络不通／服务器故障／返回非 200）时，最多重试 3 次 （间隔约 60s）。3 次仍失败就停止重试，改动保留为本地 commit，留到下次一起同步 （不要无限重试、不要为了"推上去"而改推 Gitee）。恢复同步时直接 git push origin master 把积压的 commit 一并推上即可。
  2. Gitee 不再同步代码，只发布版本：Gitee 仓库保持「仅 README 文档 + Releases 附件」状态， 禁止推送源码（pre-push 钩子会拦截 gitee.com）。Gitee 上只做一件事：创建 Release 并上传 APK 附件。
  3. 每次更新版本号 +1：完成一次修改就把版本号递增（versionName 与 versionCode 同步递增）， 例如 1.3.0 → 1.3.1 → 1.3.2。不要在同一个版本号下反复改动交付。
  4. 发布是手动操作：未收到明确的「发布新版本」指令时，默认只在本地打包测试—— 产物按内部测试约定命名 maidong-ktv-<版本>-<改动说明>-双ABI-release.apk， 不创建 Release、不上传附件、不推送 tag、不在 Gitee 建 Release。 只有收到发布指令后，才按「发布新版本」小节在 Gitea（以及需要的 Gitee）建 Release。
  • 凭据：Gitea 访问令牌 dsh-sync（可在 Gitea「设置 → 应用 → 访问令牌」随时吊销）， 存放于 ~/.git-credentials-gitea（权限 600），由本仓库级 credential.helper 引用； 账号密码不写入仓库配置。

推送方式

cd /home/zijun/dsh/maidongktv/maidong-ktv
git push origin master              # origin = Gitea（唯一的代码同步目标）

Gitee 不参与代码同步；确需回推文档时用 git push --no-verify gitee master， 但按规则 2 正常情况下不应执行。

运行时端点（已全部迁移到 Gitea）

App 内部两处端点已指向 Gitea（随本版 APK 生效）：

  • AppUpdateManager.kt：gitea.kasugano.cn/api/v1/repos/zijunchiang/maidong-ktv/releases/latest（App 内检查更新）
  • KtvJsBridge.kt：gitea.kasugano.cn/zijunchiang/maidong-ktv/raw/branch/master/app/src/main/assets/mobile/ktv_api.js（JS 热更新）

注意：Gitea 的 raw 规范路径是 /raw/branch/<分支>/<文件>；/raw/<分支>/<文件> 会 303 跳转。 Gitea 的 raw 与 release 下载对无 User-Agent 的请求同样放行（App 裸 socket 可直连）。

发布新版本（Gitea Release）

TOKEN=$(sed -E 's|https://zijunchiang:([^@]+)@.*|\1|' ~/.git-credentials-gitea)

# 1) 创建 Release（tag 需高于当前 versionName 才会提示更新）
curl -X POST -u "zijunchiang:$TOKEN" -H "Content-Type: application/json" \
  -d '{"tag_name":"v1.2.6","name":"麦动KTV V1.2.6","body":"更新说明","target_commitish":"master"}' \
  https://gitea.kasugano.cn/api/v1/repos/zijunchiang/maidong-ktv/releases

# 2) 上传 APK 附件（用返回的 release id；附件名必须 ASCII）
curl -X POST -u "zijunchiang:$TOKEN" \
  -F "attachment=@麦动KTV-V1.2.6-release.apk" \
  "https://gitea.kasugano.cn/api/v1/repos/zijunchiang/maidong-ktv/releases/<id>/assets?name=maidong-ktv-V1.2.6-release.apk"

⚠️ 附件文件名必须为 ASCII：Gitea 1.27 的规范下载路径 /releases/download/<tag>/<文件名> 对非 ASCII 文件名返回 404（/attachments/<uuid> 直链虽可用， 但 releases/latest API 返回的是规范路径）。因此 Gitea 上的附件用 maidong-ktv-V1.2.x-release.apk 这类 ASCII 名；本地留存的发布包仍可命名 麦动KTV-V1.2.x-release.apk。

上传 22MB APK 约需 70s，注意命令超时设置。

二、构建与产物

构建（release，双 ABI）

cd /home/zijun/dsh/maidongktv/maidong-ktv
export JAVA_HOME=/usr/lib/jvm/java-17-openjdk-amd64
export ANDROID_HOME=/home/zijun/Android/Sdk
export ANDROID_SDK_ROOT=/home/zijun/Android/Sdk
./gradlew assembleRelease

产物：app/build/outputs/apk/release/app-release.apk（已由 app/build.gradle 的 signingConfig 签名）

签名与校验（单独签名/改名时）

BT=/home/zijun/Android/Sdk/build-tools/36.0.0
$BT/apksigner sign --ks /home/zijun/dsh/maidongktv/ktv_keystore.jks \
  --ks-key-alias ktv --ks-pass pass:123456 --key-pass pass:123456 \
  --out 目标名.apk app/build/outputs/apk/release/app-release.apk
$BT/apksigner verify 目标名.apk
  • 密钥：/home/zijun/dsh/maidongktv/ktv_keystore.jks（仓库外，勿入库）
  • APK 命名约定：麦动KTV-V<版本号>-release.apk（对外发布）/ maidong-ktv-<版本>-<改动说明>-双ABI-release.apk（内部测试）

版本号

  • app/build.gradle：versionName "1.3.1" / versionCode 7
  • App 内显示统一用纯版本号（不加 (versionCode) 括号）

三、关键实现约束（避免踩坑）

  • 歌曲源：app/src/main/assets/mobile/ktv_api.js 的 CONFIG.HOSTS（多源自动排序，失败源沉底）
  • JS 热更新：改动 ktv_api.js 必须同步提升 KTV_BRIDGE_API: N 标记（JS 与 KtvJsBridge.kt 两处校验），否则设备仍用缓存旧脚本
  • 曲库：只走官方 Muse 同步（MuseDbSync），不再依赖代码仓库数据库文件
  • 曲库同步时效：默认 30 天（DatabaseBootstrapper.SYNC_TTL_DAYS）。未到期启动不联网、直接用本地曲库；到期后才查询服务器版本，有更新才下载。时效起点记录在 db_sync_at.txt，由 DatabaseBootstrapper.markSynced() 写入（下载成功或校验为最新时）。设置页「曲库 → 更新」为手动强制检查（绕过时效，仅在服务器版本更新时下载）
  • 麦克风：MicActivator 常驻占用输入通道（TV/投影需占用后才有演唱声音输出），外接设备热插拔会自动重建
  • 设备 MAC：统一由 DeviceMac 解析当前在用网卡的硬件地址（12 位小写十六进制）。优先 wlan*/eth*/en*，忽略虚拟/蜂窝/VPN 接口；Android 6 起 WifiInfo.getMacAddress() 恒为 02:00:00:00:00:00，因此直接读 NetworkInterface.getHardwareAddress()；读出 02:00:00:00:00:00 或全 0 视为无效。读取失败回退 DeviceMac.FALLBACK_MAC（历史抓包值），保证身份永不为空。 结果按进程缓存，网络切换时由 remoteNetworkMonitor 调用 DeviceMac.refresh() 重解析。 消费方：KtvJsBridge.DEVICE_MAC（JS 端 mac）、whoami 心跳的 _mac/androidid/_cid （抓包时三者同值，保持一致）
  • 播放信息实时刷新：refreshNowPlayingLabels() 是播放界面左上角「当前播放 / 下一首」、首页播放条、 旧版播放区与顶部状态栏的唯一刷新入口，只在文本变化时写 View；已挂到 lyricTicker（500ms）上， 因此队列变化（本地点歌 / 扫码点歌 / 自动切歌）最迟 500ms 内必然同步。新增播放信息展示时请复用它， 不要另起刷新路径
  • 远程日志：接入 GlogCenter 集中式日志（HTTP 接口，单条 JSON）。域名属敏感信息，不得写入任何文档 （端点常量见代码 MiliLog.ENDPOINT，需要时查代码，勿在 README/AGENTS 中记录域名）。字段： system/date/text/servername/serverip/clientip/loglevel/traceid/user；date 必须为 yyyy-MM-dd HH:mm:ss.SSS，否则按时间检索异常。其中 serverip = 主机 IP（公网出口 IP， 由 MiliLog.PUBLIC_IP_URL 查询，结果缓存 5 分钟、失败 1 分钟后重试，查询在独立后台线程， 绝不在主线程发起），clientip = 客户端 IP（设备当前网卡获取到的局域网 IP，由 MiliLog.updateDeviceContext(ip = ...) 注入，网络变化时自动刷新并顺带复核公网 IP）。 客户端为 MiliLog（有界队列 + 后台线程 + 失败重试），调用点 MiliLog.info/notice/warn/error 保持不变。启动上报（reportDeviceBootInfo()）只采集这 10 项：包名、版本号、安装时间、品牌、型号、 设备名、Android 版本、CPU 架构、内核版本、屏幕分辨率
  • 仓库可见性：Gitea 仓库保持 public（若后续把 App 更新/热更新端点迁到 Gitea，非 public 会导致 403）
Reference in New Issue View Git Blame Copy Permalink