• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Ts接口生成工具
2
3## 简介
4本文主要介绍ts(type-script)接口生成工具，它可以根据定义在c++头文件中的接口，生成type-script语言的ts接口文件。若某个服务实现方式为c++，且供应用层访问的接口已在.h文件中定义，此时，NAPI接口开发者使用此工具可一键生成对应的ts文件，进而将生成的ts文件作为NAPI框架生成代码工具的输入，生成NAPI框架代码。串行使用ts接口生成工具、NAPI框架代码生成工具，形成工具链，达到降低NAPI接口开发难度，提高开发效率。目前工具支持可执行文件、IntelliJ插件两种入口。
5
6更多工具的架构和实现原理详情，可以左键单击以下链接了解：
7
8[工具使用说明](https://gitee.com/openharmony/napi_generator/tree/master/src/cli/h2dts/docs/usage/INSTRUCTION_ZH.md)
9
10	├── napi_generator                # 工具集
11	│   ├── ...                       # 其它文件
12	│   ├── src
13	│   │   ├── ...
14	│   │   ├── cml
15	│   │   |   ├── ...                       # 其它工具
16	│   │   |   ├── h2dts/src              # 工具源码
17	│   │   │   │   ├── tsGen                 # Ts框架工具源码
18	│   │   |   │   │   ├── header_parser.py  # 解析C++头文件并生成表示类的数据结构
19	│   │   |   │   │   |── tsMain.js         # Ts框架工具源码入口
20
21## 约束
22系统：建议Ubuntu 20.04或者Windows 10
23
24依赖版本：VS Code 1.62.0
25
26## 使用方法
27
28### 使用对象
29
30系统开发者、应用Native开发者
31
32### 使用场景
33
341) 系统框架层新增子系统，需对应用层提供接口。
352) 系统框架层子系统能力增强后，需对应用层提供新接口。
363) 应用层引入C++三方库，需增加OpenHarmony应用层接口。
37
38### 工具使用
39
40工具有两种类型，分别是可执行文件、IntelliJ插件。其中的可执行文件可根据工具使用者的开发环境选择，支持Windows，Linux和Mac。可执行文件、IntelliJ插下载路径如下，选择napi_generator_outputs.zip中generator.jar下载：
41
42[下载链接](http://ftp.kaihongdigi.com:5000/fsdownload/mKjfCmPjk/generator_outputs_NAPI_0930)
43
44具体的工具使用步骤，可以左键单击以下链接了解：
45
46[工具使用说明](https://gitee.com/openharmony/napi_generator/tree/master/src/cli/h2dts/docs/usage/INSTRUCTION_ZH.md)
47
48### 工具输出
49
50根据使用者指定的.h文件，工具会输出对应的ts接口文件。为了方便使用者快速上手工具，可供测试的test.h文件样例如下：
51
52```
53
54	#include < string >
55	#include < vector >
56	using namespace std;
57
58	class TestA {
59    	public:
60    	char16_t string1;
61    	void add(string v, long double v1[]);
62	};
63	double count(double v, double v1[]);
64
65	namespace Space {
66    	class TestBB {
67        	public:
68        	short string4;
69        	bool ifExist(bool v, bool v1[]);
70	};
71    	uint32_t max(uint32_t v, uint32_t v1[]);
72	}
73```
74
75在window环境下的，根据输入文件test.h,生成的输出文件，如下所示：
76
77![](./docs/figures/h-2-ts-succ.png)
78
79
80其中生成的"test.d.ts"文件，定义了应用开发接口，如下所示：
81
82	declare class TestA {
83		string1: string;
84		add(v: string, v1: Array<number>): void;
85	}
86	declare namespace Space {
87		function max(v: number, v1: Array<number>): number;
88		class TestBB {
89	    	string4: number;
90	    	ifExist(v: boolean, v1: Array<boolean>): boolean;
91		}
92	}
93	declare function count(v: number, v1: Array<number>): number;
94
95	export default Space;
96
97
98## 工具开发说明
99
100### 对象
101
102工具的开发者
103
104### 开发场景
105
106若当前工具的功能已经不能满足开发者的全部需求，则开发者可以基于已有的源码对工具进行二次开发，来增强工具的能力，编译打包生成自定义的可执行文件和插件。
107
108### 开发步骤
109
110开发者可以根据如下的步骤来完成对工具的开发：
111
112 [工具开发说明](https://gitee.com/openharmony/napi_generator/tree/master/src/cli/h2dts/docs/guide/DEVELOP_ZH.md)
113
114## 版本说明
115
116 [版本说明](https://gitee.com/openharmony/napi_generator/blob/master/src/cli/h2dts/docs/release-notes/ts_Gen-1.0.md)
117
118## FAQ
119
120  [FAQ](https://gitee.com/openharmony/napi_generator/tree/master/src/cli/h2dts/docs/guide/FAQ.md)
121
122## 参与贡献
123
124暂无
125
126## 相关仓
127
128暂无
129