跳到主要内容

环境准备

1. 安装 Android Studio

  1. 打开 https://developer.android.com/studio,安装与操作系统匹配的版本。
  2. 首次启动完成 SDK、Platform-Tools、模拟器镜像等引导。
  3. 终端确认(路径按本机 ANDROID_HOME / ANDROID_SDK_ROOT):
echo "$ANDROID_HOME"
adb version

未配置环境变量时,可在 Android Studio → Settings → Languages & Frameworks → Android SDK 查看 SDK 路径,并导出:

export ANDROID_HOME=$HOME/Library/Android/sdk # macOS 常见路径
export PATH="$PATH:$ANDROID_HOME/platform-tools:$ANDROID_HOME/emulator"

2. 必备组件

组件用途
Android SDK Platform(与 compileSdk/targetSdk 匹配)编译
Android SDK Build-Tools打包、apksigner
Platform-Tools(adb安装、日志
模拟器镜像或真机运行与 instrumentation 测试
JDK(Studio 自带或 17+)Gradle 工具链

参考工程使用 Version Cataloggradle/libs.versions.toml)管理 AGP、Kotlin、Compose BOM 等。以你克隆仓库里的版本为准,不要凭印象硬升。

编辑器以 Android Studio 为主;命令行用仓库根目录的 ./gradlew

3. 获取参考工程

在你有权限的环境中,将 gostartkit/stub/android/base 作为参考树(或等价 monorepo 路径):

cd /path/to/gostartkit/stub/android/base
ls README.md settings.gradle.kts app/ build.gradle.kts

确认存在:

  • app/ — 入口 Activity、应用图、主题装配
  • feature/ — 产品功能模块
  • core/ — model、data、database、network、ui 等
  • docs/ — ARCHITECTURE、SECURITY、RELEASE 等
  • gradlewgradle/libs.versions.toml

4. 第一次 Gradle 同步

用 Android Studio Open 打开 base 根目录,等待 Gradle sync。
或在终端:

./gradlew :app:compileDebugKotlin

首次会下载依赖与工具链,耗时取决于网络。若私有仓库或代理有限制,按团队 gradle.properties / 镜像约定处理。

local.properties 由 Studio 生成,不要提交(通常已在 .gitignore)。内容大致为:

sdk.dir=/path/to/Android/sdk

5. 设备或模拟器

adb devices

列表中至少有一台 device 状态为 device
真机需开启开发者选项与 USB 调试;部分厂商还要单独打开「USB 安装」。

6. 可选:本地后端

联调完整业务时,可同时启动 Go 模块化后端(见 Go 教程 · 本地开发),再用 Gradle 属性覆盖 API:

./gradlew :app:assembleDebug -PapiBaseUrl=http://10.0.2.2:8080/
  • 模拟器访问宿主机:10.0.2.2
  • 真机访问电脑局域网 IP:http://192.168.x.x:8080/
  • Retrofit base URL 必须以 / 结尾

默认仍是 https://api-dev.alinode.com/;本地覆盖应是显式选择,不要悄悄改成默认。

7. 建议自检

./gradlew :app:assembleDebug
./gradlew :app:testDebugUnitTest

能产出 debug APK、单元测试可跑,环境就算就绪。

下一步:架构与目录