Steven
7668799040
CI / backend (push) Canceled after 0s
需求是"改完 Android 端怎么送到手机上"。不发应用商店，也不想每次手动传包，
于是做了最小闭环：后端存一份安装包清单，App 启动时查、下载、交给系统安装器。
后端
- 新增 /app/release/latest 与 /app/release/download/{file}，都免登录：
还没装上新包的客户端未必带着有效令牌，检查更新不该被登录挡住
- download_url 用相对路径，客户端拿自己配置的 API 地址拼——同一份清单要在
内网、公网、模拟器之间共用，写死域名只会让其中一个坏掉
- has_update 只比对 version_code，不比版本名字符串（0.10.0 与 0.9.0 的字典序是坑）
- 下载只认清单里登记的文件名，含 ..%2F 一律 9001
- scripts/publish_apk.py 负责复制 APK 并写 latest.json（sha256/size/published_at），
backend/static/apk/ 不进版本库
安卓
- AppUpdater：查清单 → 下到应用自己的 updates 目录（先写 .part 再改名）→
校验 sha256 → 经 FileProvider 交给系统安装器
- UpdateDialog：版本号、更新说明、下载进度、失败重试；「允许安装未知应用」
是系统开关，只跳设置页，不代点
- 启动时自动查一次，首页底部另有「检查更新」入口
- 图标换成和 Web 的 <Logo/> 同一套图形：墨绿圆角底、三条米白圆头线、陶土点；
同时出 mipmap 各密度 PNG、自适应图标与 512px 预览
- versionCode=2 / versionName=0.2.0；发布签名从 android/keystore.properties 读，
没有该文件时回落调试签名，保证别人 clone 下来也能 assembleRelease
文档
- API.md 第 7 节：两个接口、清单字段、签名与 sha256 的约定、9001
- DEPLOY.md 第 5 节：出包命令（JDK 17 + Gradle 8.9 + 干净的 GRADLE_USER_HOME）、
发布清单、传到服务器、验证
- ROADMAP 第 6 节记录本次范围与本机踩过的构建环境坑
验证
- 后端 pytest 103 passed；ruff check / format --check 全绿
- assembleRelease 成功，app-release.apk 7.4 MB，apksigner 验签显示 CN=Dadao Task
- 本地与生产 GET /app/release/latest?version_code=1 → has_update=true，
version_code=2 → false；下载返回 200 / application/vnd.android.package-archive
94 lines
3.7 KiB
Python
94 lines
3.7 KiB
Python
"""安卓 OTA：最新版本清单 + APK 下载。
|
|
|
|
为什么不用一张表：一个安装包就是一条"发布记录"，而 APK 是构建产物、不能进仓库。
|
|
所以发布目录里放「latest.json + 同名 apk」，换版本只换文件，运维不需要动数据库。
|
|
清单由 `backend/scripts/publish_apk.py` 生成（算好大小与 sha256），本模块只读。
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import json
|
|
from pathlib import Path
|
|
from typing import Any
|
|
|
|
from fastapi import APIRouter
|
|
from fastapi.responses import FileResponse
|
|
|
|
from ..config import get_settings
|
|
from ..errors import AppError, ErrorCode
|
|
from ..logging_setup import get_logger
|
|
from ..schemas import ok
|
|
|
|
router = APIRouter(prefix="/app", tags=["版本升级"])
|
|
settings = get_settings()
|
|
logger = get_logger("app.release")
|
|
|
|
MANIFEST_NAME = "latest.json"
|
|
|
|
|
|
def apk_dir() -> Path:
|
|
"""发布目录：优先用配置里的 APK_DIR，默认在 backend/static/apk（部署时保留、不入库）。"""
|
|
if settings.apk_dir:
|
|
return Path(settings.apk_dir)
|
|
return Path(__file__).resolve().parents[2] / "static" / "apk"
|
|
|
|
|
|
def _manifest() -> dict[str, Any]:
|
|
path = apk_dir() / MANIFEST_NAME
|
|
if not path.is_file():
|
|
raise AppError(ErrorCode.APP_RELEASE_NOT_FOUND, "还没有发布过安装包")
|
|
try:
|
|
data = json.loads(path.read_text(encoding="utf-8"))
|
|
except (OSError, ValueError) as exc: # noqa: BLE001 - 清单坏了也要说人话
|
|
logger.exception("读取 OTA 清单失败")
|
|
raise AppError(ErrorCode.APP_RELEASE_NOT_FOUND, "安装包清单损坏，请重新发布") from exc
|
|
if not isinstance(data, dict) or not data.get("file"):
|
|
raise AppError(ErrorCode.APP_RELEASE_NOT_FOUND, "安装包清单缺少文件名")
|
|
return data
|
|
|
|
|
|
def _payload(data: dict[str, Any], base: str, current: int | None) -> dict[str, Any]:
|
|
version_code = int(data.get("version_code") or 0)
|
|
return {
|
|
"platform": data.get("platform", "android"),
|
|
"version_code": version_code,
|
|
"version_name": data.get("version_name", ""),
|
|
"notes": data.get("notes", ""),
|
|
"file": data["file"],
|
|
"size": int(data.get("size") or 0),
|
|
"sha256": data.get("sha256", ""),
|
|
"min_sdk": int(data.get("min_sdk") or 26),
|
|
"published_at": data.get("published_at"),
|
|
# 客户端拿相对路径拼自己的 API 前缀，换域名不用改包
|
|
"download_url": f"{base}/app/release/download/{data['file']}",
|
|
# 带了当前版本号就顺手算好要不要升级，客户端不用再比一次
|
|
"has_update": current is not None and version_code > current,
|
|
}
|
|
|
|
|
|
@router.get("/release/latest", summary="安卓最新版本")
|
|
async def latest_release(version_code: int | None = None) -> dict[str, Any]:
|
|
"""公开接口：装完 App 之前就要能查，不该要登录。
|
|
|
|
`version_code` 传客户端当前版本（`BuildConfig.VERSION_CODE`），返回里的
|
|
`has_update` 直接告诉它要不要提示升级。
|
|
"""
|
|
data = _manifest()
|
|
return ok(_payload(data, settings.api_prefix, version_code))
|
|
|
|
|
|
@router.api_route("/release/download/{name}", methods=["GET", "HEAD"], summary="下载安装包")
|
|
async def download_release(name: str) -> FileResponse:
|
|
# 只认清单里那一个文件：不做目录列举，也不接受 ../ 之类
|
|
data = _manifest()
|
|
if name != data["file"]:
|
|
raise AppError(ErrorCode.APP_RELEASE_NOT_FOUND, "没有这个安装包")
|
|
path = apk_dir() / name
|
|
if not path.is_file():
|
|
raise AppError(ErrorCode.APP_RELEASE_NOT_FOUND, "安装包文件不见了，请重新发布")
|
|
return FileResponse(
|
|
path,
|
|
media_type="application/vnd.android.package-archive",
|
|
filename=name,
|
|
)
|