OpenHarmony开发者论坛

标题: h2sa工具使用说明 [打印本页]

作者: 深开鸿_胡瑞涛 时间: 2024-9-18 10:37
标题: h2sa工具使用说明
[md]## 简介

h2sa工具，即SERVICE框架生成工具，当开发者为OpenHarmony系统框架开发某些功能时，有时需要将这个功能包装成一个独立的服务进程运行在系统中，为了其它应用进程能够调用此服务，开发人员需要基于系统IPC通信框架编写一套远程接口调用实现。实现Service远程调用接口需要开发人员熟悉IPC通信框架，了解proxy/stub的继承与实现方式，掌握C++类型转为MessageParcel数据包的各种API方法，有一定的学习成本。而Service代码生成工具能够帮助使用者生成框架代码，提升开发效率。用户只需提供一个定义远程方法的.h头文件，工具会自动生成整个Service框架的代码，包含Ability注册、proxy/stub类实现、MessageParcel数据包构造、Service子系统编译及开机自启动相关配置文件。

## 约束

系统：建议Ubuntu 20.04或者Windows 10

依赖版本：VS Code 1.62.0

## 使用方法

#### 命令行

1. 安装python库 CppHeaderParser

```
pip install CppHeaderParser
```
2. 安装typescript：在napi_generator/src/cli/h2sa/src目录下执行命令

```
npm i typescript
```
3. 安装stdio：在napi_generator/src/cli/h2sa目录下执行命令

```
npm i stdio
```
4. 在napi_generator/src/cli/h2sa/src/gen目录下执行命令生成service框架代码：

```
node main.js -f test.h
```

其中,参数详情如下：

-f，定义远程服务的.h文件；

-l，可选参数，日志级别（0-3），默认为1；

-o，可选参数，生成框架代码输入到指定路径下；

-s，可选参数，指定serviceID，默认为19000；

-v，可选参数，指定版本（3.2和4.1，默认版本为3.2）

#### 生成物

1. 输出testservice文件夹，其中的文件如下所示：

![](../figures/h2sa_outRes.png)

```
├── BUILD.gn                                           # 整个服务的编译文件，包含2个内容:1)服务端程序动态库编译  2)客户端可执行程序编译
├── bundle.json                                        # 将服务包装成一个OpenHarmoney子系统组件，提供相关信息
├── etc                                                 # 服务启动配置目录，如果服务不需要开机自动启动，可以删除此目录。
│ ├── BUILD.gn
│ └── test_service.cfg                               # 服务自启动配置文件，编译烧录后会在/ect/init/下生成xxx_service.cfg启动文件
├── include
│ ├── test_service.h                                  # 服务端头文件
│ ├── test_service_proxy.h                            # proxy 客户端头文件，为开发人员封装remote请求发送的处理
│ └── test_service_stub.h                            # stub 服务端头文件，为开发人员封装remote请求接收的处理
├── interface
│ └── i_test_service.h                               # 由用户提供的.h文件生成的remote接口文件，stub和proxy都基于此文件实现接口。
├── sa_profile
│ ├── 19000.json                                     # 服务配置文件
│ └── BUILD.gn
└── src
   ├── i_test_service.cpp                            # 接口实现文件
   ├── test_client.cpp                               # 客户端程序
   ├── test_service.cpp                               # 服务端程序
   ├── test_service_proxy.cpp                         # 客户端代理实现
   └── test_service_stub.cpp                         # 服务端 stub 实现
```

#### 应用和验证

1. 将生成的testservice文件夹放在对应版本的源码根目录下
2. 修改服务配置文件

在foundation/systemabilitymgr/samgr/interfaces/innerkits/samgr_proxy/include/system_ability_definition.h增加以下一行：

```
TEST_SERVICE_ID                = {serviceID}, //保证ID与参数-s的值一致且没有重复，例如：默认值19000
```

3. 修改子系统配置文件

```
在build/subsystem_config.json中增加以下内容。"testservice": {
"path":"testservice",
"name": "testservice"
}

```

4. 修改产品配置，如rk3568

在vendor/hihope/rk3568/config.json中增加以下内容：

```
{
"subsystem": "testservice",
"components": [
{
"component": "testservice_part",
"features": []
}
]
}
```

5. 修改权限配置

在相应的产品目录的vendor/hihope/rk3568/security_config/high_privilege_process_list.json中增加以下内容：

```
{
"name": "testservice",
"uid": "system",
"gid": ["root", "system"]
}
```

6. selinux权限配置

vendor/hihope/rk3568/config.json中"build_selinux"属性若为true，即要配置selinux权限，应修改以下文件；若为false，无需修改

> 1. testservice/etc/sample_service.cfg
>
> ```
> "secon" : "u:r:testservice:s0"
> ```
> 2. base/security/selinux_adapter/sepolicy/base/public/service_contexts
>
> ```
> 9016                u:object_r:sa_testservice:s0
> ```
> 3. base/security/selinux_adapter/sepolicy/base/public/service.te
>
> ```
> type sa_testservice, sa_service_attr;
> ```
> 4. base/security/selinux_adapter/sepolicy/ohos_policy/startup/init/system/init.te
>
> ```
> allow init testservice:process { getattr rlimitinh siginh transition };
> ```
> 5. base/security/selinux/sepolicy/base/public/type.te
>
> ```
> type testservice, sadomain, domain;
> ```
> 6. /base/security/selinux/sepolicy/base/te目录下增加新service的te文件，新增文件名即为服务名，例如：testservice.te
>
> ```
> allow testservice init_param:file { map open read };
> allow testservice sa_testservice:samgr_class { add get };
> ```

7. 编码完成后，执行镜像编译命令

```
./build.sh --product-name 产品名

若编译rk3568开发板，则执行
./build.sh --product-name rk3568
```

8. 烧录镜像
9. 运行验证

> 验证一： shell登录开发板。查看服务端进程是否已正常启动
>
> ```
> ps -ef | grep testservice
> system       288    1 0 00:02:13 ?    00:00:00 testservice_sa  --- 服务进程已正常运行
> ```
>
> 验证二：运行客户端
>
> ```
> /system/bin/testclient
> ```
>
[/md]

欢迎光临 OpenHarmony开发者论坛 (https://forums.openharmony.cn/)