集成 IM UIKit

更新时间: 2024/05/23 13:56:50

云信 IM UIKit 是基于 NIM SDK V10(网易云信 IM SDK)开发的一款即时通讯 UI 组件库,包括聊天、会话、群管理等组件。本文介绍如何快速跑通 IM UIKit 的集成流程。

前提条件

在开始集成 IM UIKit 前,请确保您已:

  • 已在云信控制台创建应用,获取 App Key。

  • 注册云信 IM 账号,获取 account_id 和 token。

  • 准备如下开发环境/工具:

    • Android Studio Bumblebee
    • Java 17
    • Gradle 8.2
    • Android Gradle Plugin 8.2.2

注意事项

由于 IM UIKit 的初始化与登录是通过底层调用 NIM SDK 接口来实现的,因此重复调用 IM UIKit 和 NIM SDK 的初始化与登录接口会相互覆盖传入的信息(包括推送配置信息)。

所以若用户同时集成 IM UIKit 和 NIM SDK,只需要调用一次初始化与登录接口即可。

实现流程

uml diagram

步骤1:按需导入组件

根据业务需要,在您的项目的 build.gradle 中,以添加依赖的形式添加相应的 IM UIKit 组件和第三方库(Glide、Retrofit 和 OkHttp)。各组件相互独立,添加或删除均不影响项目编译。

例如,需要通讯录功能和会话列表功能,可添加 contactkit-uiconversationkit-ui

groovydependencies { 
    // 通讯录功能
    implementation("com.netease.yunxin.kit.contact:contactkit-ui:${LATEST_VERSION}")
    // 会话列表功能组件
    implementation("com.netease.yunxin.kit.conversation:conversationkit-ui:${LATEST_VERSION}")
    // 群组功能组件
    implementation("com.netease.yunxin.kit.team:teamkit-ui:${LATEST_VERSION}")
    // 聊天功能组件
    implementation("com.netease.yunxin.kit.chat:chatkit-ui:${LATEST_VERSION}")
    // 位置消息功能组件
    implementation("com.netease.yunxin.kit.locationkit:locationkit:${LATEST_VERSION}")
    //呼叫组件依赖,包括呼叫组件包和IM 信令包
    implementation("com.netease.yunxin.kit.call:call-ui:2.2.0") 
    implementation("com.netease.nimlib:avsignalling:${LATEST_VERSION}") //信令组件

    // 图片库
    implementation("com.github.bumptech.glide:glide:4.13.1")  
    // 网络库
    implementation("com.squareup.retrofit2:retrofit:2.9.0")
    implementation("com.squareup.retrofit2:converter-gson:2.9.0")
    implementation("com.squareup.retrofit2:converter-scalars:2.9.0")
    implementation("com.squareup.okhttp3:okhttp:4.12.0")
}

添加权限

根据实际应用需求,在 AndroidManifest.xml 文件中设置所需的权限。

