• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# h2sa工具使用说明
2## 简介
3
4h2sa工具，即SERVICE框架生成工具，该工具支持命令行和VS Code插件，使用者可以根据自己的需要下载工具使用。
5
6## 工具介绍
7
8通过SERVICE框架生成工具，使用者只需提供一个定义远程方法的.h头文件，一键生成SERVICE框架代码，主要包含Ability注册、proxy/stub类实现、MessageParcel数据包构造、Service子系统编译及开机自启动相关配置文件。
9
10![](../figures/pic-service-frm.png)
11
12## 准备
13
14下载python脚本可执行程序header_parser.exe（linux系统为header_parser)，下载链接如下：
15
16// 下载header_parser工具  从发行版下载的链接
17
18获取命令行可执行程序service-gen-win.exe、service-gen-linux，用户可根据以下步骤生成命令行可执行程序：
19
20[工具开发说明](https://gitee.com/openharmony/napi_generator/tree/master/src/cli/h2sa/docs/guide/DEVELOP_ZH.md)
21
22## 生成框架
23
24### 可执行程序使用方法
25
26#### Linux
27
281.将待转换的.h文件放到任意目录下，建议放到可执行程序service-gen-linux与header_parser同级目录下，如下所示：
29
30	OpenHarmony@Ubuntu-64:~/service/napi_generator_8/hdc/service-gen/examples$ ls
31	test.h  header_parser  service-gen-linux
32
332.在终端中进入到可执行程序service-gen-linux所在的目录，并运行service-gen-linux，命令如下：
34
35	OpenHarmony@Ubuntu-64:~/service/napi_generator_8/hdc/service-gen/examples$ ./service-gen-linux -f test.h -o ./ -s 9016
36
37其中,参数详情如下：
38  -f，定义远程服务的.h文件；
39  -l, 日志级别（0-3），默认为1；
40  -o, 生成框架代码输入到指定路径下；
41  -s, 指定serviceID。
42
433.运行成功后会在当前目录下生成对应的文件，如下所示：
44
45	OpenHarmony@Ubuntu-64:~/service/napi_generator_8/hdc/service-gen/examples$ ls
46	test.h  header_parser  napi_gen.log  service-gen-linux  testservice
47
48#### Windows
49
501.将要转换的.h文件放到任意目录下，建议放到可执行程序service-gen-win.exe与header_parser.exe同级目录下，如下所示：
51
52	E:\demo\service>dir /B
53	test.h
54	header_parser.exe
55	service-gen-win.exe
56
572.在终端中进入到可执行程序service-gen-win.exe所在的目录，并运行service-gen-win.exe，命令如下：
58
59	E:\demo\service>service-gen-win.exe -f test.h -o ./ -s 9016
60
61其中,参数详情如下：
62  -f，定义远程服务的.h文件；
63  -l, 日志级别（0-3），默认为1；
64  -o,生成框架代码输入到指定路径下；
65  -s,指定serviceID。
66
673.运行成功后会在当前目录下生成对应的文件，如下所示：
68
69	E:\demo\service>dir /B
70	test.h
71	header_parser.exe
72	napi_gen.log
73	service-gen-win.exe
74	testservice
75
76#### Mac
77
78方法步骤参考windows、Linux的使用方法。
79
80### VS Code插件使用方法
81
82具体的插件使用步骤，可以左键单击以下链接了解：
83
84[VS插件使用说明](https://gitee.com/openharmony/napi_generator/tree/master/src/vscode_plugin/h2sa/service_vs_plugin/docs/usage/INSTRUCTION_ZH.md)
85
86## 集成
87
88Service框架代码生成后，系统框架开发者进行二次开发后，即可集成到OpenHarmony编译系统，生成对应的库文件，供应用开发者调用接口。工具集成到OpenHarmony的具体操作步骤可以左键单击以下链接了解：
89
90[工具集成](https://gitee.com/openharmony/napi_generator/blob/master/src/cli/h2sa/docs/usage/h2sa_ENSEMBLE_METHOD_ZH.md)
91
92