sbt-android 使用指南

sbt-android 使用指南

sbt-android An easy-to-use sbt plugin for working with all Android projects 项目地址: https://gitcode.com/gh_mirrors/sb/sbt-android

1. 项目介绍

sbt-android 是一个易于使用的 sbt 插件，用于构建 Android 项目。它支持所有 Android 项目的配置，并且可以轻松地包含第三方库。此构建插件完全兼容标准的 Android 构建系统，因为它使用了相同的底层实现 com.android.tools.build:builder。

2. 项目快速启动

安装 sbt

首先，确保你已经安装了 sbt。可以从 scala-sbt.org 下载，或者使用本地包管理系统（如 macports、brew 等）。

安装 sbt-android 插件

将以下行添加到 ~/.sbt/0.13/plugins/android.sbt 文件中，以全局安装插件：

addSbtPlugin("org.scala-android" % "sbt-android" % "1.7.7")

设置环境变量

设置 ANDROID_HOME 环境变量，指向 Android SDK 的安装路径。如果未设置 ANDROID_HOME，将在 ~/.android/sbt/sdk 自动安装 Android SDK。如果 SDK 中缺少任何组件，它们也将自动安装。

如果需要 NDK 支持，请设置 ANDROID_NDK_HOME 环境变量，或者如果未设置，sbt-android 将在检测到 NDK 构建时自动安装到 ~/.android/sbt/sdk/ndk-bundle。

创建项目

在你的项目目录中创建一个名为 project 的目录，并在其中添加 project/plugins.sbt 文件，文件中包含以下内容：

addSbtPlugin("org.scala-android" % "sbt-android" % "1.7.7")

然后，在项目根目录下创建或编辑 build.sbt 文件，并添加以下内容：

enablePlugins(AndroidApp)

可以选择设置目标平台的 API 级别，如果不设置，将自动选择最新的可用版本：

// 对于 Android 7.0, Nougat, API Level 24:
platformTarget := "android-24"

现在你可以运行 sbt，以下是一些可用的 sbt 命令：

• compile：编译项目中的所有源文件，Java 和 Scala。
• android:package-release：构建一个 release APK 并使用 release 密钥签名。
• android:package-debug：构建一个 debug APK 并使用 debug 密钥签名。
• android:package：构建项目的 APK，默认为 debug 类型。
• android:test：运行仪器化的 Android 单元测试。
• android:install：将应用安装到设备上。
• android:run：安装并运行设备上的应用。
• android:uninstall：从设备上卸载应用。

任何任务都可以通过在命令前加上 ~ 来持续执行，例如 ~ android:package-debug 将在项目源文件修改时持续构建 debug APK。

如果想要 sbt-android 自动签名 release 包，可以在 local.properties 文件中添加以下内容：

key.alias=KEY-ALIAS
key.alias.password=PASSWORD
key.store=/path/to/your/.keystore
key.store.password=KEYSTORE-PASSWORD
key.store.type=pkcs12

3. 应用案例和最佳实践

（此处应包含使用 sbt-android 的实际案例和最佳实践，例如如何集成到现有项目中，如何配置和使用第三方库等。）

4. 典型生态项目

（在此部分，可以列出一些使用 sbt-android 的典型开源项目，以及它们如何在项目中集成和使用 sbt-android。）

sbt-android An easy-to-use sbt plugin for working with all Android projects 项目地址: https://gitcode.com/gh_mirrors/sb/sbt-android