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应用开发

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,907评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,987评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,298评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,586评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,633评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,488评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,275评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,176评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,619评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,819评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,932评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,655评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,265评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,871评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,994评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,095评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,884评论 2 354

推荐阅读更多精彩内容