添加所需权限
xml<?xml version="1.0" encoding="utf-8"?>
<!-- 请将 com.netease.nim.demo 替换为自己的包名 -->
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
	      package="com.netease.nim.demo">

	<!-- 权限声明 -->
	<!-- 访问网络状态-->
	<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" />
    
    <uses-permission android:name="android.permission.CHANGE_WIFI_STATE"/>
	
    <!-- 外置存储存取权限 -->
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

    <!-- 多媒体相关 -->
    <uses-permission android:name="android.permission.CAMERA"/>
    <uses-permission android:name="android.permission.RECORD_AUDIO"/>
    <!-- Android11:V8.6.1及之后的版本不需要;其他:V4.4.0及之后的版本不需要 -->
    <uses-permission android:name="android.permission.READ_PHONE_STATE"/>

    <!-- 控制呼吸灯,振动器等,用于新消息提醒 -->
    <uses-permission android:name="android.permission.FLASHLIGHT" />
    <uses-permission android:name="android.permission.VIBRATE" />
    
    <!-- 8.0+系统需要-->
    <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />


    <!-- 下面的 uses-permission 一起加入到你的 AndroidManifest 文件中。 -->
    <permission
        android:name="com.netease.nim.demo.permission.RECEIVE_MSG"
        android:protectionLevel="signature"/>

     <uses-permission android:name="com.netease.nim.demo.permission.RECEIVE_MSG"/>

    <application
        ...>
        <!-- APP key, 可以在这里设置,也可以在 SDKOptions 中提供。
            如果 SDKOptions 中提供了,则取 SDKOptions 中的值 -->
        <meta-data
            android:name="com.netease.nim.appKey"
            android:value="key_of_your_app" />

        <!-- 云信后台服务,请使用独立进程 -->
        <service
            android:name="com.netease.nimlib.service.NimService"
            android:process=":core"/>

       <!-- 云信后台辅助服务 -->
        <service
            android:name="com.netease.nimlib.service.NimService$Aux"
            android:process=":core"/>

        <!-- 云信后台辅助服务 -->
        <service
            android:name="com.netease.nimlib.job.NIMJobService"
            android:exported="false"
            android:permission="android.permission.BIND_JOB_SERVICE"
            android:process=":core"/>

        <!-- 云信监视系统启动和网络变化的广播接收器,保持和 NimService 同一进程 -->
        <receiver android:name="com.netease.nimlib.service.NimReceiver"
            android:process=":core"
            android:exported="false">
            <intent-filter>
                <action android:name="android.net.conn.CONNECTIVITY_CHANGE"/>
            </intent-filter>
        </receiver>

        <!-- 云信进程间通信 Receiver -->
        <receiver android:name="com.netease.nimlib.service.ResponseReceiver"/>

        <!-- 云信进程间通信service -->
        <service android:name="com.netease.nimlib.service.ResponseService"/>

        <!-- 云信进程间通信provider -->
        <provider
            android:name="com.netease.nimlib.ipc.NIMContentProvider"
            android:authorities="com.netease.yunxin.app.im.ipc.provider"
            android:exported="false"
            android:process=":core" />
      	
      	<!-- 云信内部使用的进程间通信provider -->
      	<!-- SDK启动时会强制检测该组件的声明是否配置正确,如果检测到该声明不正确,SDK会主动抛出异常引发崩溃 -->
        <provider
            android:name="com.netease.nimlib.ipc.cp.provider.PreferenceContentProvider"
            android:authorities="com.netease.yunxin.app.im.ipc.provider.preference"
            android:exported="false" />
    </application>
</manifest>

防止代码混淆

代码混淆是指使用简短无意义的名称重命名已存在的类、方法、属性等,增加逆向工程的难度,保障 Android 程序源码的安全性。

为了避免因上述的重命名而导致调用 IM UIKit 异常,请在 proguard-rules.pro 文件中加入以下代码,将 NIM SDK 和 IM UIKit 的相关类加入不混淆名单。

防混淆
## NIM SDK 防混淆
-dontwarn com.netease.nim.**
-keep class com.netease.nim.** {*;}

-dontwarn com.netease.nimlib.**
-keep class com.netease.nimlib.** {*;}

-dontwarn com.netease.share.**
-keep class com.netease.share.** {*;}

-dontwarn com.netease.mobsec.**
-keep class com.netease.mobsec.** {*;}

## IM UIKit 防混淆
-dontwarn com.netease.yunxin.kit.**
-keep class com.netease.yunxin.kit.** {*;}
-keep public class * extends com.netease.yunxin.kit.corekit.XKitInitOptions
-keep class * implements com.netease.yunxin.kit.corekit.XKitService {*;}

## 呼叫组件防混淆
-keep class com.netease.lava.** {*;}
-keep class com.netease.yunxin.** {*;}

-dontwarn com.netease.yunxin.kit.**
-keep class com.netease.yunxin.kit.** {*;}
-keep public class * extends com.netease.yunxin.kit.corekit.XKitInitOptions
-keep class * implements com.netease.yunxin.kit.corekit.XKitService {*;}

## 高德 3D 地图 
-keep   class com.amap.api.maps.**{*;}
-keep   class com.autonavi.**{*;}
-keep   class com.amap.api.trace.**{*;}

