Docs 菜单
Docs 主页
/ /
Atlas Device SDKs

安装 Kotlin SDK

在此页面上

  • 先决条件
  • 安装
  • 将 SDK 添加到项目
  • 同步 Gradle 文件
  • 支持的目标环境
  • 支持的环境
  • 不支持的环境

适用于 Kotlin 的 Atlas Device SDK 支持以下平台。 每种方法都有自己的安装方法和要求:

  • Android

  • Kotlin Multiplatform (KMP)

在开始之前,请确保您的开发环境满足以下前提条件:

有关支持的目标环境列表,请参阅本页上的“支持的目标环境”部分。

此外,适用于移动项目的 Kotlin Multiplatform (KMP) 具有以下要求:

有关设置 KMP 环境的更多详细信息,请参阅 Kotlin 官方 Kotlin Multiplatform for mobile 文档。要验证您的环境设置,请按照 Kotlin 的 环境检查指南进行操作。

提示

Kotlin 插件版本

Kotlin Multiplatform (KMP) 生态系统经常发生变化。 如果您在安装 SDK 时遇到任何问题,请检查您的 Kotlin 插件版本,因为过时的插件可能会导致难以调试的错误。 要查看哪些版本的 Kotlin 插件与 SDK 兼容,请参阅 SDK 变更日志。

提示

Atlas Device SDK 和 Realm

SDK 使用 Realm Core 数据库来实现设备数据持久化。安装 Kotlin SDK 时,包名称会反映 Realm 命名方式。

1

将用来指定库版本和 apply falseio.realm.kotlin 添加到项目级 Gradle 构建文件(通常位于 <project>/build.gradle)中的插件列表:

全局 build.gradle
plugins {
id 'io.realm.kotlin' version '1.16.0' apply false
}

将以下内容添加到应用程序级 Gradle 构建文件中,该文件通常位于<project>/app/build.gradle

  • io.realm.kotlin 添加到插件列表中。

  • 将以下内容添加到依赖项列表中:

    • io.realm.kotlin:library-base 添加到依赖项区块中。

    • 如果在您的应用程序中使用 Device Sync,请将 io.realm.kotlin:library-sync 添加到依赖项区块中。

  • 要在 SDK 中使用协程,请在依赖项列表中添加 org.jetbrains.kotlinx:kotlinx-coroutines-core

模块 build.gradle
plugins {
id 'com.android.application'
id 'org.jetbrains.kotlin.android'
id 'io.realm.kotlin'
}
android {
// ... build configuration settings
}
dependencies {
implementation 'io.realm.kotlin:library-base:1.16.0'
// If using Device Sync
implementation 'io.realm.kotlin:library-sync:1.16.0'
// If using coroutines with the SDK
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.0'
}
  1. 将以下内容添加到应用程序级 Gradle 构建文件中,该文件通常位于<project>/app/build.gradle

    • io.realm.kotlin 添加到插件列表中。

    • 将以下内容添加到依赖项列表中:

      • io.realm.kotlin:library-base 添加到依赖项区块中。

      • 如果在您的应用程序中使用 Device Sync,请将 io.realm.kotlin:library-sync 添加到依赖项区块中。

    • 要在 SDK 中使用协程,请在依赖项列表中添加 org.jetbrains.kotlinx:kotlinx-coroutines-core

    App build.gradle
    plugins {
    kotlin("multiplatform")
    kotlin("native.cocoapods")
    id("com.android.library")
    id("io.realm.kotlin") version "1.16.0"
    }
    version = "1.0"
    kotlin {
    android()
    iosX64()
    iosArm64()
    sourceSets {
    val commonMain by getting {
    dependencies {
    implementation("io.realm.kotlin:library-base:1.16.0")
    // If using Device Sync
    implementation("io.realm.kotlin:library-sync:1.16.0")
    // If using coroutines with the SDK
    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.0")
    }
    }
    }
    }
  2. 如果您在 Android 模块内使用 SDK 的任何部分,请将以下编译时依赖项添加到模块级 Gradle 构建文件中,该文件通常位于<project>/module/build.gradle中:

    Android 模块 build.gradle
    dependencies {
    compileOnly("io.realm.kotlin:library-base:1.16.0")
    }
    // If using Device Sync
    dependencies {
    compileOnly("io.realm.kotlin:library-sync:1.16.0")
    }
2

更新 Gradle 配置后,通过单击 Android Studio 菜单栏中的 File > Sync Project with Gradle Files来解析依赖项。现在,您便可在您的应用程序中使用 Kotlin SDK。

Kotlin Multiplatform (KMP) 支持广泛的应用程序环境 另请参阅 Kotlin 的 Multiplatform Gradle DSL 参考:目标 文档。

Kotlin SDK 支持以下环境:

  • android

  • iosArm64

  • iosSimulatorArm64

  • iosX64

  • jvm

  • macosArm64

  • macosX64

Kotlin SDK 支持以下环境:

  • androidNativeArm32

  • androidNativeArm64

  • androidNativeX86

  • androidNativeX64

  • iosArm32

  • js

  • linuxArm32Hfp

  • linuxArm64

  • linuxMips32

  • linuxMipsel32

  • linuxX64

  • mingwX64

  • mingwX86

  • tvosArm64

  • tvosSimulatorArm64

  • tvosX64

  • wasm32

  • watchosArm32

  • watchosArm64

  • watchosSimulatorArm64

  • watchosX86

  • watchosX64

来年

欢迎使用 Atlas Device SDK 文档