了解命令行使用整体流程:环境安装、运行时预览效果,掌握基本概念:项目产出
rpk
文件
通过本节,你将学会:
注意:本节介绍如何使用命令行开发快应用。如果使用 IDE 开发,则不需要学习本节内容。
需安装8.0以上版本的 NodeJS (建议使用 10.0+ 以上),请从NodeJS 官网下载
请注意:hap-toolkit@0.3 及其以后的版本不再支持 NodeJS v8.0 以下的版本)
调试器是一个 Android 应用程序,下载调试器 APK 详见资源下载
在手机上安装并打开调试器,按钮功能如下:
注意:若打开调试器无法点击按钮,请升级手机系统到最新版本或安装平台预览版
安装成功后如下图所示:
较新的系统版本中内置平台正式版,开发调试平台新功能可使用平台预览版
平台预览版存在以下优缺点:
平台预览版是一个 Android 应用程序,下载平台预览版 APK 详见资源下载
下载安装成功后,在手机调试器中点击切换运行平台至org.hapjs.mockup
,即可在平台预览版上安装运行 rpk 包
hap-toolkit 为开发编译工具
通过 npm 仓库安装,在命令行中执行以下命令:
npm install -g hap-toolkit
在命令行中执行hap -v
会输出版本信息表示hap-toolkit
安装成功,如下命令所示:
hap -v
开发环境搭建完成,以及 hap-toolkit 工具完成,我们就可以进行项目开发
安装 toolkit 工具后,可通过全局hap
命令创建一个项目模板,如下所示:
hap init <ProjectName>
其中<ProjectName>
为自定义的项目名称,如hap init demo
关于生成项目模板具体介绍,详情请见:项目结构讲解
在项目根目录下,运行如下命令安装模块到node_modules
目录
npm install
在项目的根目录下,运行如下命令进行编译打包,生成 rpk 包
npm run build
编译打包成功后,项目根目录下会生成文件夹:build、dist
rpk
,这个rpk
文件就是项目编译后的最终产出如果希望每次修改源代码文件后,都自动编译项目,请使用如下命令:
npm run watch
编译项目产出了 rpk 包后,请打开手机调试器
若打开调试器无法点击按钮,请升级手机系统到最新版本或安装平台预览版
调试器可使用后,就可以在调试器上安装 rpk 包了
可以通过 WIFI 在线更新方式安装 rpk 包,此方式要确保手机与 PC 在同一局域网,步骤如下:
1 启动 HTTP 服务器
在终端中新建一个窗口,进入项目的根目录运行如下命令,启动本地服务器(默认端口为 8000)
npm run server
自定义端口(如:8080)
npm run server -- --port 8080
2 在手机上扫码安装
步骤如下:
打开快应用调试器 --> 关闭"开启USB调试"
点击"扫码安装"
,扫描终端窗口中的二维码即可完成配置(若扫描不成功,可在浏览器中打开页面:http://localhost:<your port>
,扫描页面中的二维码)在线更新
唤起平台运行 rpk 包若提示安装失败
,请检查执行 npm run server 的终端窗口是否正常运行,手机和 PC 是否可以通过 IP 相互访问
注意:
安装成功后,效果如下:
了解项目的目录结构,编译时通过编译工具产出rpk
文件,运行时通过调试器安装rpk
文件;打通整个流程后,开发者就可以边开发边预览效果了
至此,我们初步完成通过命令行工具进行快应用开发相关工作,项目调试工作,详情请见:调试
在项目发布生产前,需进行发布前打包工作
在工程的根目录下运行
npm run build
编译后的工程目录在/<ProjectName>
/build
生成的应用路径为/<ProjectName>
/dist/<ProjectPackage>
.rpk
通过 openssl 命令等工具生成签名文件private.pem
、certificate.pem
,例如:
openssl req -newkey rsa:2048 -nodes -keyout private.pem -x509 -days 3650 -out certificate.pem
在工程的 sign 目录下创建 release 目录,将私钥文件 private.pem 和证书文件 certificate.pem 拷贝进去
注:
从hap-toolkit@0.7.2
版本开始,通过命令hap init
新建的项目,sign 目录默认只存放 release 版证书,不再在目录下区分sign/debug
与sign/release
目录来存放 debug 与 release 版签名,详情可查看此处
因此,通过上述步骤生成的签名文件,在新版 toolkit 新建的项目,直接拷贝至项目的 sign 目录即可,无需先创建 release 目录
发布程序包前需要增加release签名
,然后在工程的根目录下运行
npm run release
生成的应用路径为/<ProjectName>
/dist/<ProjectPackage>
.release.rpk
如果已经打包测试或正式版 rpk 后,需要在自己的手机上或者发给别人预览效果时,我们可以这么做:
sdcard/rpks