openharmony/napi_generator
1
0
Fork 0
mirror of https://gitee.com/openharmony/napi_generator synced 2024-11-27 10:40:37 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Modify ENSEMBLE and INTEGRATION_TESTING

Browse Source 
Signed-off-by: shenjie <shenjie@kaihong.com>
This commit is contained in:
shenjie 2022-08-11 16:05:36 +08:00
parent 222d81c177
commit e3cceacbfe
2 changed files with 284 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

271
docs/ENSEMBLE_METHOD_ZH.md
View File

@ -3,11 +3,12 @@
## 场景说明
为了实现工具生成的接口被其他子系统或者应用调用，需将生成的代码编译集成到OpenHarmony系统中，使其生成动态库，供OpenHarmony应用层调用。
本文介绍如何将工具生成的源码利用OpenHarmony编译系统生成动态库供应用层调用。
本文介绍如何将工具生成的源码利用OpenHarmony编译系统生成动态库供应用层调用，主要是有以下两种方式，分别为增加ohos.build文件方式和增加bundle.json文件方式。
## 建立模块位置
## ohos.build方式集成
### 建立模块位置
模块目录理论上可以建立在OpenHarmony代码库的任何地方，为行方便，假设OpenHarmony代码库的目录为`OHOS_SRC`，在`OHOS_SRC`目录下，例如建立此次测试模块目录：napitest。此时，`OHOS_SRC`目录下应该有 ark, foundation, device, …, napitest等目录，其中napitest就是刚刚建立的，在napitest目录下，把之前用可执行文件或者插件转换出来的文件全部拷贝到该目录下，并且在该目录下新建一个文件ohos.build。例如napitest目录下有以下文件：
模块目录理论上可以建立在OpenHarmony代码库的任何地方，假设OpenHarmony代码库的目录为`OHOS_SRC`，在`OHOS_SRC/foundation`目录下，例如建立此次测试模块目录：napitest。此时，`OHOS_SRC/foundation`目录下应该有aafwk,ace,ai, …, napitest等目录，其中napitest就是刚刚建立的，在napitest目录下，把之前用可执行文件或者插件转换出来的文件全部拷贝到该目录下，并且在该目录下新建一个文件ohos.build。例如napitest目录下有以下文件：
foundation/napitest
|-- binding.gyp
@ -20,50 +21,47 @@
|-- x_napi_tool.cpp
|-- x_napi_tool.h
## 编译修改点
### 编译修改点
### 修改build.gn文件
#### 修改build.gn文件
```
import("//build/ohos.gni")
import("//build/ohos.gni")
ohos_shared_library("napitest")
{
# 指定编译源文件
sources = [
"napitest_middle.cpp",
"napitest.cpp",
"x_napi_tool.cpp",
]
include_dirs = [
".",
"//third_party/node/src",
]
# 指定编译依赖，如果依赖第三方库，需要在此添加
deps=[
"//foundation/ace/napi:ace_napi",
"//base/hiviewdfx/hilog/interfaces/native/innerkits:libhilog",
]
public_deps = [
"//base/hiviewdfx/hilog/interfaces/native/innerkits:libhilog",
]
remove_configs = [ "//build/config/compiler:no_rtti" ]
cflags=[
]
cflags_cc=[
"-frtti",
]
ldflags = [
]
# 指定库生成的路径
relative_install_dir = "module"
# 主要是修改下面两条内容，子系统及其组件，后面会引用
part_name = "napitest_interface"
subsystem_name = "napitest"
}
ohos_shared_library("napitest")
{
# 指定编译源文件
sources = [
"napitest_middle.cpp",
"napitest.cpp",
"x_napi_tool.cpp",
]
include_dirs = [
".",
"//third_party/node/src",
]
# 指定编译依赖，如果依赖第三方库，需要在此添加
deps=[
"//foundation/ace/napi:ace_napi",
"//base/hiviewdfx/hilog/interfaces/native/innerkits:libhilog",
]
remove_configs = [ "//build/config/compiler:no_rtti" ]
cflags=[
]
cflags_cc=[
"-frtti",
]
ldflags = [
]
# 指定库生成的路径
relative_install_dir = "module"
# 主要是修改下面两条内容，子系统及其组件，后面会引用
part_name = "napitest_interface"
subsystem_name = "napitest"
}
```
### 修改ohos.build文件
#### 修改ohos.build文件
其中module_list选项中的"//foundation/napitest"指的是napitest目录，":napitest"指的是上面BUILD.gn中的目标ohos_shared_library("napitest")。
```
@ -80,7 +78,29 @@ ohos_shared_library("napitest")
}
```
### 增加子系统
#### 修改napitest.cpp文件
为方便调试，在napitest.cpp文件或napitest_middle.cpp文件中加入打印日志语句。以修改napitest.cpp文件为例，增加以下代码：
```
#include "napitest.h"
#include <hilog/log.h>
using namespace OHOS;
namespace {
constexpr HiviewDFX::HiLogLabel LABEL = { LOG_CORE, 0, "NAPITESTNAPILayer" };
#define NAPITEST_LOG(fmt, ...) HiviewDFX::HiLog::Info(LABEL, \
"%{public}s:%{public}d " fmt, __func__, __LINE__, ##__VA_ARGS__)
}
namespace napitest {
bool fun1(std::string &v, std::string &out)
{
NAPITEST_LOG("napitest fun1 begin!!!!!!!!!!!!!!");
return true;
}
}
```
#### 增加子系统
在源码/build/subsystem_config.json中增加子系统选项。如下所示：
@ -94,15 +114,178 @@ ohos_shared_library("napitest")
```
### 添加功能模块
在产品配置中添加上述子系统的功能模块，编译到产品产出文件中，例如在源码/productdefine/common/products/rk3566.json中增加part选项，其中napitest就是上面填的part_name，napitest_interface就是上面填的subsystem_name。
在产品配置中添加上述子系统的功能模块，编译到产品产出文件中，例如在源码/productdefine/common/products/rk3566.json中增加part选项，其中napitest就是上面填的subsystem_name，napitest_interface就是上面填的part_name。
"napitest:napitest_interface":{}
## 编译验证
### 编译验证
编译成功后，就会生成libnapitest.z.so，目录如下所示：
/out/ohos-arm-release/packages/phone/system/lib/module
## bundle.json方式集成
### 建立模块位置
模块目录理论上可以建立在OpenHarmony代码库的任何地方，假设OpenHarmony代码库的目录为`OHOS_SRC`，在`OHOS_SRC/foundation`目录下，例如建立此次测试模块目录：napitest。此时，`OHOS_SRC/foundation`目录下应该有aafwk,ace,ai, …, napitest等目录，其中napitest就是刚刚建立的，在napitest目录下，把之前用可执行文件或者插件转换出来的文件全部拷贝到该目录下，并且在该目录下新建一个文件bundle.json。例如napitest目录下有以下文件：
foundation/napitest
|-- binding.gyp
|-- BUILD.gn
|-- bundle.json
|-- napitest.cpp
|-- napitest.h
|-- napitest_middle.cpp
|-- test.sh
|-- x_napi_tool.cpp
|-- x_napi_tool.h
### 编译修改点
#### 修改build.gn文件
```
import("//build/ohos.gni")
ohos_shared_library("napitest")
{
# 指定编译源文件
sources = [
"napitest_middle.cpp",
"napitest.cpp",
"x_napi_tool.cpp",
]
include_dirs = [
".",
"//third_party/node/src",
]
# 指定编译依赖，如果依赖第三方库，需要在此添加
deps=[
"//foundation/ace/napi:ace_napi",
"//base/hiviewdfx/hilog/interfaces/native/innerkits:libhilog",
]
remove_configs = [ "//build/config/compiler:no_rtti" ]
cflags=[
]
cflags_cc=[
"-frtti",
]
ldflags = [
]
# 指定库生成的路径
relative_install_dir = "module"
# 主要是修改下面两条内容，子系统及其组件，后面会引用
part_name = "napitest_interface"
subsystem_name = "napitest"
}
```
#### 修改bundle.json文件
其中destPath选项中的"//foundation/napitest"指的是napitest目录，":napitest"指的是上面BUILD.gn中的目标ohos_shared_library("napitest")。
```
{
"name": "@ohos/napitest",
"description": "napitest provides atomic capabilities",
"version": "3.1",
"license": "Apache License 2.0",
"publishAs": "code-segment",
"segment": {
"destPath": "foundation/napitest"
},
"dirs": {},
"scripts": {},
"component": {
"name": "napitest_interface",
"subsystem": "napitest",
"features": [],
"adapted_system_type": [
"standard"
],
"rom": "10000KB",
"ram": "10000KB",
"deps": {
"components": [
"ace_napi",
"ipc_core",
"libhilog"
],
"third_party": [
"node"
]
},
"build": {
"sub_component": [
"//foundation/napitest:napitest"
],
"inner_kits": [
{
"header": {
"header_base": "//foundation/napitest",
"header_files": [
"x_napi_tool.h",
"napitest.h"
]
},
"name": "//foundation/napitest:napitest"
}
]
}
}
}
```
#### 修改napitest.cpp文件
为方便调试，在napitest.cpp文件或napitest_middle.cpp文件中加入打印日志语句。以修改napitest.cpp文件为例，增加以下代码：
```
#include "napitest.h"
#include <hilog/log.h>
using namespace OHOS;
namespace {
constexpr HiviewDFX::HiLogLabel LABEL = { LOG_CORE, 0, "NAPITESTNAPILayer" };
#define NAPITEST_LOG(fmt, ...) HiviewDFX::HiLog::Info(LABEL, \
"%{public}s:%{public}d " fmt, __func__, __LINE__, ##__VA_ARGS__)
}
namespace napitest {
bool fun1(std::string &v, std::string &out)
{
NAPITEST_LOG("napitest fun1 begin!!!!!!!!!!!!!!");
return true;
}
}
```
#### 增加子系统
在源码/build/subsystem_config.json中增加子系统选项。如下所示：
```
"napitest": {
"project": "hmf/napitest",
"path": "foundation/napitest",
"name": "napitest",
"dir": "foundation"
}
```
### 添加功能模块
在产品配置中添加上述子系统的功能模块，编译到产品产出文件中，例如在源码/productdefine/common/products/rk3566.json中增加part选项，其中napitest就是上面填的subsystem_name，napitest_interface就是上面填的part_name。
"napitest:napitest_interface":{}
### 编译验证
编译成功后，就会生成libnapitest.z.so，目录如下所示：
/out/ohos-arm-release/packages/phone/system/lib/module
## 总结
两种集成方式使用场景说明：
ohos.build方式集成：适合3.0前版本使用。
bundle.json方式集成：兼容ohos.build方式，但3.1及以后版本建议使用此种方式集成。

65
docs/INTEGRATION_TESTING_ZH.md
View File

@ -1,7 +1,7 @@
# NAPI框架生成工具集成测试
## 简介
本文主要介绍如何将NAPI框架生成代码集成NAPI到OpenHarmony系统，进而进行集成测试。
本文主要介绍如何将NAPI框架生成代码集成到OpenHarmony系统，进而进行集成测试。
## 准备
@ -11,14 +11,61 @@
系统镜像的具体生成方法，可以左键单击以下链接了解：
[生成代码集成到OpenHarmony的方法](https://gitee.com/openharmony/napi_generator/blob/master/docs/ENSEMBLE_METHOD_ZH.md)
[生成代码集成到OpenHarmony](https://gitee.com/openharmony/napi_generator/blob/master/docs/ENSEMBLE_METHOD_ZH.md)
3.应用hap包：hap包及源码路径如下：
```
```
napi_generator/examples/app
```
hap包的具体生成方法，可参考OpenHarmony/docs/zh-cn/application-dev文档中使用JS语言开发（FA模型）。其中修改index.js文件内容如下：
```
import router from '@ohos.router';
import napitest from '@ohos.napitest';
export default {
data: {
title: ""
},
onInit(){
this.title = this.$t('strings.world');
},
onclick: function () {
router.push({
url: "pages/second/second"
})
},
ontest: function () {
console.log("napitest begin AAAAAAAAAAAAAAAAAA")
var Entity = {
ENTITY_DEFAULT : "entity.system.default",
ENTITY_HOME : "entity.system.home",
ENTITY_VOICE : "entity.system.voice",
ENTITY_BROWSABLE : "entity.system.browsable",
ENTITY_VIDEO : "entity.system.video"
}
napitest.Space3.fun1("ggggg",Entity.ENTITY_DEFAULT);
console.log("napitest end AAAAAAAAAAAAAAAAAA")
}
}
```
修改index.html文件内容如下：
```
<!--index.hml-->
<div class="container">
<text class="title">
Hello World
</text>
<!-- 添加按钮，值为Next，并绑定onclick方法-->
<input class="btn" type="button" value="Next" onclick="onclick"></input>
<input class="btn" type="button" value="napitest" onclick="ontest"></input>
</div>
```
## 使用说明
步骤一：安装镜像环境。
@ -44,12 +91,14 @@ napi_generator/examples/app
然后单击设备中安装的APP，进入APP后单击测试按钮，执行完成后会在hdc安装目录下出现log.txt文件。
## 查看结果
log.txt中包含“===isScreenOn===”日志表示接口调用成功。如下所示：
log.txt中包含“======fun1(name: string, flags: Entity): number======”日志表示接口调用成功。如下所示：
03-01 19:48:19.594 916 940 I 00000/power_interface: ===isScreenOn===
03-01 19:48:19.594 916 925 I 00000/ProducerEglSurface: <342>AddEglData: bufferImpl is reused return.
03-01 19:48:19.594 916 925 I 00000/ProducerEglSurface: (Window)<217>WaitForReleaseFence: releaseFence 39.
03-01 19:48:19.594 916 923 I 03b00/JSApp: app Log: power_is_screen_on_promise_test screenOn is 0
01-01 00:13:10.355 2020 2027 I 00000/NAPITESTNAPILayer: fun1_middle:93 *******fun1_middle begin**********
01-01 00:13:10.357 2020 2038 D 01400/OHOS::ROSEN: RSRenderThread ProcessCommands size: 2
01-01 00:13:10.358 2020 2038 D 01400/OHOS::ROSEN: RSRenderThread DrawFrame(790351535051) in GPU
01-01 00:13:10.360 2020 2027 I 00000/NAPITESTNAPILayer: fun1_middle:107 *****fun1_middle xxxxx**********
01-01 00:13:10.360 2020 2027 I 00000/NAPITESTNAPILayer: fun1:28 ======fun1(name: string, flags: Entity): number======
01-01 00:13:10.360 2020 2027 I 00000/NAPITESTNAPILayer: fun1_middle:113 *******fun1_middle end*********
## 相关仓