OpenHarmony系統之應用接口文件轉換工具介紹
簡介:
應用接口文件轉換工具是根據異構格式接口文件(.h文件)轉換生成OpenHarmony系統應用層需要的TS(type-script)接口文件(*.d.ts)的工具。若某個服務實現方式為c++,且供應用層訪問的接口已在.h文件中定義,此時,NAPI接口開發者使用此工具可一鍵生成對應的ts文件,后續一方面應用開發者可直接調用相關的接口,另一方面系統框架開發者可根據生成的TS文件,使用NAPI框架生成代碼工具,生成NAPI框架實現代碼。應用接口文件轉換工具支持VS Code插件、IntelliJ插件兩種入口。
使用場景
系統框架層新增子系統,需對應用層提供接口。
系統框架層子系統能力增強后,需對應用層提供新接口。
應用層引入C++三方庫,需增加OpenHarmony應用層接口。
獲取方式
VS Code插件獲取方式
1.打開VS Code,在左側邊欄中選擇插件安裝。
2.在應用商店搜索ts-gen插件,再單擊安裝。
3.安裝完成后就會在VS Code的插件管理器中能看到ts-gen這個插件了。
IntelliJ插件獲取方式
IntelliJ插件下載,路徑如下:
安裝插件,File->Settings->Plugins->Installed->Install Plugin from Disk…,選擇下載的插件,安裝成功之后重啟IDE。
使用方法
VS Code插件使用方法
1.把需要轉換的.h文件放到任意目錄下。
2.選擇.h文件,點擊右鍵選擇 Generate Ts Frame,工具彈出Generate Ts Frame彈窗。文件路徑文本框填寫.h文件路徑;輸出目錄選擇文本框填寫生成.d.ts文件存放路徑,點擊ok。
3.執行結束后會在out目錄下生成.d.ts代碼文件。
IntelliJ插件使用方法
1.把需要轉換的.h文件放在DevEco stdio新建項目的src目錄下。
2.選擇.h文件,點擊右鍵選擇Generate Ts Frame,工具彈出Generate Ts Frame彈窗,選擇Ts-Gen頁簽。文件路徑文本框填寫.h文件路徑;輸出目錄選擇文本框填寫生成.d.ts文件存放路徑,點擊ok。
3.執行結束后會在輸出目錄下生成.d.ts代碼文件。
總結
本文介紹了根據使用者指定的.h文件,工具會轉換輸出對應的ts接口文件。工具為開源工具,社區有對應的源碼,歡迎大家進行交流。