1# dts2cpp工具 2 3## 简介 4dts2cpp工具,它可以根据用户指定路径下的ts(typescript)接口文件一键生成NAPI框架代码、业务代码框架、GN文件等。在开发JS应用与NAPI间接口时,底层框架开发者无需关注js语法、C++与JS之间的数据类型转换等上层应用转换逻辑,只关注底层业务逻辑即可,专业的人做专业的事,从而可以大大提高开发效率。 5 6## 约束 7系统:建议Ubuntu 20.04或者Windows 10 8 9依赖版本:VS Code 1.62.0 10 11## 使用方法 12 13### 生成框架 14 151.安装typescript:在napi_generator/src/cli/dts2cpp/src目录下执行命令: 16 17 npm i typescript 18 192.安装stdio:在napi_generator/src/cli/dts2cpp目录下执行命令: 20 21 npm i stdio 22 233.将待转换的文件@ohos.napitest.d.ts拷贝到napi_generator/src/cli/dts2cpp/src/gen下,并在该目录下新建out目录;@ohos.napitest.d.ts如下所示: 24 25``` 26declare namespace napitest { 27 function funcTest(v: boolean): string; 28} 29export default napitest; 30``` 31 324.在napi_generator/src/cli/dts2cpp/src/gen下执行以下命令生成napi框架代码: 33 34``` 35node cmd_gen.js -f @ohos.napitest.d.ts -o out 36``` 37 38其中,参数详情如下: 39 40 -f, 待转换的.d.ts文件,若同时转换多个文件,文件之间用“,”隔开; 41 42 -d, 根据指定路径转换该文件夹中所有.d.ts文件; 43 44 -i, 可选参数,默认false,待转换.d.ts文件中引用非basic.d.ts的ts文件时打开开关; 45 46 -o, 可选参数,默认为当前目录,指定生成框架代码输出路径; 47 48 -n, 可选参数,默认为uint32_t,指定生成框架代码中number类型全部为指定类型; 49 50 -s, 可选参数,默认为不配置业务代码,指定生成框架代码的业务配置文件,用于粘合工具代码和业务代码的配置。 51 52 备注1:-f与-d两个参数只选其中一个参数即可。 53 54 备注2:若.d.ts文件中声明了其它.d.ts文件,将此类文件放置在待转换.d.ts文件同级目录。 55 565.输出文件如下所示: 57 58 59 60### 集成 61 62[生成代码集成到OpenHarmony的方法](https://gitee.com/openharmony/napi_generator/blob/master/src/cli/dts2cpp/docs/usage/dts2cpp_ENSEMBLE_METHOD_ZH.md) 63 64### 调用 65 66NAPI框架代码生成后,系统框架开发者进行二次开发后,即可集成到OpenHarmony编译系统,生成对应的库文件,供应用开发者调用接口。工具集成测试的具体操作步骤可以左键单击以下链接了解: 67 68[工具集成测试](https://gitee.com/openharmony/napi_generator/blob/master/src/cli/dts2cpp/docs/usage/dts2cpp_INTEGRATION_TESTING_ZH.md)