浏览 SDKs · React Native
SDKsReact Native

开始之前

准备 OpenIMServer、用户登录信息和 React Native 工程环境,再开始初始化和登录。

复制

在 React Native 应用中接入 OpenIM SDK 前,需要准备可访问的 OpenIMServer、可信的用户认证流程,以及能够正常编译原生模块的 React Native 工程。

准备 OpenIMServer

如果还没有可用的 OpenIMServer,先按 Docker 部署指南完成部署,并确认目标设备可以访问以下地址:

字段说明
apiAddrOpenIMServer HTTP API 地址,用于登录、同步和资源请求。
wsAddrOpenIMServer WebSocket 地址,用于建立长连接和接收实时事件。

不要只验证服务在开发电脑本机可以访问。Android 模拟器、iOS 模拟器和真机的网络环境可能不同;生产环境还应检查 DNS、TLS 证书、防火墙、反向代理和 WebSocket 升级是否正常。

准备用户和 Token

userID 标识 OpenIM 用户,Token 用于认证该用户。创建或绑定用户、签发 Token 和校验业务权限都应由可信后端完成。React Native 应用不能保存管理员 Token、secret 或其他服务端凭据。

后端接入 OpenIMServer REST API 前,可阅读准备使用 Platform API签发会话 Token。业务后端完成自身账号认证后,只向客户端返回 SDK 登录所需的以下数据:

数据说明
userID当前登录用户的 OpenIM 用户 ID。
token与该用户对应的登录 Token。
apiAddrOpenIMServer HTTP API 地址。
wsAddrOpenIMServer WebSocket 地址。

userID 必须与 Token 对应。

准备 React Native 工程

接入前确认:

  • 工程已经完成 React Native CLI 或 Expo 自定义开发客户端的原生配置。
  • Android 和 iOS 工程能够分别编译并运行。
  • 确认 Android 和 iOS 的网络配置可用,目标设备能够正常访问 apiAddrwsAddr

React Native SDK 通过原生模块运行,不适用 Expo Go。Expo 项目需要使用 expo prebuild 生成或更新包含 SDK 原生模块的 Android 和 iOS 工程,再构建自定义开发客户端。具体安装方式见按 React Native 环境接入

继续接入

准备完成后,先根据按 React Native 环境接入完成依赖和原生工程配置,再按认证与管理登录会话初始化 SDK 并登录,最后尝试发送第一条消息