简介:
应用接口文件转换工具是根据异构格式接口文件(.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接口文件。工具为开源工具,社区有对应的源码,欢迎大家进行交流。