OpenHarmony组件化-如何使用OpenHarmony npm包

创建OpenHarmony npm模块

通过如下两种方法,在OpenHarmony工程中添加OpenHarmony npm包模块。

方法1:鼠标移到工程目录顶部,点击鼠标右键,选择New>Module。

方法2:在菜单栏选择File > New > Module。

在Choose Your Ability Template界面中,选择Ohos Library,并点击Next

在Configure the New Module界面中,设置新添加的模块信息,设置完成后,点击Finish完成创建。

Module name:新增模块的名称。

UI Syntax:选择开发OpenHarmony npm包的语言。

Device type:选择OpenHarmony npm包支持的设备类型。

Enable Native:是否创建一个用于调用C++代码的OpenHarmony npm共享模块。

创建完成后,会在工程目录中生成OpenHarmony npm共享模块及相关文件。

编译OpenHarmony npm模块

开发完OpenHarmony npm模块后,选中模块名,然后通过DevEco Studio菜单栏的Build > Make Module ${libraryName}进行编译构建,生成OpenHarmony npm包。OpenHarmony npm包可用于工程其它模块的引用,或将OpenHarmony npm包上传至npm仓库,供其他开发者下载使用。

编译构建的OpenHarmony npm包可在模块下的build目录下获取,包格式为*.tgz。

对于OpenHarmony npm包有如下两点需要进行说明:

在编译构建OpenHarmony npm包的过程中,不会将模块中的C++代码打包进.tgz文件中,而是会被编译成动态依赖库.so文件,并放置在libs目录下。原因是因为C++的编译构建任务只会在工程的模块下被执行。

在编译构建OpenHarmony npm包的过程中,会生成资源文件ResourceTable.txt,以便编辑器可以对OpenHarmony npm包中的资源文件进行联想。因此,如果不使用DevEco Studio对OpenHarmony npm进行构建,则DevEco Studio的编辑器会无法联想OpenHarmony npm包中的资源。

引用本地OpenHarmony npm模块

引用本地OpenHarmony npm模块的文件和资源,有以下两种方式:

1.在命令行工具中,执行如下命令进行安装,并会在package.json中自动添加依赖。

npminstall ../library --save

2.在package.json中的配置示例如下:

可以直接应用工程如下:

"dependencies": {

  "@ohos/library":"file:../library"

}

也可以直接引用编译生成的*.tgz文件文件如下:

"dependencies": {

  "@ohos/library":"file:./ohos-library-1.0.0.tgz"

}

依赖设置完成后,需要在Terminal窗口执行npm install命令下载依赖包(到对应的entry目录下执行),依赖包会存储在工程的node_modules目录下。

npm install

在引用OpenHarmony npm包时需要注意以下几点:

OpenHarmony npm包在package.json中必须声明name字段为@ohos开头。

只有声明在模块和工程下的package.json的dependencies内的依赖,才会被当做OpenHarmony依赖使用,并在编译构建过程中进行相应的处理。

引用的模块的compileSdkVersion不能低于其依赖的OpenHarmony npm三方包(可在node_modules目录下,找到引用的npm包的src > main > module.json中查看)。

FA模型和Stage模型的模块之间暂不支持互相引用。

OpenHarmony npm包暂不支持配置Ability。

备注:本地调试如果需要改变library代码,需要变更版本号重新nmp install后才会生效。

引用OpenHarmony npm包eTS页面

eTS是TypeScript的拓展,因此导出和引入的语法与TypeScript一致。在OpenHarmony npm模块中,可以通过export导出eTS页面,示例如下所示:

// library/src/main/ets/components/MainPage/MainPage.ets

@Entry

@Component

export struct MainPage {

@Statemessage: string ='Hello World'

  build() {

Row() {

Column() {

Text(this.message)

.fontSize(50)

.fontWeight(FontWeight.Bold)

      }

.width('100%')

    }

.height('100%')

  }

}

然后在其它模块中通过import引入导出的eTS页面,示例如下所示:

// entry/MainAbility/pages/index.ets

import{ MainPage }from"@ohos/library"

@Entry

@Component

struct Index {

@Statemessage:string='Hello World'

build(){

Column(){

      MainPage()

Row(){

Text(this.message)

.fontSize(50)

          .fontWeight(FontWeight.Bold)

      }

.width('100%')

    }

.height('10%')

  }

}

引用OpenHarmony npm包内ts/js方法

ts/js方法的导出和引用,与eTS页面的引用相同,即在OpenHarmony npm模块中,可以通过export导出ts/js方法,示例如下所示:

// library/index.js

exportfunctionfunc(){

return"[npm] func1";

}

然后在其它的ts/js页面中,通过import引入导出的ts/js方法,示例如下所示:

// entry/src/main/js/MainAbility/pages/index/index.js

import{func}from"@ohos/library"

exportdefault{

data: {

title:""

    },

onInit(){

this.title = func();

    }

}

引用OpenHarmony npm包内资源

支持在OpenHarmony npm模块和依赖OpenHarmony npm的模块中引用OpenHarmony npm模块内的资源,例如在OpenHarmony npm模块的scr/main/resources里添加字符串资源(在string.json中定义,name:hello_npm)和图片资源(icon_npm.png)。然后在Entry模块中引用该字符串资源和图片资源的示例如下:

// entry/src/main/ets/MainAbility/pages/index.ets

@Entry

@Component

struct Index {

@Statemessage: string ='Hello World'

  build() {

Column() {

Row() {

Text($r("app.string.hello_npm"))// 字符串资源

.fontSize(40)

.fontWeight(FontWeight.Bold)

      }

.width('50%')

Image($r("app.media.icon_npm"))// 图片资源

    }

.height('100%')

  }

}

在编译构建中HAP中,DevEco Studio会从HAP模块及依赖的模块中收集资源文件,如果不同模块下的资源文件出现重名冲突时,DevEco Studio会按照以下优先级进行覆盖(优先级由高到低):

AppScope(仅API9的Stage模型支持)

HAP包自身模块

依赖的OpenHarmony npm模块

参考文档:开发OpenHarmony npm包-工程管理-HUAWEI DevEco Studio For OpenHarmony使用指南-工具-HarmonyOS应用开发

你可能感兴趣的:(OpenHarmony组件化-如何使用OpenHarmony npm包)