mirror of
https://github.com/Aminark/legado-ios.git
synced 2026-10-22 11:51:23 +08:00
114 lines
6.8 KiB
Markdown
114 lines
6.8 KiB
Markdown
# 开发与验证
|
||
|
||
## 环境
|
||
|
||
- macOS；支持 Swift 6 的 Xcode，当前开发环境为 Xcode 26.1。
|
||
- App 最低 iOS 15.0；核心包也可在 macOS 14+ 测试。
|
||
- Swift Package Manager 依赖由 `Package.resolved` 锁定，初次解析需要网络。
|
||
- 运行脚本需 Python 3 和 `rg`（ripgrep）。
|
||
|
||
在独立仓库根目录打开 `Legado.xcodeproj`，选择 `Legado` Scheme。真机运行需要自行设置签名团队；请勿将证书或描述文件提交到仓库。
|
||
|
||
## 代码结构
|
||
|
||
| 路径 | 用途 |
|
||
| --- | --- |
|
||
| `App/` | SwiftUI 页面、UIKit 阅读器、应用入口与资源 |
|
||
| `Sources/LegadoCore/` | 书源、规则引擎、网络、持久化、搜索、阅读及 RSS 等核心逻辑 |
|
||
| `Tests/LegadoCoreTests/` | 核心行为与书源兼容测试 |
|
||
| `Tests/LegadoAppModelsTests/` | 页面模型回归 |
|
||
| `Tests/LegadoReaderTests/` | iOS 阅读器与网页桥接测试 |
|
||
| `Tests/LegadoReaderUITests/` | 模拟器 UI 与阅读链路测试 |
|
||
| `App/Resources/` | 默认 TXT 目录规则、HTTP TTS 配置和第三方许可证 |
|
||
| `scripts/` | 自检与源码导出 |
|
||
|
||
## 验证命令
|
||
|
||
```sh
|
||
swift test --disable-sandbox
|
||
xcodebuild -project Legado.xcodeproj -scheme Legado \
|
||
-destination 'generic/platform=iOS Simulator' \
|
||
-derivedDataPath DerivedData CODE_SIGNING_ALLOWED=NO build
|
||
```
|
||
|
||
完整本地自检：
|
||
|
||
```sh
|
||
sh scripts/self-check.sh
|
||
```
|
||
|
||
首次运行可先在 Xcode 解析包；自检的 App 构建阶段固定使用已解析依赖。可用 `LEGADO_DERIVED_DATA_PATH` 和 `LEGADO_SOURCE_PACKAGES_PATH` 指定已有缓存。
|
||
|
||
阅读器测试在 Xcode 选择 `LegadoReaderTests` / `LegadoReaderUITests` Scheme 和具体模拟器运行。联网书源测试需要显式配置对应环境变量，默认核心回归主要采用自造响应，不能将其通过解读为所有线上书源均可用。
|
||
|
||
书源和本地 TXT 文件选择回归需要先在已启动的测试模拟器中准备文件共享应用（将下方 UUID 换成实际值）：
|
||
|
||
```sh
|
||
LEGADO_TEST_DEVICE="模拟器 UUID"
|
||
sh scripts/prepare-source-import-fixture.sh "$LEGADO_TEST_DEVICE"
|
||
xcodebuild -project Legado.xcodeproj -scheme LegadoReaderUITests \
|
||
-destination "platform=iOS Simulator,id=$LEGADO_TEST_DEVICE" \
|
||
-only-testing:LegadoReaderUITests/RuleEditorUITests/testJSONFilePickerOffersOpenAndImportsSelectedFiles \
|
||
-only-testing:LegadoReaderUITests/RuleEditorUITests/testBookshelfTXTFilePickerImportsTXTAndDisablesJSON \
|
||
-only-testing:LegadoReaderUITests/RuleEditorUITests/testFileManagementTXTFilePickerImportsTXTAndDisablesJSON \
|
||
-collect-test-diagnostics never CODE_SIGNING_ALLOWED=NO test
|
||
```
|
||
|
||
独立测试应用提供 JSON 书源和 `.txt`、`.TXT` 小说样本，不会被打包进正式 App。此回归检查取消后重新打开、书源 JSON 多选、本地 TXT 可选且 JSON 不可选、导入确认及最终保存。
|
||
|
||
## 兼容性验证
|
||
|
||
最低部署版本为 iOS 15.0。`App/Compatibility.swift` 为导航、分享、照片选择和弹窗提供兼容实现；新增系统 API 时需保留最低版本路径。调试构建可用 `-uiLegacyCompatibility` 启动参数在新系统上执行旧版界面分支，对应回归位于 `Tests/LegadoReaderUITests/`。这些测试不能替代 iOS 15 真机或模拟器实测。
|
||
|
||
搜索调度与缓存回归见 `Tests/LegadoCoreTests/SearchPerformanceTests.swift`，包括复杂书源限流和普通书源的及时执行；这些测试验证行为，不提供真实网络速度排名。
|
||
|
||
## 演示与公开截图
|
||
|
||
模拟器启动参数 `-uiDemo` 使用演示书架；`-uiDemoReader` 打开演示阅读页，`-uiDemoTab settings` 打开「我的」，`-uiDemoAbout` 打开关于页。部分演示入口仍保留 `settings` 参数名以兼容测试脚本。
|
||
|
||
提交截图前确认没有真实账号、个人书架或第三方付费正文。公开截图放在 `docs/images/`；`artifacts/`、构建缓存和原始测试日志仅供本地验证，已加入忽略清单。
|
||
|
||
## 导出源码
|
||
|
||
在多项目父仓库中开发时，可以运行以下命令导出本项目当前源码，排除父仓库历史、构建产物及签名文件：
|
||
|
||
```sh
|
||
python3 scripts/export-open-source.py /tmp/legado-ios-open-source
|
||
```
|
||
|
||
目标目录必须尚不存在。导出后检查内容，再用独立仓库管理；`.gitignore` 不会自动清理已经跟踪的文件。
|
||
|
||
## 维护应用源
|
||
|
||
`docs/altstore.json` 是 AltStore Classic、SideStore 和 LiveContainer 共用的应用源，固定地址为：
|
||
|
||
```text
|
||
https://raw.githubusercontent.com/Aminark/legado-ios/main/docs/altstore.json
|
||
```
|
||
|
||
源仅列出最新正式版，同时提供 `versions` 和旧客户端使用的顶层版本字段。版本号、构建号、最低 iOS 版本和隐私权限从实际 IPA 的 `Info.plist` 读取，下载地址、发布日期和更新说明来自 GitHub Release。目前由维护者在发布正式版后手动运行生成脚本并提交源文件。
|
||
|
||
1. 新版发布时，先在 Release 草稿中上传唯一的未签名 `.ipa`，再发布正式版。
|
||
2. 下载 GitHub 标记的 latest 正式版元数据及 IPA，运行下方生成与测试命令，检查 `docs/altstore.json` 差异后提交到 `main`。
|
||
3. 源文件发布后，客户端刷新源即可获取该版本的下载与更新入口。只提交源码或上传未发布的草稿不会更新应用源。
|
||
|
||
本地生成（需要 Python 3.9+；获取 Release 元数据时使用已登录的 GitHub CLI）：
|
||
|
||
```sh
|
||
source_update_dir=$(mktemp -d)
|
||
gh api repos/Aminark/legado-ios/releases/latest > "$source_update_dir/release.json"
|
||
source_release_tag=$(python3 -c 'import json,sys; print(json.load(open(sys.argv[1]))["tag_name"])' "$source_update_dir/release.json")
|
||
gh release download "$source_release_tag" --repo Aminark/legado-ios \
|
||
--pattern '*.ipa' --dir "$source_update_dir"
|
||
python3 scripts/update-altstore-source.py \
|
||
--ipa "$source_update_dir/legado-ios-v0.1.11-build17-unsigned.ipa" \
|
||
--release "$source_update_dir/release.json"
|
||
python3 -m unittest discover -s scripts/tests -v
|
||
```
|
||
|
||
请将示例 IPA 文件名换成实际下载的附件名。脚本会核对包标识、Release 标签与 IPA 版本、文件大小，以及 Release 提供的 SHA-256（如有），避免源指向与本地检查不一致的包。当前生成器针对本项目无扩展、无额外 entitlement 的未签名 IPA；改用签名包、增加扩展或 entitlement 时，需要同步完善权限提取，生成器会拒绝带签名资源、描述文件或扩展的 IPA。
|
||
|
||
发布后检查固定地址可匿名访问、图标和截图能正常加载，并下载源中 IPA 再核对大小、摘要和版本。客户端的添加源、安装、更新与签名流程需分别实测；源文件校验通过不代表已完成真机安装验证。
|
||
|
||
格式说明：[AltStore 源规范](https://faq.altstore.io/developers/make-a-source)、[SideStore 源字段](https://sidestore.io/sidestore-source-types/interfaces/Source.html)、[LiveContainer 源用法](https://livecontainer.github.io/docs/guides/sources)。
|