Merge pull request #1465 from xuchengpu/chatroom

更新聊天室文档

Author: haoxiuwen

docs/uikit/chatroomuikit/android/roomuikit_integrated.md

@@ -4,30 +4,66 @@
 
 使用 ChatroomUIKit 之前，你需要将 ChatroomUIKit 集成到你的应用中。
 
-## 前提条件
-
-要集成 ChatroomUIKit，你的开发环境需要满足以下需求：
+## 推荐环境
 
 - Android Studio Arctic Fox (2020.3.1) 或以上版本；
 - Android API 级别 21 或以上版本；
 - 使用 Kotlin 语言开发，1.5.21 或以上版本；
 - JDK 1.8 或以上版本；
-- Gradle 7.0.0 或以上版本。
+- Gradle 8.0 或以上版本。
+
+##  添加依赖
+
+### 方式一：（推荐）Gradle 远程依赖
+
+1. 在 Project 工程根目录下的 `settings.gradle.kts` 文件内，添加 `mavenCentral()` 仓库：
+
+```kotlin
+pluginManagement {
+   repositories {
+      ...
+      mavenCentral()
+   }
+}
+dependencyResolutionManagement {
+    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
+    repositories {
+        ...
+        mavenCentral()
+    }
+}
+```
+
+2. 在 app(module) 目录的 `build.gradle.kts` 文件中添加以下依赖。关于 ChatroomUIKit 的最新版本，详见 [Maven 仓库](https://central.sonatype.com/artifact/io.hyphenate/ease-chatroomui-kit/versions)。
 
-## 添加 ChatroomUIKit 模块本地依赖
+```kotlin
+dependencies {
+    ...
+    implementation ("io.hyphenate:ease-chatroomui-kit:1.1.0")
+}
+```
+
+### 方式二：本地源码集成
 
-找到下载的 **ChatroomUIKit** 模块添加为本地依赖。将 [ChatroomUIKit](https://github.com/easemob/UIKit_Chatroom_android/tree/dev/ChatroomUIKit) 和 [ChatroomService](https://github.com/easemob/UIKit_Chatroom_android/tree/dev/ChatroomService) 模块导入到项目中。
+从 GitHub 获取音视频 [ChatroomUIKit](https://github.com/easemob/UIKit_Chatroom_android/tree/dev)，克隆到本地。按照以下步骤集成：
+
+1. 在 Project 工程根目录下的 `settings.gradle.kts` 文件中添加如下代码：
 
 ```kotlin
-// settings.gradle
-include ':ChatroomUIKit'
-include ':ChatroomService'
-project(':ChatroomUIKit').projectDir = new File('../ChatroomUIKit/ChatroomUIKit')
-project(':ChatroomService').projectDir = new File('../ChatroomUIKit/ChatroomService')
+include(":ChatroomUIKit")
+// "../UIKit_Chatroom_android" 要替换成你克隆的实际工程路径，后边要拼接 "/ChatroomUIKit"
+project(":ChatroomUIKit").projectDir = File("../UIKit_Chatroom_android/ChatroomUIKit")
+```
+
+2. 在 app(module) 目录的 `build.gradle.kts` 文件中添加如下代码：
 
-// app/build.gradle
+```kotlin
 dependencies {
-  implementation(project(mapOf("path" to ":ChatroomUIKit")))
+    ...
+    implementation(project(mapOf("path" to ":ChatroomUIKit")))
 }
 ```
 
+## 跑通项目
+详见[快速开始](./roomuikit_quickstart.md#跑通项目)。
+

docs/uikit/chatroomuikit/android/roomuikit_quickstart.md

@@ -4,39 +4,71 @@
 
 利用 ChatroomUIKit，你可以轻松实现聊天室内的用户交互。本文介绍如何实现在聊天室中发送消息。
 
-## 前提条件
+## 推荐环境
 
 - Android Studio Arctic Fox (2020.3.1) 或以上版本；
 - Android API 级别 21 或以上；
 - 使用 Kotlin 语言开发，1.5.21 或以上版本；
 - JDK 1.8 或以上版本；
-- Gradle 7.0.0 或以上版本；
+- Gradle 8.0 或以上版本；
 - 已在[环信控制台](https://console.easemob.com/user/login)创建了有效的环信即时通讯 IM 开发者账号，并[获取了 App Key](/product/console/app_manage.html#查看应用信息)。
 - 如果你的网络环境部署了防火墙，请联系环信技术支持设置白名单。
 
 ## 创建项目引入 ChatroomUIKit 模块
 
 1. 在 Android Studio 中创建一个 Android 平台下的 App 或者打开自己现有项目。
 
-2. 选择 **File** > **import Module**。
+2.  模块依赖。
+方式一：（推荐）Gradle 远程依赖
+① 在 Project 工程根目录下的 `settings.gradle.kts` 文件内，添加 `mavenCentral()` 仓库：
 
-3. 模块本地依赖。
+```kotlin
+pluginManagement {
+   repositories {
+      ...
+      mavenCentral()
+   }
+}
+dependencyResolutionManagement {
+    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
+    repositories {
+        ...
+        mavenCentral()
+    }
+}
+```
 
-找到下载的 **ChatroomUIKit** 模块添加为本地依赖。将 [ChatroomUIKit](https://github.com/easemob/UIKit_Chatroom_android/tree/dev/ChatroomUIKit) 和 [ChatroomService](https://github.com/easemob/UIKit_Chatroom_android/tree/dev/ChatroomService) 模块导入到项目中。
+② 在 app(module) 目录的 `build.gradle.kts` 文件中添加以下依赖。关于 ChatroomUIKit 的最新版本，详见 [Maven 仓库](https://central.sonatype.com/artifact/io.hyphenate/ease-chatroomui-kit/versions)。
 
 ```kotlin
-// settings.gradle
-include ':ChatroomUIKit'
-include ':ChatroomService'
-project(':ChatroomUIKit').projectDir = new File('../ChatroomUIKit/ChatroomUIKit')
-project(':ChatroomService').projectDir = new File('../ChatroomUIKit/ChatroomService')
+dependencies {
+    ...
+    implementation ("io.hyphenate:ease-chatroomui-kit:1.1.0")
+}
+```
+
+方式二：本地源码集成
 
-// app/build.gradle
+从 GitHub 获取音视频 [ChatroomUIKit](https://github.com/easemob/UIKit_Chatroom_android/tree/dev)，克隆到本地。按照以下步骤集成：
+
+① 在 Project 工程根目录下的 `settings.gradle.kts` 文件中添加如下代码：
+
+```kotlin
+include(":ChatroomUIKit")
+// "../UIKit_Chatroom_android" 要替换成你克隆的实际工程路径，后边要拼接 "/ChatroomUIKit"
+project(":ChatroomUIKit").projectDir = File("../UIKit_Chatroom_android/ChatroomUIKit")
+```
+
+② 在 app(module) 目录的 `build.gradle.kts` 文件中添加如下代码：
+
+```kotlin
 dependencies {
-  implementation(project(mapOf("path" to ":ChatroomUIKit")))
+    ...
+    implementation(project(mapOf("path" to ":ChatroomUIKit")))
 }
 ```
 
+## 跑通项目
 ### 第一步 初始化 ChatroomUIKit
 
 你可以在应用加载时或使用 ChatroomUIKit 之前对其进行初始化。

docs/uikit/chatroomuikit/android/roomuikit_run.md

@@ -6,50 +6,43 @@
 
 本文展示如何编译并运行 Android 平台的聊天室 UIKit 示例项目。
 
-## 前提条件
+## 推荐环境
 
 开始前，确保你的开发环境满足如下条件：
 
 - Android Studio Arctic Fox (2020.3.1) 或以上版本；
 - Android API 级别 21 或以上；
 - 使用 Kotlin 语言开发，1.5.21 或以上版本；
 - JDK 1.8 或以上版本；
-- Gradle 7.0.0 或以上版本。
+- Gradle 8.0 或以上版本。
 
 ## 操作步骤
 
-### 第一步 下载 ChatroomUIKit 示例代码
-
+1. 下载 ChatroomUIKit 示例代码
 点击 [github源码](https://github.com/easemob/UIKit_Chatroom_android)，将示例代码下载到本地设备。
 
-### 第二步 添加 ChatroomUIKit 模块依赖
+```bash
+git clone https://github.com/easemob/UIKit_Chatroom_android.git
+```
 
-1. 在 Android Studio 中打开你的项目。
+2. 在 Android Studio 中打开项目。
 
-2. 选择 **File** > **import Module**。
+选择 **File** > **New** > **Import Project**，导入下载或克隆的项目 `UIKit_Chatroom_android`。
 
-3. 添加模块本地依赖。
+3. 点击 `Sync Project with Gradle Files` 同步工程。
 
-找到下载的 **ChatroomUIKit** 模块添加为本地依赖。将 [ChatroomUIKit](https://github.com/easemob/UIKit_Chatroom_android/tree/dev/ChatroomUIKit) 和 [ChatroomService](https://github.com/easemob/UIKit_Chatroom_android/tree/dev/ChatroomService) 模块导入到项目中。
+:::tip
+注意：
+1. 项目中编译使用的 Gradle 版本默认为 8.0，推荐Gradle JDK 版本为 19 及以下。以Mac 版 Android Studio 为例，可以在左上角 **Android Studio** > **Settings** > **Build, Execution, Deployment** > **Build Tools** > **Gradle** > **Gradle JDK**,选择版本为 19 及以下的 JDK，然后点击OK。如果没有合适的 JDK 版本，可以点击 **Download JDK** 下载。
+2. 开发者也可调整 Gradle 及对应的 Gradle JDK 版本。配置地址为  **项目工程根目录** > **gradle** > **gradle-wrapper.properties** > **调整`distributionUrl`值**。
 
-```kotlin
-// settings.gradle
-include ':ChatroomUIKit'
-include ':ChatroomService'
-project(':ChatroomUIKit').projectDir = new File('../ChatroomUIKit/ChatroomUIKit')
-project(':ChatroomService').projectDir = new File('../ChatroomUIKit/ChatroomService')
-
-// app/build.gradle
-dependencies {
-  implementation(project(mapOf("path" to ":ChatroomUIKit")))
-}
-```
+:::
 
-### 第三步 编译
+4. 运行项目
 
-编译时，需要传入 App Key、用户 ID 和用户 token。因此，编译前，你需要在[环信控制台](https://console.easemob.com/user/login)上创建有效的环信即时通讯 IM 开发者账号，并获取 App Key，[创建环信 IM 用户](/product/console/operation_user.html#创建用户)。此外，还需 [创建聊天室](/product/console/operation_chatroom.html#创建聊天室)。
+运行时，需要传入 App Key、用户 ID 和用户 token。因此，你需要在[环信控制台](https://console.easemob.com/user/login)上创建有效的环信即时通讯 IM 开发者账号，并获取 App Key，[创建环信 IM 用户](/product/console/operation_user.html#创建用户)。此外，还需 [创建聊天室](/product/console/operation_chatroom.html#创建聊天室)。
 
-1. 初始化 ChatroomUIKit。
+4.1 初始化 ChatroomUIKit。
 
 ```kotlin
 class ChatroomApplication : Application() {
@@ -63,13 +56,13 @@ class ChatroomApplication : Application() {
 }
 ```
 
-2. 登录 ChatroomUIKit。
+4.2 登录 ChatroomUIKit。
 
 ```kotlin  
  ChatroomUIKitClient.getInstance().login("userId", "token")
 ```
 
-3. 加载 ComposeChatroom 视图，传入 `roomId` 和聊天室所有者的 `UserEntity` 对象。
+4.3 加载 ComposeChatroom 视图，传入 `roomId` 和聊天室所有者的 `UserEntity` 对象。
 
 ```kotlin  
 class ChatroomActivity : ComponentActivity(){
@@ -82,9 +75,9 @@ class ChatroomActivity : ComponentActivity(){
 }
 ```
 
-### 第四步 体验项目
+5. 体验项目
 
-运行并体验该项目。
+在 Android Studio 中，点击 `Run ‘app’` 按钮，将应用运行到你的设备或者模拟器上。
 
 ## 注意事项