## 高德定位
-keep class com.amap.api.location.**{*;}
-keep class com.amap.api.fence.**{*;}
-keep class com.loc.**{*;}
-keep class com.autonavi.aps.amapapi.model.**{*;}

## glide 4
-keep public class * implements com.bumptech.glide.module.GlideModule
-keep public class * extends com.bumptech.glide.module.AppGlideModule
-keep public enum com.bumptech.glide.load.resource.bitmap.ImageHeaderParser$** {
    **[] $VALUES;
    public *;
}

## okhttp
-dontwarn okhttp3.**
-keep class okhttp3.**{*;}

## 如使用全文检索插件则需添加以下代码
-dontwarn org.apache.lucene.**
-keep class org.apache.lucene.** {*;}

## 如开启数据库功能则需添加以下代码
-keep class net.sqlcipher.** {*;}

更多组件导入的说明,请参见组件导入

步骤2:初始化

  1. AndroidManefest.xml 中配置 APP Key。

    如果需要使用“发送地理位置消息”的功能,还需在AndroidManefest.xml中配置高德地图 API Key 和定位服务(APSService)。

    示例代码如下:

    java<!-- 在application节点里面增加<meta-data>配置云信APPKey等 -->
    <application ...>
        <meta-data
            android:name="com.netease.nim.appKey"
            <!-- 传入您的云信 App Key -->
            android:value="your APPKey" />
        <!-- 高德地图API Key -->
        <meta-data
            android:name="com.amap.api.v2.apikey"
            <!-- 传入您的高德地图 API Key  -->
            android:value="apikey" />
        <!-- 高德地图 Web server KEY,用于地图消息中采用静态地图方案,高德静态地图文档:https://lbs.amap.com/api/webservice/guide/api/staticmaps-->
        <meta-data
            android:name="com.amap.api.v2.web.apikey"
            android:value="78c0eb6bff7db9ed52e07ca7051a97a3" />
        <!-- 高德地图定位 -->
        <service android:name="com.amap.api.location.APSService" />
    </application>
    

    高德地图 API Key 的具体获取方式,参见高德开放平台文档


  2. 在 IM UIKit 项目的 IMApplication 的 onCreate 中添加如下代码。

    javapublic class IMApplication extends MultiDexApplication {
        @Override
        public void onCreate() {
            super.onCreate();
            // 在Application的onCreate中添加
            SDKOptions options = new SDKOptions();
            //填入APPKEY
            options.appKey = "APP KEY";
            //如果有account和token信息可以填入登录信息直接进行登录
            LoginInfo loginInfo = LoginInfo.LoginInfoBuilder.loginInfoDefault("account", "token").build();
            IMKitClient.init(this,loginInfo,options);
    
            if (IMKitUtils.isMainProcess(this)) {
            // 地图组件初始化,LocationConfig中包含高德地图web API的key,主要用于发送位置消息调用该服务生成图片来展示,提高页面加载性能
            LocationConfig locationConfig = new LocationConfig();
            locationConfig.aMapWebServerKey = "web API的key";
             LocationKitClient.init(this, locationConfig);
            }
        }
    }
    
    

    更多初始化说明,请参见初始化

步骤3:登录

如果登录信息(LoginInfo)在初始化的时候已传入,则不需要再进行本节内容介绍的登录步骤。


如果不能在 Applicatiton 中获取登录信息LoginInfo,需调用IMKitClient类中的loginIM方法登录:

方法名 参数 说明
loginIM LoginInfo 与 IM 服务端建立长连接,登录 IM

调用登录的方法时,将如下示例代码中的 accout_idtoken 分别替换为您的云信账号 ID (即 accout_id)和 Token。

javaLoginInfo loginInfo = LoginInfo.LoginInfoBuilder.loginInfoDefault("accout_id","token").build();
IMKitClient.loginIM(loginInfo,new LoginCallback<LoginInfo>() {
    @Override
    public void onError(int errorCode, @NonNull String errorMsg) {
        //登录失败
    }

    @Override
    public void onSuccess(@Nullable LoginInfo data) {
        //登录成功
    }
});

步骤4:界面搭建

