JS開源庫適配OpenHarmony系列—第一期實操
一、為什么適配JS開源庫
由于OpenHarmony應(yīng)用是基于ArkTS開發(fā),而ArkTS是在保持TypeScript(簡稱TS)基礎(chǔ)語法風(fēng)格的基礎(chǔ)上,對TS的動態(tài)類型特性施加更嚴格的約束,引入靜態(tài)類型。因此在開發(fā)OpenHarmony三方庫時,建議首選在成熟的JS/TS開源三方庫上開發(fā)。
二、選擇哪個JS開源庫合適
JS/TS開源三方庫的選擇需遵循易用性、實用性、維護性、擴展性等特性,通常方法是在github/npm上按照特性和語言搜索,找到star、fork數(shù)量較高的,且開源協(xié)議友好的JS/TS開源三方庫進行適配。
三、如何進行JS開源庫適配
由于OpenHarmony開發(fā)框架中的API不完全兼容V8運行時的Build-In API,因此建議在適配JS三方庫前,使用js-e2e掃描三方庫,檢查是否存在node.js/web內(nèi)置模塊的依賴。
js-e2e工具時基于eslint進行封裝,可分析出JS庫代碼對node.js/web瀏覽器的內(nèi)置模塊、對象的依賴及兼容ES標(biāo)準(zhǔn)版本,使用該工具,可以快速知道該庫是否依賴node.js/web內(nèi)置模塊。
如果掃描結(jié)果不依賴node.js/web內(nèi)置模塊,那么,這個庫將比較輕松地適配。如果大量依賴node.js/web內(nèi)置組件,這時可能需要fork源庫代碼,進行侵入式修改,或者再找是否存在更適合的其他三方庫。
注:掃描時需同時掃描package.json文件中dependencies標(biāo)簽中直接依賴和間接依賴,因為發(fā)布OpenHarmony三方庫中心倉時,需要將依賴的組件都發(fā)布。建議使用npm insall下載所有依賴的代碼后,一起掃描查看結(jié)果。
1、luxon開源庫信息
在npm中心倉庫查看用于處理日期和時間的目標(biāo)庫luxon信息,包括開源倉庫地址,主頁地址,版本,協(xié)議,文件大小,總文件數(shù),最后發(fā)布時間等。
在OpenHarmony中心倉搜索是否存在luxon目標(biāo)庫。
在luxon源代碼倉庫查看star和fork數(shù)量,查看是否被經(jīng)常使用和經(jīng)常被維護。
luxon倉庫:https://github.com/moment/luxon
2、JS三方庫掃描工具介紹
js-e2e是基于eslint進行封裝、配置規(guī)則,用于分析JS庫代碼對NodeJS和Web瀏覽器的內(nèi)置模塊、對象的依賴及兼容ES標(biāo)準(zhǔn)版本的工具,支持檢查指定源碼目錄和指定三方庫的兼容性。
(1)使用git工具同步j(luò)s-e2e代碼
(2)安裝npm依賴包
(3)安裝自定義的eslint輸出報告formatter,包含csv、csvsimple、vscode、vscodesimple
(4)執(zhí)行檢查命令
3、適配luxon三方庫
使用DevEco Studio開發(fā)者工具,創(chuàng)建OpenHarmony應(yīng)用工程。
在工程中新建Module,選擇“Static Library”模板。
移除library模塊src/main/ets目錄中的components目錄,刪除Index.ets文件中的代碼。
直接復(fù)制js-e2e工具檢查時下載的luxon包(temp/node_modules/luxon),并將src目錄中的文件復(fù)制到library模塊的src/main/ets/lib目錄下。
修改Index.ets文件為其他開發(fā)者提供調(diào)用接口。
在oh-package.json5中完善三方庫信息,如名稱、簡介、版本、開源協(xié)議、作者、關(guān)鍵字等。
在工程目錄中選中三方庫名稱,單擊菜單欄中的Build > Make Module ‘library’編譯構(gòu)建生成三方庫HAR包,HAR包可在模塊下的build目錄下獲取,包格式為*.har。
4、驗證luxon三方庫
打開entry/oh-package.json5配置文件,在dependencies標(biāo)簽中引入luxon三方庫,并單擊Sync Now進行同步。
打開pages/Index.ets頁面文件,引入luxon三方庫并顯示當(dāng)前日期。
至此,簡單的JS開源三方庫適配OpenHarmony已經(jīng)完成了,下節(jié)我們將推出如何將講解如何進行XTS測試,OpenHarmony三方庫發(fā)布標(biāo)準(zhǔn),適配的三方庫發(fā)布到OpenHarmony三方庫中心倉以及如何貢獻到OpenHarmony-TPC。