往期鸿蒙5.0全套实战文章必看:(文中附带全栈鸿蒙5.0学习资料)
引用共享包
引用三方HAR,包括从仓库进行安装、从本地文件夹和本地压缩包中进行安装三种方式。
- 引用ohpm仓中的HAR,首先需要设置三方HAR的仓库信息,DevEco Studio默认仓库地址为OpenHarmony三方库中心仓,如果您想设置自定义仓库,请在DevEco Studio的Terminal窗口执行如下命令进行设置(执行命令前,请确保已将ohpm配置到环境变量中,第一次配置环境变量后,需重启DevEco Studio):
ohpm config set registry your_registry1,your_registry2
说明:ohpm支持多个仓库地址,采用英文逗号分隔。
- 方式一:在Terminal窗口中,切换到需要引入三方包的模块,如entry模块,执行如下命令安装三方包,DevEco Studio会自动在该模块的oh-package.json5中自动添加三方包依赖。
cd path/to/your/project/entry ohpm install @ohos/lottie
- 方式二:在需要引入三方包的模块的oh-package.json5中设置三方包依赖,配置示例如下:
"dependencies": { "@ohos/lottie": "^2.0.0" }
依赖设置完成后,需要执行ohpm install命令安装依赖包,依赖包会安装到该模块的oh_modules目录下。
ohpm install
- 方式一:在Terminal窗口中,切换到需要引入三方包的模块,如entry模块,执行如下命令安装三方包,DevEco Studio会自动在该模块的oh-package.json5中自动添加三方包依赖。
- 引用本地模块源码(该本地模块必须与宿主模块归属于同一个工程),如entry模块需要依赖foo模块的源码,有如下两种方式:
- 方式一:在Terminal窗口中,切换到需要引入本地模块源码的模块,即entry模块下,执行如下命令进行安装,并会在该模块下的oh-package.json5中自动添加依赖。
cd path/to/your/project/entry ohpm install path/to/foo
- 方式二:在需要引入本地模块源码的模块的oh-package.json5中设置源码依赖项,即entry模块的oh-package.json5中,添加如下配置:
"dependencies": { "foo": "file:path/to/foo" // 此处也可以是以当前oh-package.json5所在目录为起点的相对路径 }
依赖设置完成后,需要执行ohpm install命令安装依赖包,模块foo的源码会安装在entry模块的oh_modules目录下。
ohpm install
- 方式一:在Terminal窗口中,切换到需要引入本地模块源码的模块,即entry模块下,执行如下命令进行安装,并会在该模块下的oh-package.json5中自动添加依赖。
- 引用本地HAR/HSP包,有如下两种方式:
- 方式一:在Terminal窗口中,切换到需要引入本地HAR/HSP包的模块,如entry模块,执行如下命令进行安装,并会在oh-package.json5中自动添加依赖。以HAR/HSP包在工程根目录下为例,配置示例如下(实际配置时请以HAR/HSP包实际目录为准):
- 引用HAR:
cd path/to/your/project/entry ohpm install path/to/package.har
- 引用HSP(*.tgz包通过HSP模块在release模式下编译生成):
cd path/to/your/project/entry ohpm install path/to/package.tgz
- 引用HAR:
- 方式二:在需要引入三方包的模块的oh-package.json5中设置本地HAR/HSP包。以HAR/HSP包在工程根目录下为例,配置示例如下(实际配置时请以HAR/HSP包实际目录为准):
- 引用HAR:
"dependencies": { "package": "file:path/to/package.har" // 此处也可以是以当前oh-package.json5所在目录为起点的相对路径。 }
说明
代码片段中package.har为三方包文件名;"package"为引用该三方包所使用的依赖名称,建议与三方包包名,即三方包的oh-package.json5文件中的name字段保持一致。
- 引用HSP:
"dependencies": { "package": "file:path/to/package.tgz" // 此处也可以是以当前oh-package.json5所在目录为起点的相对路径 }
依赖设置完成后,需要执行ohpm install命令安装依赖包,依赖包会安装在该模块的oh_modules目录下。
ohpm install
- 引用HAR:
- 方式一:在Terminal窗口中,切换到需要引入本地HAR/HSP包的模块,如entry模块,执行如下命令进行安装,并会在oh-package.json5中自动添加依赖。以HAR/HSP包在工程根目录下为例,配置示例如下(实际配置时请以HAR/HSP包实际目录为准):
另外,在安装或卸载共享包时,可在模块或工程的oh-package.json5文件中增加钩子设置,以管理install、uninstall命令的生命周期,配置示例如下:
"hooks": {
"preInstall": "echo 00 preInstall", // install命令执行之前
"postInstall": "echo 00 postInstall", // install命令执行之后
"preUninstall": "echo 00 preUninstall", // uninstall命令执行之前
"postUninstall": "echo 00 postUninstall" // uninstall命令执行之后
}
说明
- 目前只支持执行当前模块或工程的oh-package.json5文件中hooks,不支持执行依赖中hooks。
- 在引用共享包时,请注意当前只支持在模块和工程下的oh-package.json5文件中声明dependencies依赖,才会被当做依赖使用,并在编译构建过程中进行相应的处理。