云信 IM UIKit 提供两套风格的 UI 组件库,可任意选择一种使用。两种风格的界面流程如下:

基础版 UI 界面搭建

以搭建会话列表界面为例,基本流程如下(更多详情参见下文的界面集成详情):

  1. 在您应用中需要添加会话列表界面的 Activity 下创建conversationFragment

    示例代码如下:

    javaConversationFragment conversationFragment = new ConversationFragment();
    
  2. conversationFragment添加到这个 Activity 中。

    java    FragmentManager fragmentManager = getSupportFragmentManager();
        //R.id.container 你添加界面的GroupLayout
        fragmentManager
            .beginTransaction().add(R.id.container, conversationFragment)
            .commit();
    

    上述示例代码中的getSupportFragmentManager方法属于 Android Activity 的默认方法,如果您使用 Android X 中的AddCompatActivity则可以直接调用该方法。如果您使用的是android.app.acitivity,则需要调用getFragmentManager方法。


    最终集成效果参考下图:

通用版 UI 界面搭建

以搭建会话列表界面为例,基本流程如下(更多详情参见下文的界面集成详情):

  1. 在您应用中需要添加会话列表界面的 Activity 下创建FunConversationFragment

    示例代码如下:

    javaFunConversationFragment conversationFragment = new FunConversationFragment();
    
  2. conversationFragment添加到这个 Activity 中。

    java    FragmentManager fragmentManager = getSupportFragmentManager();
        //R.id.container 你添加界面的GroupLayout
        fragmentManager
            .beginTransaction().add(R.id.container, conversationFragment)
            .commit();
    

    上述示例代码中的getSupportFragmentManager方法属于 Android Activity 的默认方法,如果您使用 Android X 中的AddCompatActivity则可以直接调用该方法。如果您使用的是android.app.acitivity,则需要调用getFragmentManager方法。

    最终集成效果参考下图:

后续步骤

为保障通信安全,如果您在调试环境中的使用的是云信控制台生成的测试用 IM 账号 和 token,请确保在后续的正式生产环境中,将其替换为通过 IM 服务端 API 生成的正式 IM 账号(accout_id)和 token

相关参考

界面集成详情

IM UIKit 中提供的常用业务场景界面及相关详细集成说明如下:

基础版 UI 界面
界面 所属组件 描述
ConversationFragment conversationkit-ui 会话列表界面(创建或者跳转到该界面需要传入参数,详见集成会话列表界面
ContactFragment contactkit-ui 通讯录界面 (创建或者跳转到该界面需要传入参数,详见集成通讯录界面
ChatP2PFragment/ChatP2PActivity chatkit-ui 单聊会话界面(创建或者跳转到该界面需要传入参数,详见集成会话消息界面
ChatTeamFragment/ChatTeamActivity chatkit-ui 群聊会话界面(创建或者跳转到该界面需要传入参数,详见集成会话消息界面
通用版 UI 界面
界面 所属组件 描述
FunConversationFragment conversationkit-ui 会话列表界面
FunContactFragment contactkit-ui 通讯录界面
FunChatP2PFragment/FunChatP2PActivity chatkit-ui 单聊会话界面
FunChatTeamFragment/FunChatTeamActivity chatkit-ui 群聊会话界面

音视频通话

集成会话界面后,如果需要在会话界面实现音视频通话功能,参考 IMUIKit Demo 中实现代码 MainActivity.java 中 configCallkit() 方法。具体示例请参见实现音视频通话

系统兼容相关

如果项目中的 SdkVersion 采用 Android 13(33) ,那么需要修改其中的权限申请,这样才能正常使用图片和文件发送功能。具体请参考Android 13 文件权限适配

常见问题排查

集成过程中的常见问题的排查说明,请参见 IM UIKit 常见问题排查

此文档是否对你有帮助?
有帮助
去反馈
  • 前提条件
  • 注意事项
  • 实现流程
  • 步骤1:按需导入组件
  • 步骤2:初始化
  • 步骤3:登录
  • 步骤4:界面搭建
  • 后续步骤
  • 相关参考
  • 界面集成详情
  • 音视频通话
  • 系统兼容相关
  • 常见问题排查