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