集成 SDK
大约 1 分钟
HarmonyOS 集成文档
集成 SDK
本文介绍如何将环信即时通讯 IM SDK 集成到你的 HarmonyOS 项目。
开发环境要求
- DevEco Studio NEXT Release(5.0.3.900)及以上;
- HarmonyOS SDK API 12 及以上;
- HarmonyOS NEXT.0.0.71 或以上版本的设备。
集成 SDK
远程依赖
在项目根目录下执行如下命令:
ohpm install @easemob/chatsdk
默认情况下,ohpm install @easemob/chatsdk
将会安装最新版本的SDK,您可以通过以下方式指定安装的版本:
ohpm install @easemob/chatsdk@x.y.z
提示
- SDK 1.8.0 版本及以后才支持远程依赖方式;
- 上面的命令在根目录执行,会将 SDK 依赖添加到项目级别;如果要将 SDK 依赖到 Module 级别,需要在对应的 Module 目录下执行上面的命令。
本地依赖
打开 SDK 下载页面,获取最新版的环信即时通讯 IM HarmonyOS SDK,得到 har
形式的 SDK 文件。
将 SDK 文件,拷贝到 entry
模块或者其他需要的模块下的 libs
目录。
修改模块目录的 oh-package.json5
文件,在 dependencies
节点增加依赖声明。
{
"dependencies": {
"@easemob/chatsdk": "file:./libs/chatsdk-x.x.x.har"
}
}
最后单击 File > Sync and Refresh Project 按钮,直到同步完成。
添加项目权限
在模块的 module.json5
,例如:entry
模块的 module.json5
中,配置示例如下:
{
module: {
requestPermissions: [
{
name: "ohos.permission.GET_NETWORK_INFO",
},
{
name: "ohos.permission.INTERNET",
},
],
},
}
build-profile.json5
中设置支持字节码 HAR 包。
在工程 修改工程级 build-profile.json5
文件,在 products
节点下设置 useNormalizedOHMUrl
为 true
。
{
"app": {
"products": [
{
"buildOption": {
"strictMode": {
"useNormalizedOHMUrl": true
}
}
}
]
}
}
提示
- 此配置需要将
DevEco Studio
升级到Beta2(5.0.3.502)
及以上版本。 - SDK 1.3.0 及以上版本采用字节码构建方式打包,必须设置
useNormalizedOHMUrl
为true
。