# 应用配置 (/zh-CN/realtime-media/rtm/build/rtm-initialization/application-setup/android) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). 在开始配置你的应用之前,你需要先了解用户 ID、服务类型等概念,然后下载并安装 SDK,再初始化一个 RTM 对象实例,最后实现事件监听函数以捕获 RTM 实时网络中的所有事件通知。 ## 用户 ID(`userId`) [#用户-iduserid] 用户 ID 是一个用于标识用户和设备的 ASCII 码字符串,长度最多为 64 个字符。在初始化 RTM 客户端实例时,你需要自行定义用户 ID 并将其传递给 `userId` 参数。RTM 规定在同一个 App ID(`appId`)下,每个用户或设备都必须具有唯一的全局用户 ID。 为了正确使用 RTM,你需要了解用户、设备和客户端的概念: - **用户**: 是指应用的实际使用者。 - **设备**: 是指实际接入 RTM 网络的终端,包括但不限于手机、电脑、智能手表等 IoT 设备。 - **客户端**: 是指运行在设备上的 RTM 对象实例。 一个用户可能拥有多台设备,而一台设备也有可能被多人拥有。为更好地区分不同的设备和用户,RTM 规定同一个用户 ID 不能在多台设备上同时登录 RTM 服务、一台设备上不能同时存在多个 RTM 客户端。如果一个用户拥有多台设备,则需要为每台设备都分配唯一的用户 ID。如果两台拥有相同用户 ID 的设备同时登录 RTM 服务,那么先登录上的设备会被后登录的设备挤下线,而被强制下线的设备会收到相应的事件通知。 在实际场景中,业务层的用户名和 RTM 的用户 ID 可能不同,你需要自行实现二者的映射与绑定逻辑。例如,用户先通过用户名登录你的业务服务器,服务器再生成对应的用户 ID,然后使用该用户 ID 初始化并登录 RTM 服务。 此外,用户 ID 也会影响计费和在线状态通知等功能的使用,所以声网建议你为用户和设备分配全局唯一的用户 ID 并在整个生命周期内保持不变。 ## 服务类型 [#服务类型] 基于不同的传输连接,RTM SDK 提供的功能可以被划分为两种服务类型: `MESSAGE` 服务和 `STREAM` 服务。 - `MESSAGE` 服务涵盖了 `Message Channel`、`User Channel`、`Presence`、`Storage`、`Lock`、`Token` 鉴权等功能特性,通过 `RtmClient` 实例调用 API。 - `STREAM` 服务则提供了 `Stream Channel`、`Topic` 等功能,通过 `StreamChannel` 实例调用 API。 在 `MESSAGE` 服务中,所有功能特性将共享一条传输连接,该连接在 `login` 时建立,在 `logout` 时关闭。而在 `STREAM` 服务中,传输连接的数量取决于加入的 `STREAM CHANNEL` 数量,即每个加入的 `STREAM CHANNEL` 实例都拥有独立的连接,连接在 `join` 时建立,在 `leave` 时关闭。 所有传输连接都由 SDK 统一管理,并通过 `onLinkStateEvent` 事件通知给用户,详见[连接管理](/zh-CN/realtime-media/rtm/build/authentication-and-connection/link-basic)。深入理解 RTM 服务类型的区别,有助于你更准确地选择和使用相关能力。 此外,服务类型还涉及私有化配置的选择。用户可以选择私有化一个服务,或者同时私有化两种服务,具体取决于应用场景和预算。详见[私有化配置](/zh-CN/realtime-media/rtm/build/network-and-private-deployment/private-setup)。 ## 连接协议配置 [#连接协议配置] 为保证连接的稳定性和服务的持续可用性,RTM 客户端与边缘服务器建立连接时会为每种服务(`MESSAGE` 服务和 `STREAM` 服务)分别建立两条传输链路。默认情况下,这两条链路分别基于 TCP 协议和 UDP 协议,这种设计使得任何一条链路出现网络问题都不会影响传输效果。相较于其他基于 WebSocket 的消息传输方案,RTM 的冗余链路设计能够最大程度地提升传输稳定性和消息到达率。 在某些情况下,用户可能会发现他们的网络不支持 UDP 端口的传输,这可能是暂时的,也可能是永久性的。在这种情况下,为了确保双链路设计能够最大程度地发挥作用,SDK 允许用户将两条链路都配置成 TCP 协议,只需在 `RtmConfig` 中设置 `protocolType` 字段即可。以下是一个将双链路都配置为 TCP 协议的代码示例: ```java RtmConfig rtmConfig = new RtmConfig.Builder("appid", "userId") .protocolType(RtmProtocolType.TCP_ONLY) .build(); ``` :::info[信息] SDK 不支持将两条链路同时配置为 UDP 协议。 ::: ## 安装 SDK [#安装-sdk] 你可以通过以下方式获取最新的 RTM Android SDK。 使用 CDN 使用 Maven 1. [点击此处](https://download.shengwang.cn/rtm2/release/RTM_JAVA_SDK_for_Android_v2.3.1.zip)下载最新版本的 Java SDK。 2. 将 SDK 包内 `sdk` 文件夹中的所有文件拷贝到项目的 `/app/libs` 路径下。 3. 添加 SDK 引用。在 **Project** 窗口找到 `/Gradle Scripts/build.gradle(Module: .app)` 文件并添加如下代码: 1. 在 `defaultConfig` 节点添加 `ndk` 节点,指定支持的架构。 ```groovy Config { // ... ndk{ abiFilters 'armeabi-v7a', 'arm64-v8a', 'x86', 'x86_64' } } ``` :::info[信息] 支持的架构越多,App 的体积会越大,声网建议你根据实际情况添加需要支持的架构。一般在发布 Android App 时只需保留 armeabi-v7a 和 arm64-v8a 架构。 ::: 2. 在 `android` 节点添加 `sourceSets` 节点,指定 `libs` 所在目录。 ```groovy android { // ... sourceSets { main { jniLibs.srcDirs = ['libs'] } } } ``` 3. 在 `dependencies` 节点引入 `libs` 路径下所有的 jar 库。 ```groovy dependencies { implementation fileTree(dir: 'libs', include: ['*.jar']) // ... } ``` 1. 自 v2.3.1 起,通过 Maven 集成 RTM SDK 时,需要添加声网 Maven 仓库。在项目根目录的 `settings.gradle` 文件中,向 `dependencyResolutionManagement.repositories` 添加如下配置,并保留项目已有的仓库: ```groovy dependencyResolutionManagement { repositories { maven { url = 'https://download.shengwang.cn/maven/' } google() mavenCentral() } } ``` 如果项目未使用 `dependencyResolutionManagement`,则在项目根目录的 `build.gradle` 文件中,向 `allprojects.repositories` 添加声网 Maven 仓库: ```groovy allprojects { repositories { maven { url = 'https://download.shengwang.cn/maven/' } google() mavenCentral() } } ``` 2. 在 `/Gradle Scripts/build.gradle(Module: .app)` 文件中添加如下代码,将 SDK 集成到你的 Android 项目中: ```groovy dependencies { // 将下方版本号替换为需要的 SDK 版本号,如 2.3.1 // 对于 2.2.7 及之后版本: implementation 'cn.shengwang.rtm:android-java:2.3.1' // 如需 Lite SDK,将上一行替换为(需确保已通过其他声网 SDK 引入对应的 aosl 依赖): // implementation 'cn.shengwang.rtm:android-java-lite:2.3.1' // 对于 2.2.6 及之前版本: // implementation 'io.agora:agora-rtm:x.y.z' } ``` 详细流程参考[快速开始](/zh-CN/realtime-media/rtm/get-started/quick-start)。 ## 初始化 RTM 实例 [#初始化-rtm-实例] 在使用 RTM 功能前,你需要使用 `appId` 和 `userId` 来初始化一个 RTM 实例。在后续的示例代码中,你需要将 `your_appId` 和 `your_userId` 字段都替换为你自己的 `appId` 和 `userId`。 :::info[信息] 初始化 RTM 对象时的 `appId` 和 `userId` 为必填参数,如果缺失,则初始化会失败。 ::: 在一个客户端中,你只需要初始化一次 RTM 对象实例,即可在后续实现中通过该对象实例调用 RTM 的其他 API。 ```java RtmConfig rtmConfig = new RtmConfig(); rtmConfig.userId = "your_userId"; rtmConfig.appId = "your_appId"; try { mRtmClient = RtmClient.create(rtmConfig); } catch(Exception e) { log(INFO, "create rtm client failed with exception: " e.toString()); } ``` 现在,你就可以使用 `RtmClient` 对象调用 RTM 的其他 API 接口了。 ## 日志设置 [#日志设置] 当你的应用处于开发、测试阶段时,你可能需要 SDK 输出更详细的信息来定位并修复问题。你可以在初始化 RTM 实例的时候通过设置 `RtmConfig` 中的 `RtmLogLevel` 来开启日志输出并设置日志信息等级,之后即可在相应平台的日志输出位置查看日志信息。 ```java RtmLogConfig logConfig = new RtmLogConfig() // set log file path. logConfig.filePath = "./logfile/"; // set log file size. logConfig.fileSizeInKB = 512; // set log report level. logConfig.level = RtmLogLevel.INFO; RtmConfig rtmConfig = new RtmConfig(); rtmConfig.userId = "your_userId"; rtmConfig.appId = "your_appId"; rtmConfig.logConfig = logConfig; // set log config try { mRtmClient = RtmClient.create(rtmConfig); } catch(Exception e) { log(INFO, "create rtm client failed with exception: " e.toString()); } ``` 日志有以下五种等级: :::info[信息] 在你的应用上线时,你需要将日志等级参数设置为 `INFO`。 ::: | 枚举值 | 描述 | | --- | ------ | | `NONE` | `0x0000`: 不输出任何日志。 | | `INFO` | `0x0001`: 输出 `FATAL`、`ERROR`、`WARN`、`INFO` 级别的日志。我们推荐你将日志级别设为该等级。 | | `WARN` | `0x0002`: 仅输出 `FATAL`、`ERROR`、`WARN` 级别的日志。 | | `ERROR` | `0x0004`: 仅输出 `FATAL`、`ERROR` 级别的日志。 | | `FATAL` | `0x0008`: 仅输出 `FATAL` 级别的日志。 | ## Cloud Proxy 设置 [#cloud-proxy-设置] 完整配置说明请参阅[网络配置中的 Cloud Proxy 设置](/zh-CN/realtime-media/rtm/build/network-and-private-deployment/network-configuration#cloud-proxy-设置)。 ## Proxy 设置 [#proxy-设置] 完整配置说明请参阅[网络配置中的 Proxy 设置](/zh-CN/realtime-media/rtm/build/network-and-private-deployment/network-configuration#proxy-设置)。 ## 防火墙白名单设置 [#防火墙白名单设置] 完整配置说明请参阅[网络配置中的防火墙白名单设置](/zh-CN/realtime-media/rtm/build/network-and-private-deployment/network-configuration#防火墙白名单设置)。