前言
在上一篇,我们进行了动态共享包的开发和使用,由于动态共享包有一定的局限性,比如,调用共享包资源还得要通过工具类进行调用,再比如仅用于应用内部代码、资源的共享,如果我想要开源,以远程依赖的方式给任何一个想要用的人进行使用,动态共享包就无法实现,针对以上的种种问题,有没有办法进行解决呢?必须有,这就是今天的主角,静态共享包。
静态共享包(Harmony Archive)HAR ,可以包含代码、C++库、资源和配置文件,可以给一个或多个模块进行依赖使用,和动态共享包不同的是,它不能单独运行,仅仅只能作为依赖项进行使用。
静态共享包很多的使用方式和动态共享包是一致的,考虑到大多数都是首次接触到HarmonyOS开发,为了方便大家更能直观的学习和练习,这里我把静态共享包的流程,也从头至尾的阐述一遍。
本章的内容大纲如下:
1、如何创建一个静态共享包(HAR)
2、静态共享包本地依赖方式
3、静态共享包的多种调用方式
4、静态共享包混淆文件
5、总结
一、如何创建一个静态共享包(HAR)
和动态共享包一样,在当前工程项目名,右键,选择New,然后选择Module即可。
选择Static Library。
设置共享包名字,点击Finish。
和动态共享包不同的是,静态共享包的类型为har。
二、静态共享包本地依赖方式
1、工程内部依赖
工程内部依赖方式,完全和动态共享包一模一样,可以手动进行依赖或者命令方式:
手动方式一,记住格式:【"folder": "file:../folder"】
TypeScript
"staticlibrary": "file:../staticlibrary"
手动方式二:格式,【"@xx/xx": "file:../staticlibrary"】
TypeScript
"@ohos/library": "file:../staticlibrary"
引入之后,进行同步项目,点击Sync Now即可,当然了你可以可以,将鼠标放置在报错处会出现提示,在提示框中点击Run 'ohpm install'。
命令方式依赖:
命令行中或在IDE Terminal窗口中,目录进入到需要引用的模块下,执行ohpm install ../folder命令即可,folder是你的共享包,如下图所示:
命令执行完毕之后,就会自动的在oh-package.json5里添加依赖,并生成映射文件,映射到调用Module的oh_modules目录下:
2、不同工程之间依赖
以上,无论是动态共享包还是静态共享包,都是同工程之间的依赖,但是,很多场景下,为了代码上的复用,我们会有多个项目复用共享包的情况,比如网络共享包,各个工具共享包等等,那么这种方式如何实现呢?
比如,在另一个项目MyLibrary中,有一个静态共享包net,我们在Demo项目中如何使用呢,当然了,这是简单的举例,可以是任何的一个项目,或者任何的一个静态共享包,体现的就是不在一个工程下。
第一步:编译库模块
选中需要共享的静态共享包,点击菜单栏的Build > Make Module选项,如下图:
构建完成之后,在build->default->outputs->default下,就会生成一个.har文件,如下图:
第二步:在需要调用此静态共享包的项目中进行依赖
记住,使用格式【"@xx/xx": "file:../xx.har"】,否则无法进行依赖。
以上的方式,不利于团队之间协作,毕竟你的设备中有这个.har,其他人未必有,所以,为了更好了进行团队协作,还有一种简单的方式,可以把.har文件复制到项目中去,具体的目录自己定义,如下图,我创建了一个libs目录,用于存放.har文件
在上述的依赖方式中,无论是同工程,还是不同工程,在实际的开发中,都有着一定的局限性,比如,如果是同工程,那么就实现不了项目之间的复用,如果是不同工程,即便把.har复制到项目中,实现了团队协作,如果har有更新,那么还得替换,着实不便。
有没有一种类似Android中的远程Maven形式呢,可以很负责任的告诉大家,必须有,那就远程依赖方式,由于内容比较多,我们放到下一篇文档来阐述。
三、静态共享包多种调用方式
无论你是采用同工程还是不同工程,还是远程的依赖的方式,其本质的实现方式是一样的。
1、资源调用
资源调用就比较简单了,可以直接调用,不用和动态共享包那样做中转处理。
比如静态共享包中,有一个字符串资源,当然,也可以是其他的资源,比如颜色、大小、音视频等等,都可以。
其他引用到此静态共享包的模块,就可以直接调用,按照$r('app.type.name')格式,type是你自己定义的资源类型,name是你定义的资源名字,如上图的资源,我们就可以如下调用,毕竟是静态共享包,可以和当前模块的调用方式完全一样。
TypeScript
$r('app.string.static_name')
关于资源类型,HarmonyOS提供了多种资源类型,在前面的了解工程结构那章有详细的介绍,这里再简单罗列一下:
|---------------|---------------------------------------------------|
| 文件 | 概述 |
| boolean.json | 布尔型 |
| color.json | 颜色 |
| float.json | 浮点型 |
| intarray.json | 整型数组 |
| integer.json | 整型 |
| pattern.json | 样式 |
| plural.json | 复数形式 |
| strarray.json | 字符串数组 |
| string.json | 字符串值 |
| media | 多媒体文件,如图形、视频、音频等文件,支持的文件格式包括:.png、.gif、.mp3、.mp4等 |
| rawfile | 用于存储任意格式的原始资源文件:$rawfile('filename')" |
2、方法调用
比如在静态共享包中,有一个add求和方法,代码如下,记得如果想外暴露,一定要使用关键字export。
其他引用到此静态共享包的模块就可以如下调用,直接调用add方法即可,会有提示导包,如果没有,可按照图中导包方式进行导包即可。
3、类调用
和方法调用一样,我们在静态共享包中创建一个需要暴露的类,这里我以一个日志打印类作为测试,记住凡是需要暴露给外部使用的,一定要添加关键字export。
调用方式和方法如出一辙:
4、组件调用
在静态共享包中有一个自定义的文本组件,展示的内容为:Hello staticlibrary,如下:
调用方式如下,可以直接作为视图展示:
5、跳转静态共享包中的页面
经过验证之后,HAR不支持在配置文件中声明pages页面,如果验证不对,还望大家可以进行指出。
6、注意事项
对外暴露的接口,需要在共享包入口文件index.ets中声明,否则,其他模块无法调用,都是固定的模式,比如上述的add方法,和自定义的组件等,切记!!!
同一个类中的,如果多个方法,可以复用,比如:
TypeScript
export { Log, add, minus } from './utils/test'
四、静态共享包混淆文件
混淆,在开发中,顾名思义,就是把易于理解的代码变成难于阅读和理解的行为,目的是为了代码的安全,避免外泄,如果仅仅是自己公司使用,确实没必要混淆,毕竟都是同一家公司,没必要做的那么苛刻,如果是作为一个开源的代码,为了自身的权益,只开放功能,而保留代码的安全,那么就可以进行混淆,当然了,凡是不能绝对,还是得具体问题具体分析。
我们先看一下未混淆前的效果,所有的源代码均可在oh_modules中清晰查看:
一起再看下混淆后的效果,变成了两个文件,由原来的Net.ts,换成了Net.d.ts和Net.js两个文件,再看源码,已无法查看到原来的样式。
如何进行混淆呢,很是简单,再需要打静态共享包的build-profile.json5文件中,增加如下的属性即可:
artifactType字段有以下两种取值,默认缺省为original。
original:不混淆。
obfuscation:混淆,目前仅支持uglify混淆。
需要注意的是,按照官方解读,artifactType字段设置为obfuscation时,apiType字段必须设置为stageMode,因为Stage模型才支持混淆。
五、总结
静态共享包解决了,多项目开发复用代码的问题,也实现了,代码功能封装直接远程使用的方便,提供了一个开源的便捷使用,这是仅应用内部代码、资源共享的动态共享包所不能比的,当然了,两种共享包,各有优缺点,如何取舍,在于自己的决策。
其实关于静态共享包.har,大家有没有发现,动态共享包在构建编译后,也会创建一个.har文件,没错,你也可以完全通过动态共享包 ,开发自己的静态共享包。
下一篇,我们将带来静态共享包如何实现远程依赖和上传 以及关于静态共享包私服的搭建,敬请期待!