PC安裝toolkit工具
安裝NodeJS
需安裝6.0以上版本的NodeJS,請從NodeJS官網下載,推薦v6.11.3
html
注意: 不要使用8.0.*版本.這個版本內部ZipStream實現與node-archive包不兼容,會引發報錯node
安裝hap-toolkit
經過npm倉庫安裝,在命令行中執行如下命令:shell
npm install -g hap-toolkit
在命令行中執行hap -V
會輸出版本信息表示hap-toolkit
安裝成功,以下命令所示:npm
hap -V
手機安裝調試器
調試器是一個Android應用程序,下載調試器APK詳見資源下載json
在手機上安裝並打開調試器,按鈕功能以下:瀏覽器
- 掃碼安裝:配置HTTP服務器地址,下載rpk包,並喚起平臺運行rpk包
- 本地安裝:選擇手機文件系統中的rpk包,並喚起平臺運行rpk包
- 在線更新:從新發送HTTP請求,更新rpk包,並喚起平臺運行rpk包
- 開始調試:喚起平臺運行rpk包,並啓動遠程調試
注意:若打開調試器沒法點擊按鈕,請升級手機系統到最新版本或安裝平臺預覽版服務器
安裝成功後以下圖所示:app
手機安裝平臺預覽版
較新的系統版本中內置平臺正式版,開發調試平臺新功能可以使用平臺預覽版工具
平臺預覽版存在如下優缺點:post
- 優勢:迭代速度快,可當即體驗平臺新功能
- 缺點:實現與真實的運行環境存在差別,對廠商服務和第三方服務的支持存在缺陷
平臺預覽版是一個Android應用程序,下載平臺預覽版APK詳見資源下載
下載安裝成功後,在手機調試器中點擊切換運行平臺至org.hapjs.mockup
,便可在平臺預覽版上安裝運行rpk包
總結
安裝toolkit工具和調試器,瞭解平臺預覽版,爲建立項目和預覽效果作好準備
建立項目
建立項目前,請先安裝toolkit工具和調試器。如未安裝,詳見文檔環境搭建
安裝toolkit工具後,可經過全局hap
命令建立一個項目模板,以下所示:
hap init <ProjectName>
其中<ProjectName>
爲自定義的項目名稱,如hap init demo
命令執行後,會在當前目錄下建立<ProjectName>
文件夾,做爲項目根目錄
這個項目已經包含了項目配置與示例頁面的初始代碼,項目根目錄主要結構以下:
├── sign rpk包簽名模塊 │ └── debug 調試環境 │ ├── certificate.pem 證書文件 │ └── private.pem 私鑰文件 ├── src │ ├── Common 公用的資源和組件文件 │ │ └── logo.png 應用圖標 │ ├── Demo 頁面目錄 │ | └── index.ux 頁面文件,可自定義頁面名稱 │ ├── app.ux APP文件,可引入公共腳本,暴露公共數據和方法等 │ └── manifest.json 項目配置文件,配置應用圖標、頁面路由等 └── package.json 定義項目須要的各類模塊及配置信息
目錄的簡要說明以下:
- src:項目源文件夾
- sign:簽名模塊,當前僅有
debug
簽名,若是內測上線,請添加release
文件夾,增長線上簽名;簽名生成方法詳見文檔編譯工具
安裝依賴
在項目根目錄下,運行以下命令安裝模塊到node_modules
目錄
npm install
編譯項目
手動編譯項目
在項目的根目錄下,運行以下命令進行編譯打包,生成rpk包
npm run build
編譯打包成功後,項目根目錄下會生成文件夾:build、dist
- build:臨時產出,包含編譯後的頁面js,圖片等
- dist:最終產出,包含rpk文件。實際上是將build目錄下的資源打包壓縮爲一個文件,後綴名爲
rpk
,這個rpk
文件就是項目編譯後的最終產出
自動編譯項目
若是但願每次修改源代碼文件後,都自動編譯項目,請使用以下命令:
npm run watch
安裝rpk包
編譯項目產出了rpk包後,請打開手機調試器。安裝調試器詳見文檔環境搭建
若打開調試器沒法點擊按鈕,請升級手機系統到最新版本或安裝平臺預覽版。安裝平臺預覽版詳見文檔環境搭建
調試器可以使用後,就能夠在調試器上安裝rpk包了。支持如下兩種安裝方式,開發者可根據場景選擇其一
掃碼安裝
- 適用場景:高頻率更新rpk包
- 優勢:自動更新rpk包,方便快捷
- 缺點:須要開發者啓動HTTP服務器,並確保手機與PC在同一局域網
1 啓動HTTP服務器
在終端中新建一個窗口,進入項目的根目錄運行以下命令,啓動本地服務器(默認端口爲12306)
npm run server
自定義端口(如:8080)
npm run server -- --port 8080
2 在手機上預覽運行效果
配置HTTP服務器地址有兩種方式,如下二者選其一便可:
打開調試器 --> 點擊"掃碼安裝"
,掃描終端窗口中的二維碼便可完成配置(若掃描不成功,可在瀏覽器中打開頁面:http://localhost:<your port>
,掃描頁面中的二維碼)打開調試器 --> 點擊右上角menu --> 設置
,輸入終端窗口中提示的HTTP服務器地址
配置完成後,可點擊在線更新
喚起平臺運行rpk包
若提示安裝失敗
,請檢查執行npm run server的終端窗口是否正常運行
本地安裝
- 適用場景:僅預覽效果或低頻率更新rpk包
- 優勢:只需將rpk包複製到手機中,本地安裝選擇rpk包便可
- 缺點:需手動更新rpk包
1 複製rpk包到手機中
將<ProjectName>/dist
目錄下編譯產出的rpk
包經過USB數據線或其餘方式,複製到手機文件系統中
2 本地安裝rpk包
打開調試器 --> 點擊"本地安裝"
,選擇手機文件系統中的rpk包,並自動喚起平臺運行rpk包,查看效果
預覽效果
安裝成功後,效果以下:
總結
瞭解項目的目錄結構,編譯時經過編譯工具產出rpk
文件,運行時經過調試器安裝rpk
文件;打通整個流程後,開發者就能夠邊開發邊預覽效果了