IM即时通讯

集成 SDK

1. 安装

在项目中通过 npm 安装 SDK

npm i @cloudroom/im-wasm-sdk -S

2. 使用

1. 在 Vite 中使用

通过 ?url 引入 wasm 以确保资源被正确解析和打包。

// vite.config.ts
export default defineConfig({
  optimizeDeps: {
    exclude: ["@cloudroom/im-wasm-sdk"],
  },
});
// main.js
import { getSDK } from "@cloudroom/im-wasm-sdk";

// vite里获取使用显示url引入wasm
import SDK_WASM_URL from "@cloudroom/im-wasm-sdk/CRIM.wasm?url";
import SQL_WASM_URL from "@cloudroom/im-wasm-sdk/sql-wasm.wasm?url";

//获取单例,配置参数仅首次调用时有效
const IMSDK = getSDK({
  assetsUrl: {
    sdkWasm: SDK_WASM_URL,
    sqlWasm: SQL_WASM_URL,
  },
});

console.log(IMSDK.sdkVersion); // 输出版本号

2. 在 Webpack 中使用

为 wasm 配合 file-loader 获取打包路径,传入SDK内部。

// webpack.config.js
const path = require('path');
module.exports = {
    //...
    module: {
        rules: [
            //...
            {
                test: /\.(js|jsx)$/i,
                loader: 'babel-loader',
                exclude: [
                    path.resolve(__dirname, 'node_modules/@cloudroom/im-wasm-sdk')   //添加此条规则
                ],
            },
            {
                test: /\.wasm$/,
                loader: "file-loader", //需要安装此模块,npm install file-loader
            }
        ],
    },
};
// main.js
import { getSDK } from "@cloudroom/im-wasm-sdk";

import SDK_WASM_URL from "@cloudroom/im-wasm-sdk/CRIM.wasm";
import SQL_WASM_URL from "@cloudroom/im-wasm-sdk/sql-wasm.wasm";

//获取单例,配置参数仅首次调用时有效
const IMSDK = getSDK({
  assetsUrl: {
    sdkWasm: SDK_WASM_URL,
    sqlWasm: SQL_WASM_URL,
  },
});

console.log(IMSDK.sdkVersion); // 输出版本号

3. 在 vue-cli 中使用

在 vue.config.js 中配置对 .wasm 的处理并将SDK加入 transpileDependencies。

// vue.config.js
const { defineConfig } = require("@vue/cli-service");
module.exports = defineConfig({
  transpileDependencies: [/!@cloudroom\/im-wasm-sdk/], //这个参数设置成true也可以
  configureWebpack: {
    module: {
      rules: [
        {
          test: /\.wasm$/,
          loader: "file-loader", //需要安装此模块,npm install file-loader
        },
      ],
    },
  },
});
// main.js
import { getSDK } from "@cloudroom/im-wasm-sdk";

import SDK_WASM_URL from "@cloudroom/im-wasm-sdk/CRIM.wasm";
import SQL_WASM_URL from "@cloudroom/im-wasm-sdk/sql-wasm.wasm";

//获取单例,配置参数仅首次调用时有效
const IMSDK = getSDK({
  assetsUrl: {
    sdkWasm: SDK_WASM_URL,
    sqlWasm: SQL_WASM_URL,
  },
});

console.log(IMSDK.sdkVersion); // 输出版本号

4. 在 html 中使用

适用于直接在页面中通过 <script> 引入 UMD 包的场景,可通过本地静态资源或 CDN 提供 wasm 文件。

<!-- umd包可通过npm包获取 -->
<script src="./dist/index.umd.js"></script>

<script>
    const { getSDK, CbEvents } = CRIM;

    //获取单例,配置参数仅首次调用时有效
    const IMSDK = getSDK({
        assetsUrl: {
            sdkWasm: '/assets/CRIM.wasm',
            sqlWasm: '/assets/sql-wasm.wasm',
        }
    });

    // 输出版本号
    console.log(IMSDK.sdkVersion);
    IMSDK.on(CbEvents.OnConnectSuccess, () => {
        console.log("连接成功");
    });

    IMSDK.login({
        //....
        //登录参数参见下章
    });
</script>

3. 为wasm文件添加cdn(可选)

您可以使用自己的CDN地址,也可以使用公共cdn地址
文档以unpkg为例,您还需要自行更换SDK配套的版本号。

//当assetsUrl为字符串时,该目录下需要包含 CRIM.wasm 和 sql-wasm.wasm 文件
const IMSDK = getSDK({
    assetsUrl: 'https://unpkg.com/@cloudroom/im-wasm-sdk@2.8.2/assets',
});

//当assetsUrl为对象时,按如下格式传递文件地址
const IMSDK = getSDK({
    assetsUrl: {
        sdkWasm: 'https://unpkg.com/@cloudroom/im-wasm-sdk@2.8.2/assets/CRIM.wasm',
        sqlWasm: 'https://unpkg.com/@cloudroom/im-wasm-sdk@2.8.2/assets/sql-wasm.wasm',
    },
});