tencent cloud

即时通信 IM

动态与公告
产品动态
公告
产品简介
产品概述
基本概念
应用场景
功能介绍
账号系统
用户资料与关系链
消息管理
群组相关
公众号系统
音视频通话 Call
使用限制
购买指南
计费概述
价格说明
购买指引
续费指引
停服说明
退费说明
开发指引
Demo 专区
开通服务
体验 Demo
快速跑通
下载中心
SDK & Demo 源码
更新日志
聊天互动(含 UI)
TUIKit 组件介绍
快速开始
全功能接入
单功能接入
AI 集成
构建基础界面
更多特性
定义外观
国际化界面语言
推送服务(Push)
服务概述
名词解释
开通服务
快速跑通
厂商通道
数据统计
排查工具
客户端 API
服务端 API
推送回调
高级功能
更新日志
错误码
常见问题
智能客服
功能概述
快速入门
集成指引
管理员操作手册
客服操作手册
更多实践
直播间搭建
AI 聊天机器人方案
超大娱乐协作社群
Discord 实现指南
游戏内集成 Chat 指南
类 WhatsApp Channel 搭建方案
发送红包
Chat 应对防火墙限制相关
无 UI 集成
快速开始
集成 SDK
初始化
登录登出
消息相关
会话相关
群组相关
社群话题
用户管理
离线推送
云端搜索
本地搜索
公众号
客户端 API
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C 接口
C++
服务端 API
生成 UserSig
REST API
第三方回调
控制台指南
新版控制台介绍
创建并升级应用
基本配置
功能配置
账号管理
群组管理
公众号管理
回调配置
用量统计
资源包查看指南
实时监控
开发辅助工具
访问管理
高级功能
常见问题
uni-app 常见问题
购买相关问题
SDK 相关问题
账号鉴权相关问题
用户资料与关系链相关问题
消息相关问题
群组相关问题
直播群相关问题
昵称头像相关问题
协议与认证
服务等级协议
安全合规认证
IM 政策
隐私政策
数据隐私和安全协议
平滑迁移方案
平滑迁移完整版
平滑迁移简化版
错误码
联系我们

Android

PDF
聚焦模式
字号
最后更新时间: 2025-03-26 15:53:54
本文主要介绍如何快速将 Chat SDK 集成到您的 Android 项目中。

开发环境要求

JDK 1.6。
Android 4.1(SDK API 16)及以上系统。

集成 SDK(aar)

您可以选择使用 Gradle 自动加载的方式,或者手动下载 aar 再将其导入到您当前的工程项目中。

方法一:自动加载(aar)

您可以通过配置 gradle 自动下载更新已经发布到 Maven Central 库的 Chat SDK。 只需要用 Android Studio 打开需要集成 SDK 的工程,然后通过如下三个步骤修改 app/build.gradle 文件,就可以完成 SDK 集成:

步骤1:添加 SDK 依赖

1. 找到 app 的 build.gradle,首先在 repositories 中添加 mavenCentral() 的依赖:
repositories {
google()
jcenter()
// 增加 mavenCentral 仓库
mavenCentral()
}
2. 然后在 dependencies 中添加 Chat SDK 的依赖:
dependencies {
// 添加 Chat SDK,推荐填写最新的版本号
api 'com.tencent.imsdk:imsdk-plus:版本号'
// 如果您需要添加 Quic 插件,请取消下一行的注释(注意:要求插件版本号和 Chat SDK 版本号相同)
// api "com.tencent.imsdk:timquic-plugin:版本号"
}
其中的 “版本号”应替换为 SDK 的实际版本号,建议使用 最新版本。以版本号是5.4.666为例:
dependencies {
api 'com.tencent.imsdk:imsdk-plus:5.4.666'
}
说明:
Quic 插件,提供 axp-quic 多路传输协议,弱网抗性更优,网络丢包率达到 70% 的条件下,仍然可以提供服务。仅对专业版、专业版plus和企业版用户开放,请 购买专业版 、专业版plus或企业版后可使用。为确保功能正常使用,请将 Chat SDK 更新至 7.7.5282 及其以上的版本。

步骤2:指定 App 使用架构

在 defaultConfig 中,指定 App 使用的 CPU 架构(从 Chat SDK 4.3.118 版本开始支持 armeabi-v7a,arm64-v8a,x86,x86_64):
defaultConfig {
ndk {
abiFilters "arm64-v8a"
}
}

步骤3:同步 SDK

单击 Sync 按钮,如果您的网络连接 jcenter 没有问题,SDK 就会自动下载集成到工程里。




方法二:手动下载(aar)

如果您的网络连接 jcenter 有问题,也可以手动下载 SDK 集成到工程里:

步骤1:下载 Chat SDK

在 Github 上可以下载到最新版本的 SDK

步骤2:拷贝 Chat SDK 到工程目录





步骤3:指定 App 使用架构并编译运行

在 app/build.gradle 的 defaultConfig 中,指定 App 使用的 CPU 架构(从 Chat SDK 4.3.118 版本开始支持 armeabi-v7a,arm64-v8a,x86,x86_64):
defaultConfig {
ndk {
abiFilters "arm64-v8a"
}
}
说明:
如果您需要添加 Quic 插件,请参考前面的步骤,手动下载集成 Quic 插件

集成 SDK

如果您不想集成 aar 库,也可以通过导入 jar 和 so 库的方式集成 Chat SDK:

步骤1:下载解压 SDK

在 Github 上可以 下载 到最新版本的 aar 文件。解压后的目录里面主要包含 jar 文件和 so 文件夹,把其中的 classes.jar 重命名成 imsdk.jar 。




步骤2:拷贝 SDK 文件到工程目录

将重命名后的 jar 文件和各个架构的 so 文件分别拷贝到 Android Studio 默认加载的目录下:




步骤3:指定 App 使用架构并编译运行

在 app/build.gradle 的 defaultConfig 中,指定 App 使用的 CPU 架构(从 Chat SDK 4.3.118 版本开始支持 armeabi-v7a,arm64-v8a,x86,x86_64):
defaultConfig {
ndk {
abiFilters "arm64-v8a"
}
}

配置 App 权限

在 AndroidManifest.xml 中配置 App 的权限,Chat SDK 需要以下权限:
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />

设置混淆规则

在 proguard-rules.pro 文件,将 Chat SDK 相关类加入不混淆名单:
-keep class com.tencent.imsdk.** { *; }


帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