微信小程序集成介绍
大约 3 分钟
微信小程序集成介绍
注册环信账号
开发者需要在环信管理后台 注册并创建应用,来获取唯一 appKey,SDK 初始化时需要配置 appKey。
搭建微信小程序开发环境
首先需要下载并安装 开发者工具,然后按照微信小程序的 接入流程一步步创建一个小程序
配置服务器域名
小程序在发布前,需要配置合法域名。
登录微信公众平台, 在开发设置页面按私有部署文档中的 2.2开通防火墙白名单 配置各服务“地址:端口”。
集成 SDK
下载 SDK
可以通过以下两种方式获取 SDK:
- 从环信的 github 仓库 中获取 SDK 中的文件
引入 SDK
- 开始一个全新的项目
- 将下载的 SDK(src/sdk/)导入到自己的项目中。
- 引入 SDK:
import IMSDK from "../sdk/Easemob-chat-miniProgram";
- 基于 Demo 二次开发
将下载的代码导入开发者工具即可运行起来。
调用示例
//使用示例
import SDK from "../sdk/connection"; // 2.0sdk
import SDK from "../sdk/Easemob-chat-miniProgram"; // 3.0sdk
实例调用方式
实例化 SDK,并挂载在全局对象下
//实例化SDK对象
const WebIM = (wx.WebIM = SDK);
WebIM.conn = new WebIM.connection({
appKey: "your appKey",
https: true, //是否使用HTTPS
url: "wss://im-api-wechat.easemob.com/websocket", // socket server (3.0 SDK)
apiUrl: "https://a1.easemob.com", // rest server
heartBeatWait: 30000, //心跳间隔
autoReconnectNumMax: 5, //自动重连次数
useOwnUploadFun: false, // 是否使用自己的上传方式(如将图片文件等上传到自己的服务器,构建消息时只传url)
});
微信小程序的 IM 的基本功能和 API 的使用方法与 Web 端一致,请参考 Web 端文档。