开发环境要求
Android Studio 3.6.1
Gradle-5.1.1
Android Gradle Plugin Version-3.4.0
module 源码集成
1. 从 GitHub 下载 TUIKit 源码。使 TUIKit 文件夹跟自己的工程文件夹同级,例如:
?
?2. 根据实际业务需求在 settings.gradle 中添加对应的 TUI 组件,比如需要聊天功能,可以添加 tuichat;需要会话列表功能,可以添加 tuiconversation;需要音视频通话功能,可以添加 tuicallkit。TUI 组件之间相互独立,添加或删除均不影响工程编译。
// 引入上层应用模块include ':app'?// 引入内部组件通信模块 (必要模块)include ':tuicore'project(':tuicore').projectDir = new File(settingsDir, '../TUIKit/TUICore/tuicore')?// 引入聊天功能模块 (基础功能模块)include ':tuichat'project(':tuichat').projectDir = new File(settingsDir, '../TUIKit/TUIChat/tuichat')?// 引入关系链功能模块 (基础功能模块)include ':tuicontact'project(':tuicontact').projectDir = new File(settingsDir, '../TUIKit/TUIContact/tuicontact')?// 引入会话功能模块 (基础功能模块)include ':tuiconversation'project(':tuiconversation').projectDir = new File(settingsDir, '../TUIKit/TUIConversation/tuiconversation')?// 引入搜索功能模块(需要购买旗舰版套餐)include ':tuisearch'project(':tuisearch').projectDir = new File(settingsDir, '../TUIKit/TUISearch/tuisearch')?// 引入群组功能模块include ':tuigroup'project(':tuigroup').projectDir = new File(settingsDir, '../TUIKit/TUIGroup/tuigroup')?// 引入离线推送功能模块include ':tuiofflinepush'project(':tuiofflinepush').projectDir = new File(settingsDir, '../TUIKit/TUIOfflinePush/tuiofflinepush')?// 引入音视频通话功能模块include ':tuicallkit'project(':tuicallkit').projectDir = new File(settingsDir, '../TUIKit/TUICallKit/tuicallkit')
3. 在 APP 的 build.gradle 中添加:
dependencies {api project(':tuiconversation')api project(':tuicontact')api project(':tuichat')api project(':tuisearch')api project(':tuigroup')api project(':tuiofflinepush')api project(':tuicallkit')}
4. 在 gradle.properties 文件中加入下行,表示自动转换三方库以兼容 AndroidX:
android.enableJetifier=true
5. 添加 maven 仓库,在 root 工程的 build.gradle 文件中添加:
allprojects {repositories {mavenCentral()maven { url "https://mirrors.tencent.com/nexus/repository/maven-public/" }}}
6. 同步工程,编译运行。工程结构预期效果如图所示:
?
?
?快速搭建
常用的聊天软件都是由会话列表、聊天窗口、好友列表、音视频通话等几个基本的界面组成,参考下面步骤,您仅需几行代码即可在项目中快速搭建这些 UI 界面。
步骤一:组件登录
// 在用户 UI 点击登录的时候调用TUILogin.login(context, sdkAppID, userID, userSig, new TUICallback() {@Overridepublic void onError(final int code, final String desc) {}?@Overridepublic void onSuccess() {}});
注意:
context 必须传 Application 对象,否则部分图片无法加载。
步骤二:创建 viewPager
1. 在 activity_main.xml 中添加界面布局:
<?xml version="1.0" encoding="utf-8"?><LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"android:layout_width="match_parent"android:layout_height="match_parent"android:orientation="vertical">?<androidx.viewpager2.widget.ViewPager2android:id="@+id/view_pager"android:layout_width="match_parent"android:layout_height="0dp"android:layout_weight = "1"/></LinearLayout>
2. 创建 FragmentAdapter.java 用来配合 ViewPager2 展示会话和联系人界面。
import androidx.annotation.NonNull;import androidx.fragment.app.Fragment;import androidx.fragment.app.FragmentActivity;import androidx.fragment.app.FragmentManager;import androidx.lifecycle.Lifecycle;import androidx.viewpager2.adapter.FragmentStateAdapter;??import java.util.List;?public class FragmentAdapter extends FragmentStateAdapter {private static final String TAG = FragmentAdapter.class.getSimpleName();?private List<Fragment> fragmentList;?public FragmentAdapter(@NonNull FragmentActivity fragmentActivity) {super(fragmentActivity);}?public FragmentAdapter(@NonNull Fragment fragment) {super(fragment);}?public FragmentAdapter(@NonNull FragmentManager fragmentManager, @NonNull Lifecycle lifecycle) {super(fragmentManager, lifecycle);}?public void setFragmentList(List<Fragment> fragmentList) {this.fragmentList = fragmentList;}?@NonNull@Overridepublic Fragment createFragment(int position) {if (fragmentList == null || fragmentList.size() <= position) {return new Fragment();}return fragmentList.get(position);}?@Overridepublic int getItemCount() {return fragmentList == null ? 0 : fragmentList.size();}}
步骤三:构建核心 Fragment
会话列表?TUIConversationFragment?以及联系人列表?TUIContactFragment?界面数据的获取、同步、展示以及交互均已在组件内部封装,UI 的使用与 Android 的普通 Fragment 一样方便。
在 MainActivity.java 的 onCreate 方法中添加:
List<Fragment> fragments = new ArrayList<>();// tuiconversation 组件提供的会话界面fragments.add(new TUIConversationFragment());// tuicontact 组件提供的联系人界面fragments.add(new TUIContactFragment());ViewPager2 mainViewPager = findViewById(R.id.view_pager);FragmentAdapter fragmentAdapter = new FragmentAdapter(this);fragmentAdapter.setFragmentList(fragments);mainViewPager.setOffscreenPageLimit(2);mainViewPager.setAdapter(fragmentAdapter);mainViewPager.setCurrentItem(0, false);
步骤四:构建音视频通话功能
TUI 组件支持在聊天界面对用户发起音视频通话,仅需要简单几步就可以快速集成:
视频通话 | 语音通话 |
? ? ? | ? ? ? |
1. 开通音视频服务
1.1 创建项目。创建项目,选择类型及场景,开通相关服务。
1.1.2 选择项目类型。可选择创建新项目并输入项目名称,或关联已有项目。
1.1.3 选择接入场景。选择快速接入的音视频场景,分为聊天应用和音视频通话。
?
?1.1.4 选择集成方式。选择含 UI 快速集成。
1.1.5 开通相关服务。使用音视频通话 SDK 需提前开通即时通信 IM 和实时音视频 TRTC 服务,仅开通服务,不涉及付费购买产品。
1.1.6 单击创建项目并下一步,完成项目创建,进入开发指引。
?
?1.2 准备开发。
1.2.1 体验 Demo。您可提前体验 Demo 了解 SDK 应用效果,包括 Android、iOS 和 Web 端。
1.2.2 关联/创建 IM 应用。音视频通话创建需要使用 IM 服务,请选择一个 IM 应用进行关联或者创建新的应用。
?
?1.2.3 领取资源。每个应用可免费体验音视频通话 SDK 功能一次,有效期7天,音视频通话 SDK 体验版详细能力支持请参见 套餐包功能说明。业务上线请升级购买正式版本套餐,享受完整功能。
?
?1.2.4 单击前往集成。
1.3 集成指南
1.3.1 选择集成环境并下载 TUIKit 开发包。集成环境包括 Android 和 iOS。
1.3.2 集成测试。下载 TUIKit 开发包后,参照集成测试的步骤查看相关集成文档完成集成测试。
1.3.3 正式开发。完成 SDK 接入测试后,若需正式开发并上线音视频应用,可购买音视频通话套餐包,包括基础版、进阶版和尊享版,升级当前项目业务版本,享受完整功能。
?
?2. 集成 TUICallKit 组件
在 APP 的 build.gradle 文件中添加对
tuicallkit
的依赖:api project(':tuicallkit')
3. 发起和接收视频或语音通话
消息页发起通话 | 联系人页发起通话 |
? ? ? | ? ? ? |
集成 TUICallKit 组件后,聊天界面和联系人资料界面默认会显示 “视频通话” 和 “语音通话” 两个按钮,当用户单击按钮时,TUIKit 会自动展示通话邀请 UI,并给对方发起通话邀请请求。
当用户在线并且应用在前台时收到通话邀请时,TUIKit 会自动展示通话接收 UI,用户可以选择同意或则拒绝通话。
当用户离线收到通话邀请时,如需唤起 App 通话,需要使用离线推送能力。离线推送的实现请参考下一步。
4. 添加离线推送:?实现音视频通话的离线推送,请参考以下几个步骤:
4.1 配置 App 的 离线推送。
4.2 集成 TUICallKit 组件。
4.3 通过 TUICallKit 发起通话邀请的时候,默认会生成一条离线推送消息。
说明:
常见问题
1、提示 "Manifest merger failed : Attribute application@allowBackup value=(true) from AndroidManifest.xml" 如何处理?
IM SDK 中默认
allowBackup
的值为false
,表示关闭应用的备份和恢复功能。
您可以在您的AndroidManifest.xml
文件中删除allowBackup
属性,表示关闭备份和恢复功能;也可以在AndroidManifest.xml
文件的 application 节点中添加tools:replace="android:allowBackup"
表示覆盖 IM SDK 的设置,使用您自己的设置。例如:
<manifest xmlns:android="http://schemas.android.com/apk/res/android"xmlns:tools="http://schemas.android.com/tools"package="com.tencent.qcloud.tuikit.myapplication">?<applicationandroid:allowBackup="true"android:name=".MApplication"android:icon="@mipmap/ic_launcher"android:label="@string/app_name"android:roundIcon="@mipmap/ic_launcher_round"android:supportsRtl="true"android:theme="@style/Theme.MyApplication"tools:replace="android:allowBackup"><activity android:name=".MainActivity"><intent-filter><action android:name="android.intent.action.MAIN" />?<category android:name="android.intent.category.LAUNCHER" /></intent-filter></activity></application>?</manifest>
2、提示 "NDK at /Users/***/Library/Android/sdk/ndk-bundle did not have a source.properties file" 如何处理?
出现此问题可能是您使用了较高版本的 Gradle 和 Gradle 插件,您可以使用推荐的版本:
?
?
?此外,您也可以继续使用您当前版本的 Gradle,只需要在 local.properties 文件中加入您的 NDK 路径,例如:
ndk.dir=/Users/***/Library/Android/sdk/ndk/16.1.4479499
。3、提示 "Cannot fit requested classes in a single dex file" 如何处理?
出现此问题可能是您的 API 级别设置比较低,需要在 App 的 build.gradle 文件中开启
MultiDex
支持, 添加multiDexEnabled true
和对应依赖:android {defaultConfig {...minSdkVersion 15targetSdkVersion 28multiDexEnabled true}...}dependencies {implementation "androidx.multidex:multidex:2.0.1"}
同时,在您的 Application 文件中添加以下代码:
public class MyApplication extends SomeOtherApplication {@Overrideprotected void attachBaseContext(Context base) {super.attachBaseContext(base);MultiDex.install(this);}}
交流与反馈
欢迎加入 QQ 群进行技术交流和反馈问题。
?
?