HarmonyOS之共享包

  • 概述

    鸿蒙中有两种共享包,HAR(Harmony Archive)静态共享包和HSP(Harmony Shared Package)动态共享包。

    HAR与HSP都是为了实现代码和资源的共享,都可以包含代码、C++库、资源和配置文件,最大的不同之处在于:HAR中的代码和资源跟随使用方编译,如果有多个使用方,它们的编译产物中会存在多份相同拷贝;而HSP中的代码和资源可以独立编译,运行时在一个进程中代码也只会存在一份。

    HAR和HSP在APP包中的形态示意图
  • HSP

    使用IDE的SharedLibrary模板创建后,结构如下:

    HSP目录结构

    在其中的oh-package.json5中:

    {
      "license": "Apache-2.0",
      "devDependencies": {},
      "author": "",
      "name": "my_shared_library",
      "description": "Please describe the basic information.",
      "main": "Index.ets",
      "version": "1.0.0",
      "dependencies": {}
    }
    

    有一个main属性,在这个属性指定的文件中export需要的组件和类(包括native类),这个文件名字随便起,但是文件一定要放在该HSP的根目录下(基于DevEco Studio4.0.3.700)。

    在main指定的Index.ets中:

    export { MyHsp } from './src/main/ets/pages/Index'
    

    这里export了一个组件,其中MyHsp是组件名。这样一来,使用方就可以import它来使用了。

    它的module.json5中:

    {
      "module": {
        "name": "my_shared_library",
        "type": "shared",
        "description": "$string:shared_desc",
        "deviceTypes": [
          "phone",
          "tablet",
          "2in1"
        ],
        //标识当前Module是否在用户主动安装的时候安装,表示该Module对应的HAP是否跟随应用一起安装。- true:主动安装时安装。- false:主动安装时不安装。
        "deliveryWithInstall": true,
        "pages": "$profile:main_pages"
      }
    }
    

    注意这里的type是shared

  • HAR

    使用IDE的StaticLibrary模板创建后,结构如下:

    截屏2023-12-28 16.50.17.png

    和HSP一样,它的oh-package.json5中的main属性指定export文件,在其中配置需要export的组件和类。

    它的module.json5中:

    {
      "module": {
        "name": "har2",
        "type": "har",
        "deviceTypes": [
          "default",
          "tablet",
          "2in1"
        ]
      }
    }
    

    type是har

  • 依赖和导入

    使用HSP和HAR也很简单,在使用方module下(一般是entry)的oh-package.json5中:

    {
      "license": "",
      //这个是用于开发过程中使用的依赖工具,不会打包到HAP中
      "devDependencies": {},
      "author": "",
      "name": "entry",
      "description": "Please describe the basic information.",
      "main": "",
      "version": "1.0.0",
      "dependencies": {
        //本地依赖的key可以是自定义,最终会在oh_modules下生成
        "my-shared-library": "file:../my_shared_library",
        "har1": "file:../har1",
        "har2": "file:../har2"
      }
    }
    

    在dependencies属性下添加依赖项,前面的key可以自定义,value指定对应共享包module的相对路径,然后根据IDE的提示进行ohpm的安装,比如上面的依赖项定义好,build后会在使用方module下的oh_modules目录下生成对应的依赖目录:

    截屏2023-12-28 15.09.41.png

    注意,key会作为依赖项的最终导入名,下面我们来看导入。

    import {MyHsp} from 'my-shared-library'
    //如果都导入的话
    import('my-shared-library')
    
    //导入har
    import {Har1Page} from 'har1'
    

    可以看到,这里可以导入部分,也可以导入所有export的组件和类。注意看from后面的信息,这个就是前面dependencies中指定的key值,他们是一一对应的。(测试的时候需要用真机或者模拟器,previewer暂不支持共享包调用效果)

  • 命名路由

    对应module内的路由导航,我们通常使用profile指定的路由表进行,但是在module之间的路由导航时通常使用命名路由来完成。

    router.pushNamedRoute({ name: 'MyHSP' }, (err) => {
      if (err) {
        console.error(`pushNamedRoute failed, code is ${err.code}, message is ${err.message}`);
        return;
      }
      console.info('pushNamedRoute success');
    })
    

    比如在一个HSP中的Entry组件的@Entry属性上定义一个路由名字:

    @Entry({ routeName: 'MyHSP' })
    @Component
    export struct MyHsp {
      ...
    }
    

    然后在跳转处导入:

    import('my-shared-library')
    

    还有一种方式,即如果使用如下的导入方式的话:

    import {MyHsp} from 'my-shared-library'
    

    则MyHsp组件必须保证在组件树中使用了,如果没使用的话进行路由跳转则会失败。当然上面的导航需要依赖好共享包之后才能跳转,在IDE的测试时需要在该处配置好依赖module,否则会报错:

    截屏2023-12-28 15.23.38.png

    截屏2023-12-28 15.24.53.png

    其实,命名路由还可以进行同一module内的路由跳转:

    import('./Demo1')
    

    比如这里的Demo1文件存在于调用方同一目录下时的引入方式。但是对于同一module内的导航来说,这种方式有些画蛇添足,因为它需要多一步手动导入的过程,不如直接使用路由表跳转来的简单、整洁。

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

推荐阅读更多精彩内容