关于腾讯云即时通信 IM

腾讯云即时通信（Instant Messaging，IM）基于 QQ 底层 IM 能力开发，仅需植入 SDK 即可轻松集成聊天、会话、群组、资料管理能力，帮助您实现文字、图片、短语音、短视频等富媒体消息收发，全面满足通信需要。

关于 chat-uikit-vue

chat-uikit-vue 是基于腾讯云 Web IM SDK 的一款 VUE UI 组件库，它提供了一些通用的 UI 组件，包含会话、聊天、关系链、群组、音视频通话等功能。基于 UI 组件您可以像搭积木一样快速搭建起自己的业务逻辑。 chat-uikit-vue 中的组件在实现 UI 功能的同时，会调用 IM SDK 相应的接口实现 IM 相关逻辑和数据的处理，因而开发者在使用 chat-uikit-vue 时只需关注自身业务或个性化扩展即可。 chat-uikit-vue Web 端 和 H5 端界面效果如下图所示：

发送您的第一条消息

开发环境要求

• Vue 3
• TypeScript
• sass（sass-loader 版本 <= 10.1.1）
• node（12.13.0 <= node版本 <= 17.0.0, 推荐使用 Node.js 官方 LTS 版本 16.17.0）
• npm（版本请与 node 版本匹配）

TUIKit 源码集成

步骤1：创建项目

推荐使用 vue-cli 方式创建项目， 配置 Vue3 + TypeScript + sass。 如果您尚未安装 vue-cli ，可以在 terminal 或 cmd 中采用如下方式进行安装：

1npm install -g @vue/cli@4.5.0 sass sass-loader@10.1.1

通过 vue-cli 创建项目，并选择下图中所选配置项。

1vue create chat-example

创建完成后，切换到项目所在目录

1cd chat-example

步骤2：下载 TUIKit 组件

通过 npm 方式下载 TUIKit 组件，为了方便您后续的拓展，建议您将 TUIKit 组件复制到自己工程的 src 目录下：

1# macOS 
2npm i @tencentcloud/chat-uikit-vue
3mkdir -p ./src/TUIKit && cp -r ./node_modules/@tencentcloud/chat-uikit-vue/ ./src/TUIKit

1# windows
2npm i @tencentcloud/chat-uikit-vue && xcopy .\node_modules\@tencentcloud\chat-uikit-vue .\src\TUIKit /i /e

成功后目录结构如图所示：

步骤3：引入 TUIKit 组件

在 main.ts 中，引入 TUIKit，并注册到 Vue 项目实例中：

1import { createApp } from 'vue';
2import App from './App.vue';
3import { TUIComponents, TUICore, genTestUserSig } from './TUIKit';
4
5const SDKAppID = 0; // Your SDKAppID
6const secretKey = ''; //Your secretKey
7const userID = ''; // User ID
8
9// init TUIKit
10const TUIKit = TUICore.init({
11  SDKAppID,
12});
13// TUIKit add TUIComponents
14TUIKit.use(TUIComponents);
15
16// login TUIKit
17TUIKit.login({
18  userID: userID,
19  userSig: genTestUserSig({
20    SDKAppID,
21    secretKey,
22    userID,
23  }).userSig, // The password with which the user logs in to IM. It is the ciphertext generated by encrypting information such as userID.For the detailed generation method, see Generating UserSig
24});
25
26createApp(App).use(TUIKit).mount('#app');

步骤4： 获取 SDKAppID 、密钥与 userID

设置 main.ts 文件示例代码中的相关参数 SDKAppID、secretKey 以及 userID ，其中 SDKAppID 和密钥等信息，可通过 即时通信 IM 控制台 获取，单击目标应用卡片，进入应用的基础配置页面。例如：

userID 信息，可通过 即时通信 IM 控制台 进行创建和获取，单击目标应用卡片，进入应用的账号管理页面，即可创建账号并获取 userID。例如：

步骤5：调用 TUIKit 组件

在需要展示的页面，调用 TUIKit 的组件即可使用。 例如：在 App.vue 页面中，使用 TUIConversation、TUIChat、TUISearch 快速搭建聊天界面。

1<template>
2  <div class="home-TUIKit-main">
3    <div :class="env?.isH5 ? 'conversation-h5' : 'conversation'" v-show="!env?.isH5 || currentModel === 'conversation'">
4      <TUISearch class="search" />
5      <TUIConversation @current="handleCurrentConversation" />
6    </div>
7    <div class="chat" v-show="!env?.isH5 || currentModel === 'message'">
8      <TUIChat>
9        <h1>欢迎使用腾讯云即时通信IM</h1>
10      </TUIChat>
11    </div>
12  </div>
13</template>
14
15<script lang="ts">
16import { defineComponent, reactive, toRefs } from 'vue';
17import { TUIEnv } from './TUIKit/TUIPlugin';
18
19export default defineComponent({
20  name: 'App',
21  setup() {
22    const data = reactive({
23      env: TUIEnv(),
24      currentModel: 'conversation',
25    });
26    const handleCurrentConversation = (value: string) => {
27      data.currentModel = value ? 'message' : 'conversation';
28    };
29    return {
30      ...toRefs(data),
31      handleCurrentConversation,
32    };
33  },
34});
35</script>
36
37<style scoped>
38.home-TUIKit-main {
39  display: flex;
40  height: 100vh;
41  overflow: hidden;
42}
43.search {
44  padding: 12px;
45}
46.conversation {
47  min-width: 285px;
48  flex: 0 0 24%;
49  border-right: 1px solid #f4f5f9;
50}
51.conversation-h5 {
52  flex: 1;
53  border-right: 1px solid #f4f5f9;
54}
55.chat {
56  flex: 1;
57  height: 100%;
58  position: relative;
59}
60</style>
61

步骤6：启动项目

1npm run serve

步骤7：发送您的第一条消息

常见问题

1. 什么是 UserSig？

UserSig 是用户登录即时通信 IM 的密码，其本质是对 UserID 等信息加密后得到的密文。

2. 如何生成 UserSig？

UserSig 签发方式是将 UserSig 的计算代码集成到您的服务端，并提供面向项目的接口，在需要 UserSig 时由您的项目向业务服务器发起请求获取动态 UserSig。更多详情请参见 服务端生成 UserSig。

!

本文示例代码采用的获取 UserSig 的方案是在客户端代码中配置 SECRETKEY，该方法中 SECRETKEY 很容易被反编译逆向破解，一旦您的密钥泄露，攻击者就可以盗用您的腾讯云流量，因此该方法仅适合本地跑通功能调试。 正确的 UserSig 签发方式请参见上文。

3. Component name "XXXX" should always be multi-word

• IM TUIKit web 所使用的 ESLint 版本为 v6.7.2 ，对于模块名的驼峰式格式并不进行严格校验
• 如果您出现此问题，您可以在 .eslintrc.js文件中进行如下配置：

1module.exports = {
2  ...
3  rules: {
4    ...
5    'vue/multi-word-component-names': 'warn',
6  },
7};