Docs Overview/
Chat/
UIKit/
Android/
Getting Started/
集成组件/
TUIChat/

TUIChat

本文将介绍如何集成 TUIChat 聊天组件。
说明：
从 5.7.1435 版本开始，TUIChat 支持了经典版 UI 组件。
从 6.9.3557 版本开始，TUIChat 新增了全新的简约版 UI 组件。
您可以根据需求自由选择经典版或简约版 UI 组件。

效果展示

TUIChat 提供了私信聊天（1V1）和群聊（Group）功能，支持对消息的多种操作，例如发送不同类型的消息、对消息长按点赞/回复/引用、查询消息已读回执详情等。您可以仅集成 TUIChat 到您的 App 中。聊天界面使用场景非常广泛，例如房产中介咨询、在线医疗问诊、电商在线客服、保险远程定损等。
界面效果如下图所示：
简约版
RTL语言
经典版
消息界面 | 发送多种类型消息

消息点赞 | 回复

消息已读回执 | 已读回执详情

消息界面 | 发送多种类型消息

消息点赞 | 回复

消息已读回执 | 已读回执详情

消息界面
发送多种类型消息


消息点赞/回复/引用
消息回复详情


消息已读回执
已读回执详情



开发环境要求

Android Studio-Giraffe
Gradle-7.2
Android Gradle Plugin Version-7.0.0
kotlin-gradle-plugin-1.5.31

集成 TUIChat 源码

1. 从 GitHub 下载 TUIKit 源码。使 TUIKit 文件夹跟自己的工程文件夹同级，例如：

2. 在 settings.gradle 中添加 TUIChat 组件：
// Include the internal communication module (required module)
include ':tuicore'
project(':tuicore').projectDir = new File(settingsDir, '../TUIKit/TUICore/tuicore')

// Include the Chat component common module (required module)  
include ':timcommon'
project(':timcommon').projectDir = new File(settingsDir, '../TUIKit/TIMCommon/timcommon')

// Include the chat feature module (basic feature module)
include ':tuichat'
project(':tuichat').projectDir = new File(settingsDir, '../TUIKit/TUIChat/tuichat')
3. 在 App 模块中添加 TUIChat 依赖：
api project(':tuichat')
4. 
添加 maven 仓库 和 Kotlin 支持，在 root 工程的 build.gradle 文件（与 settings.gradle 同级）中添加：

buildscript {
 repositories {
     mavenCentral()
 }
 dependencies {
     classpath 'com.android.tools.build:gradle:7.0.0'
     classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.5.31"
 }
}
如果您使用 Gradle 8.x，则需要添加以下代码。
buildscript {
 repositories {
     mavenCentral()
     maven { url "https://mirrors.tencent.com/nexus/repository/maven-public/" }
 }
 dependencies {
     classpath 'com.android.tools.build:gradle:8.0.2'
     classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.0"
 }
}

构建聊天界面

集成 TUIChat 完成后，如果您想要继续构建聊天界面，请参考文档：构建聊天界面。

常见问题

提示 "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">

    <application
        android: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>
提示 "NDK at /Users/***/Library/Android/sdk/ndk-bundle did not have a source.properties file" 如何处理？
只需要在 local.properties 文件中加入您的 NDK 路径，例如：ndk.dir=/Users/***/Library/Android/sdk/ndk/16.1.4479499

提示 "Cannot fit requested classes in a single dex file" 如何处理？
出现此问题可能是您的 API 级别设置比较低，需要在 App 的 build.gradle 文件中开启 MultiDex 支持, 添加 multiDexEnabled true 和对应依赖：
android {
    defaultConfig {
        ...
        minSdkVersion 19
        targetSdkVersion 30
        multiDexEnabled true
    }
    ...
}
dependencies {
    implementation "androidx.multidex:multidex:2.0.1"
}
同时，在您的 Application 文件中添加以下代码：
public class MyApplication extends SomeOtherApplication {
    @Override
    protected void attachBaseContext(Context base) {
        super.attachBaseContext(base);
        MultiDex.install(this);
    }
}
提示 "Plugin with id 'kotlin-android' not found." 如何处理？
因为 TUIChat 组件使用了 Kotlin 代码，所以需要添加 Kotlin 构建插件。请参考上文源码集成第 4 步。

Debug 版本的 App 功能正常，Release 版本的 App 功能出现异常 ？
出现此问题很大概率是混淆导致的，请尽量不要混淆 TUIKit 。可以添加如下混淆规则：
# Avoid deleting code logic
-dontshrink
-dontoptimize
# Avoid aliasing TUIKit
-keep class com.tencent.qcloud.** { *; }

联系我们

如果您对本文有疑问，欢迎加入Telegram 技术交流群，您将获得可靠的技术支持。