https://github.com/netease-kit/nim-uikit-android
云信 IM UIKit 是基于 NIM SDK（网易云信 IM SDK）开发的一款即时通讯 UI 组件库，包括聊天、会话、圈组、搜索、群管理等组件。通过 IM UIKit，可快速集成包含 UI 界面的即时通讯应用。
https://github.com/netease-kit/nim-uikit-android
android im uikit
Last synced: about 2 months ago
JSON representation
云信 IM UIKit 是基于 NIM SDK（网易云信 IM SDK）开发的一款即时通讯 UI 组件库，包括聊天、会话、圈组、搜索、群管理等组件。通过 IM UIKit，可快速集成包含 UI 界面的即时通讯应用。
- Host: GitHub
- URL: https://github.com/netease-kit/nim-uikit-android
- Owner: netease-kit
- License: mit
- Created: 2015-09-02T05:46:42.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2025-05-06T06:02:30.000Z (about 1 year ago)
- Last Synced: 2025-05-06T07:25:47.461Z (about 1 year ago)
- Topics: android, im, uikit
- Language: Java
- Homepage:
- Size: 76.1 MB
- Stars: 721
- Watchers: 20
- Forks: 137
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
-------------------------------
网易云信即时通讯界面组件（简称 IM UIKit）是基于 [NIM SDK（网易云信 IM SDK）](https://doc.yunxin.163.com/messaging2/concept/DI0Nzc2NzA?platform=client) 开发的一款即时通讯 UI 组件库，包括聊天、会话、圈组、搜索、通讯录、群管理等组件。通过 IM UIKit，您可快速集成包含 UI 界面的即时通讯应用。
## 适用客群
IM UIKit 简化了基于 NIM SDK 的应用开发过程，适合需要快速集成和定制即时通讯功能的开发者和企业客户。它不仅能助您快速实现 UI 功能，也支持调用 NIM SDK 相应的接口实现即时通讯业务逻辑和数据处理。因此，您在使用 IM UIKit 时仅需关注自身业务或个性化扩展。
## 主要功能
IM UIKit 主要分为会话、群组、联系人等几个 UI 子组件，每个 UI 组件负责展示不同的内容。更多详情，请参考 [功能概览](https://doc.yunxin.163.com/messaging-uikit/concept/zMzMDQ2MTg?platform=client) 和 [UI 组件介绍](https://doc.yunxin.163.com/messaging-uikit/concept/TI3NTgyNDA?platform=client)。
## 功能优势
### 组件解耦
IM UIKit 不同组件可相互独立运行使用。您可按需选择组件，将其快速集成到您的应用，实现相应的 UI 功能，减少无用依赖。
### 简洁易用
IM UIKit 的业务逻辑层与 UI 层相互独立。在 UI 层，您仅需关注视图展示和事件处理。IM UIKit 清晰的数据流转处理，让 UI 层代码更简洁易懂。
### 自定义能力
IM UIKit 支持在各 UI 组件的初始化过程中配置自定义 UI。同时提供 Fragment（安卓）、Controller（iOS）、Widget（Flutter）和 View 的能力封装，助您快速将 UI 功能添加到您的应用中。
### 业务逻辑处理
IM UIKit 业务逻辑层提供完善的业务逻辑处理能力。您无需关心 SDK 层不同接口间的复杂处理逻辑，业务逻辑层一个接口帮您搞定所有。
## 工作原理
IM UIKit 采用 （Model–View–ViewModel）MVVM 架构模型，实现 UI 展示与业务逻辑开发的相互独立。
流程 | 说明
---- | ----
1 | IM UIKit 展示层的 Activity/Fragment/View 向响应层的 ViewModel 发送请求。
2 | ViewModel 将请求经由业务逻辑层转发至 NIM SDK（网易云信 IM SDK）。
3 | NIM SDK 接收请求后触发回调，回调数据经由业务逻辑层和响应层发送至 Activity/Fragment/View。
4 | Activity/Fragment/View 将回调数据发送至 RecyclerViewAdapter。后者根据界面需要展示的不同实体的 type，判定具体的 UI 样式。例如，SDK 返回的回调数据为消息数据时，RecyclerViewAdapter 可判定消息数据中包含的消息类型（即 type），将消息在 UI 上展示为对应类型的样式。
## 组件架构
上图中：
- UIKit 层的 `ContactKit-ui`、`ChatKit-ui`、`ConversationKit-ui` 和 `TeamKit-ui`，对应上述工作原理图中的 Activity/Fragment/View。
- UIKit 层的 `ChatKit`，对应上述工作原理图中的 Repository。
- CoreKit 层对应上述工作原理图中的 Provider。
## 相关文档
- IM UIKit 的功能清单，请参考 [IM UIKit 功能概览](https://doc.yunxin.163.com/messaging-uikit/concept/zMzMDQ2MTg)。
- 若需要直接体验 IM Demo，请参考 [体验 Demo](https://doc.yunxin.163.com/messaging-uikit/guide/Dg4MTg2MTM?platform=android)。
- 若需要跑通 IM Demo，请参考 [跑通 IM Demo 源码](https://doc.yunxin.163.com/messaging-uikit/guide/zk0MjE5Mjk?platform=android)。
- IM UIKit 的集成流程，请参考 [集成开发文档](https://doc.yunxin.163.com/messaging-uikit/guide/DU4NzAzNzQ?platform=android)。
- IM UIKit 已支持音视频通话，具体实现流程请参考 [实现音视频通话功能](https://doc.yunxin.163.com/messaging-uikit/guide/jgxOTUyMjQ?platform=android)。
