1# OpenHarmony JS和TS三方组件使用指导 2## OpenHarmony JS和TS三方组件介绍 3 4OpenHarmony JS和TS三方组件使用的是OpenHarmony静态共享包,即HAR(Harmony Archive),可以包含js/ts代码、c++库、资源和配置文件。通过HAR,可以实现多个模块或者多个工程共享ArkUI组件、资源等相关代码。HAR不同于HAP,不能独立安装运行在设备上,只能作为应用模块的依赖项被引用。 5 6 7 8## 查找OpenHarmony JS和TS三方组件 9 101. 关注Gitee官网OpenHarmony-TPC[三方组件资源汇总](https://gitee.com/openharmony-tpc/tpc_resource)项目,根据目录索引即可找到对应分类下的具体组件。 11 12 13 142. 访问[OpenHarmony三方库中心仓](https://ohpm.openharmony.cn/),搜索需要的三方组件。 15 16 17 18## 安装并使用OpenHarmony JS和TS语言的三方组件 19 20引用三方HAR,包括从仓库进行安装和从本地库模块中进行安装两种方式。 21 22**引用仓库安装的HAR** 23 24引用ohpm仓中的HAR,首先需要设置三方HAR的仓库信息,DevEco Studio默认仓库地址是"https://repo.harmonyos.com/ohpm/",如果您想设置自定义仓库,请在DevEco Studio的Terminal窗口执行如下命令进行设置(执行命令前,请确保将DevEco Studio中ohpm安装地址配置在“环境变量-系统变量-PATH”中): 25``` 26ohpm config set registry=your_registry1,your_registry2 27``` 28说明:ohpm支持多个仓库地址,采用英文逗号分隔。 29然后通过如下两种方式设置三方包依赖信息: 30 - 方式一:在Terminal窗口中,执行如下命令安装三方包,DevEco Studio会自动在工程的oh-package.json5中自动添加三方包依赖。 31``` 32ohpm install @ohos/lottie 33``` 34 - 方式二:在工程的oh-package.json5中设置三方包依赖,配置示例如下: 35``` 36"dependencies": { "@ohos/lottie": "^2.0.0"} 37``` 38依赖设置完成后,需要执行ohpm install命令安装依赖包,依赖包会存储在工程的oh_modules目录下。 39``` 40ohpm install 41``` 42 43**引用本地库模块的文件和资源** 44 45- 方式一:在Terminal窗口中,执行如下命令进行安装,并会在oh-package5.json中自动添加依赖。 46``` 47ohpm install ../library 48``` 49- 方式二:在工程的oh-package.json5中设置三方包依赖,配置示例如下: 50``` 51"dependencies": { 52 "library": "file:../library" 53} 54``` 55依赖设置完成后,需要执行ohpm install命令安装依赖包,依赖包会存储在工程的oh_modules目录下。 56``` 57ohpm install 58``` 59 60> **说明:** 61> 62> 在引用OpenHarmony HAR时,请注意以下事项 63>- 当前只支持在模块和工程下的oh-package.json5文件中声明dependencies依赖,才会被当做OpenHarmony依赖使用,并在编译构建过程中进行相应的处理。 64>- 引用的模块的compileSdkVersion不能低于其依赖的OpenHarmony ohpm三方包(可在oh_modules目录下,找到引用的ohpm包的src > main > module.json5 中查看)。 65 66 67 68### 引用OpenHarmony HAR hml页面 69在JS工程范式中,组件功能由hml承载,开发者可以在JS工程的hml页面通过<element>标签来引入OpenHarmony HAR中的共享hml页面,示例如下: 70``` 71<element name="comp" src="library/src/main/js/components/index/index.hml"></element> 72``` 73其中,library为OpenHarmony HAR的包名,hml页面的路径为OpenHarmony HAR中的相对路径。 74随后便可以通过设置的name来使用该element元素,以引用OpenHarmony HAR中的hml页面,示例如下: 75```typescript 76<element name="comp" src="library/src/main/js/components/index/index.hml"></element> 77 78<div class="container"> 79 <comp></comp> 80 <text class="title"> 81 {{ $t('strings.hello') }} {{ title }} 82 </text> 83</div> 84``` 85### 引用OpenHarmony HAR ArkTS页面 86ArkTS是TypeScript的扩展,因此导出和引入的语法与TypeScript一致。在OpenHarmony ohpm模块中,可以通过export导出ArkTS页面,示例如下: 87```typescript 88// library/src/main/ets/components/mainpage/MainPage.ets 89@Entry 90@Component 91export struct MainPage { 92 @State message: string = 'Hello World' 93 build() { 94 Row() { 95 Column() { 96 Text(this.message) 97 .fontSize(50) 98 .fontWeight(FontWeight.Bold) 99 } 100 .width('100%') 101 } .height('100%') 102 } 103} 104``` 105然后在其它模块中通过import引入导出的ArkTS页面,示例如下所示: 106```typescript 107// entry/MainAbility/pages/index.ets 108 109import { MainPage } from "library" 110@Entry 111@Component 112struct Index { 113 @State message: string = 'Hello World' 114 build() { 115 Column() { 116 MainPage() 117 Row() { 118 Text(this.message) 119 .fontSize(50) 120 .fontWeight(FontWeight.Bold) 121 } 122 .width('100%') 123 } 124 .height('10%') 125 } 126} 127``` 128引用OpenHarmony HAR内ts/js方法ts/js方法的导出和引用,与ArkTS页面的引用相同,即在OpenHarmony ohpm模块中,可以通过export导出ts/js方法,示例如下所示: 129```typescript 130// library/index.js 131export function func() { 132 return "[ohpm] func1"; 133} 134``` 135然后在其它的ts/js页面中,通过import引入导出的ts/js方法,示例如下所示: 136```typescript 137// entry/src/main/js/MainAbility/pages/index/index.js 138import {func} from "library" 139export default { 140 data: { 141 title: "" 142 }, 143 onInit() { 144 this.title = func(); 145 } 146} 147``` 148引用OpenHarmony HAR内资源支持在OpenHarmony ohpm模块和依赖OpenHarmony ohpm的模块中引用OpenHarmony ohpm模块内的资源。例如在OpenHarmony ohpm模块的scr/main/resources里添加字符串资源(在string.json中定义,name:hello_ohpm)和图片资源(icon_ohpm.png)。然后在Entry模块中引用该字符串资源和图片资源的示例如下: 149当前暂不支持类Web范式引用i18n文件中的国际化资源。 150```typescript 151// entry/src/main/ets/MainAbility/pages/index.ets 152@Entry 153@Component 154struct Index { 155 @State message: string = 'Hello World' 156 build() { 157 Column() { 158 Row() { 159 Text($r("app.string.hello_ohpm")) // 字符串资源 160 .fontSize(40) 161 .fontWeight(FontWeight.Bold) 162 } 163 .width('50%') 164 Image($r("app.media.icon_ohpm")) // 图片资源 165 } 166 .height('100%') 167 } 168} 169``` 170在编译构建HAP中,DevEco Studio会从HAP模块及依赖的模块中收集资源文件,如果不同模块的相同限定词目录下的资源文件出现重名冲突时,DevEco Studio会按照以下优先级进行覆盖(优先级由高到低): 171- AppScope(仅API 9的Stage模型支持) 172- HAP包自身模块 173- 依赖的OpenHarmonyHarmony ohpm模块