style: modify napi docs about exe download links

Signed-off-by: gou-jingjing <goujingjing@kaihong.com>
This commit is contained in:
gou-jingjing 2023-11-29 11:40:25 +08:00
parent 425e6b56e9
commit bd0fcc259b
12 changed files with 117 additions and 92 deletions

View File

@ -1,7 +1,7 @@
# NAPI框架生成工具
## 简介
本文主要介绍NAPI框架代码生成工具它可以根据用户指定路径下的ts(typescript)接口文件一键生成NAPI框架代码、业务代码框架、GN文件等。在开发JS应用与NAPI间接口时底层框架开发者无需关注Nodejs语法、C++与JS之间的数据类型转换等上层应用转换逻辑只关注底层业务逻辑即可专业的人做专业的事从而可以大大提高开发效率。目前工具支持可执行文件、VS Code插件、IntelliJ插件三种入口。
本文主要介绍NAPI框架代码生成工具它可以根据用户指定路径下的ts(typescript)接口文件一键生成NAPI框架代码、业务代码框架、GN文件等。在开发JS应用与NAPI间接口时底层框架开发者无需关注Nodejs语法、C++与JS之间的数据类型转换等上层应用转换逻辑只关注底层业务逻辑即可专业的人做专业的事从而可以大大提高开发效率。目前工具支持可执行文件、VS Code插件、DevEco Studio上使用的IntelliJ插件三种入口。
更多工具的架构和实现原理详情,可以左键单击以下链接了解:
@ -46,17 +46,21 @@
### 工具使用
工具有三种类型分别是可执行文件、VS Code插件、IntelliJ插件。其中的可执行文件可根据工具使用者的开发环境选择支持WindowsLinux和Mac。可执行文件、VS Code插件下载路径如下。
工具有三种类型分别是可执行文件、VS Code插件、DevEco Studio上使用的IntelliJ插件。其中的可执行文件可根据工具使用者的开发环境选择支持WindowsLinux和Mac。可执行文件下载路径如下(由于网络原因,可能会导致有的下载链接失效,因此提供了以下三个下载链接):
[下载链接1]( http://ftpkaihongdigi.i234.me:5000/sharing/PC6uOorrM)
[可执行文件下载链接1](http://ftpkaihongdigi.i234.me:5000/sharing/TRNwP6whE)
[下载链接2]( http://ftp.kaihong.com:5000/sharing/PC6uOorrM)
[可执行文件下载链接2](http://ftp.kaihong.com:5000/fsdownload/TRNwP6whE/)
[下载链接3]( http://ftp.kaihongdigi.com:5000/sharing/PC6uOorrM)
[可执行文件下载链接3](http://ftp.kaihongdigi.com:5000/fsdownload/TRNwP6whE/)
IntelliJ插件下载路径如下:
访问密码kaihong
[IntelliJ插件下载链接](https://plugins.jetbrains.com/plugin/19593-napi-generator/versions)
压缩包解压密码kaihong20231121
DevEco Studio上使用的IntelliJ插件下载路径如下:
[DevEco Studio上使用的IntelliJ插件下载链接](https://plugins.jetbrains.com/plugin/19593-napi-generator/versions)
具体的工具使用步骤,可以左键单击以下链接了解:
@ -76,19 +80,27 @@ napi_generator/examples/ts
![](./figures/pic-d-ts-transition.png)
其中生成的"napitest.h"文件,定义了框架代码的接口,如下所示:
其中生成的"napitest.h"文件,定义了框架代码的接口,生成的部分接口如下所示:
```
...
class NodeISayHello {
public:
bool addSayHelloListener(NodeISayHelloListener& listener);
static NodeISayHelloListener listener_;
bool removeSayHelloListener(NodeISayHelloListener& listener);
bool registerCallbackfunc();
// 供业务调用的回调接口
void CallbackfuncCallback(NUMBER_TYPE_2& wid);
```c++
#include "napitest.h"
namespace napitest {
bool func1(std::string& v1, std::string& out)
{
// TODO
return true;
}
}
bool unRegisterCallbackfunc();
bool sayHello(std::string& from, std::string& to, NUMBER_TYPE_9& sayType);
bool sayHi(std::string& from, std::string& to, NUMBER_TYPE_10& sayType);
bool sayHelloWithResponse(std::string& from, std::string& to, NUMBER_TYPE_11& sayType, uint32_t& outErrCode, AUTO_INTERFACE_5& out);
static AUTO_INTERFACE_5 auto_interface_5OutRes;
void auto_interface_5SetCbValue(NUMBER_TYPE_6 result, std::string errMsg, std::string response);
};
...
```
### 代码集成
@ -119,7 +131,7 @@ bool func1(std::string& v1, std::string& out)
当前版本已支持的特性和待开发的特性,如下所示:
[已支持特性](https://gitee.com/openharmony/napi_generator/blob/master/release-notes/napi_generator-1.0.md)
[已支持特性](https://gitee.com/openharmony/napi_generator/blob/master/release-notes)
[待支持特性](https://gitee.com/openharmony/napi_generator/blob/master/docs/ROADMAP_ZH.md)
@ -134,4 +146,4 @@ bool func1(std::string& v1, std::string& out)
## 相关仓
[ts生成工具README_zh](https://gitee.com/openharmony/napi_generator/blob/master/docs/ts/README_ZH.md)
[ts生成工具README_zh](https://gitee.com/openharmony/napi_generator/blob/master/docs/ts/README_ZH.md)

View File

@ -9,10 +9,10 @@
#### Linux
1.将待转换的.d.ts文件、napi_generator-linux放在同级目录下。此处新建generatorCode文件夹用于存放生成框架代码。整体目录文件如下
1.将待转换的.d.ts文件、依赖文件basic.d.ts、napi_generator-linux放在同级目录下。此处新建generatorCode文件夹用于存放生成框架代码。整体目录文件如下
OpenHarmony@Ubuntu-64:~/service$ ls
napi_generator-linux @ohos.napitest.d.ts generatorCode
napi_generator-linux @ohos.napitest.d.ts basic.d.ts generatorCode
2.在终端中进入到之前可执行程序napi_generator-linux所在的目录并运行napi_generator-linux命令如下
@ -28,21 +28,26 @@
-o, 可选参数,默认为当前目录,指定生成框架代码输出路径;
-n, 可选参数默认为uint32_t指定生成框架代码中number类型全部为指定类型
-n, 可选参数默认为uint32_t指定生成框架代码中number类型全部为指定类型
备注:-f与-d两个参数只选其中一个参数即可。若.d.ts文件中声明了basic.d.ts文件将basic.d.ts文件放置在待转换.d.ts文件同一级目录若除此之外还声明其它.d.ts文件将此类文件放置在待转换.d.ts文件同级目录。
-s, 可选参数,默认为不配置业务代码,指定生成框架代码的业务配置文件,用于粘合工具代码和业务代码的配置。
备注1-f与-d两个参数只选其中一个参数即可。
备注2若.d.ts文件中声明了basic.d.ts文件将basic.d.ts文件放置在待转换.d.ts文件同一级目录若除此之外还声明其它.d.ts文件将此类文件放置在待转换.d.ts文件同级目录。
3.运行成功后会在generatorCode目录下生成框架代码文件如下所示
OpenHarmony@Ubuntu-64:~/linshi/napi_generator_8/examples/ts/generatorCode$ ls
binding.gyp BUILD.gn napi_gen.log napitest.cpp napitest.h napitest_middle.cpp test.sh tool_utility.cpp tool_utility.h
binding.gyp BUILD.gn napi_gen.log napitest.cpp napitest.h napitest_middle.h napitest_middle.cpp test.sh tool_utility.cpp tool_utility.h
#### Windows
1.将待转换的.d.ts文件、napi_generator-win.exe放在同级目录下。此处新建generatorCode文件夹用于存放生成框架代码。整体目录文件如下
1.将待转换的.d.ts文件、依赖文件basic.d.ts、napi_generator-win.exe放在同级目录下。此处新建generatorCode文件夹用于存放生成框架代码。整体目录文件如下
E:\demo\napi>dir /B
@ohos.napitest.d.ts
basic.d.ts
napi_generator-win.exe
generatorCode
@ -60,9 +65,13 @@
-o, 可选参数,默认为当前目录,指定生成框架代码输出路径;
-n, 可选参数默认为uint32_t指定生成框架代码中number类型全部为指定类型
-n, 可选参数默认为uint32_t指定生成框架代码中number类型全部为指定类型
备注:-f与-d两个参数只选其中一个参数即可。若.d.ts文件中声明了basic.d.ts文件将basic.d.ts文件放置在待转换.d.ts文件同一级目录若除此之外还声明其它.d.ts文件将此类文件放置在待转换.d.ts文件同级目录。
-s, 可选参数,默认为不配置业务代码,指定生成框架代码的业务配置文件,用于粘合工具代码和业务代码的配置。
备注1-f与-d两个参数只选其中一个参数即可。
备注2若.d.ts文件中声明了basic.d.ts文件将basic.d.ts文件放置在待转换.d.ts文件同一级目录若除此之外还声明其它.d.ts文件将此类文件放置在待转换.d.ts文件同级目录。
3.运行成功后会在generatorCode目录下生成框架代码文件如下所示
@ -71,6 +80,7 @@
BUILD.gn
napitest.cpp
napitest.h
napitest_middle.h
napitest_middle.cpp
napi_gen.log
test.sh
@ -87,11 +97,11 @@
[VS插件使用说明](https://gitee.com/openharmony/napi_generator/blob/master/napi_vs_plugin/docs/napi/INSTRUCTION_ZH.md)
### IntelliJ插件使用方法
### DevEco Studio上使用的IntelliJ插件使用方法
具体的插件使用步骤,可以左键单击以下链接了解:
[IntelliJ插件使用说明](https://gitee.com/openharmony/napi_generator/blob/master/napi_IntelliJ_plugin/docs/napi/INSTRUCTION_ZH.md)
[DevEco Studio上使用的IntelliJ插件使用说明](https://gitee.com/openharmony/napi_generator/blob/master/napi_IntelliJ_plugin/docs/napi/INSTRUCTION_ZH.md)
## 集成测试
NAPI框架代码生成后系统框架开发者进行二次开发后即可集成到OpenHarmony编译系统生成对应的库文件供应用开发者调用接口。工具集成测试的具体操作步骤可以左键单击以下链接了解

View File

@ -105,11 +105,11 @@
[VS插件开发说明](https://gitee.com/openharmony/napi_generator/blob/master/napi_vs_plugin/docs/napi/DEVELOP_ZH.md)
### IntelliJ插件开发说明
### DevEco Studio上使用的IntelliJ插件开发说明
具体的插件开发步骤,可以左键单击以下链接了解:
[IntelliJ插件开发说明](https://gitee.com/openharmony/napi_generator/blob/master/napi_IntelliJ_plugin/docs/napi/DEVELOP_ZH.md)
[DevEco Studio上使用的IntelliJ插件开发说明](https://gitee.com/openharmony/napi_generator/blob/master/napi_IntelliJ_plugin/docs/napi/DEVELOP_ZH.md)
## 工具测试
进行工具二次开发后本地可进行单元测试、story特性测试确保工具的可用性。左键单击以下链接了解详情

View File

@ -1,35 +1,23 @@
# NAPI框架生成工具使用说明
## 简介
NAPI框架生成工具支持三种入口分别是可执行程序、VS Code插件、IntelliJ插件使用者可以根据自己的需要选择合适的工具。
NAPI框架生成工具支持三种入口分别是可执行程序、VS Code插件、DevEco Studio上使用的IntelliJ插件使用者可以根据自己的需要选择合适的工具。
1.可执行文件下载链接如下:
1.可执行文件下载路径如下(由于网络原因,可能会导致有的下载链接失效,因此提供了以下三个下载链接):
[可执行文件下载链接](http://ftpkaihongdigi.i234.me:5000/sharing/TRNwP6whE)
[可执行文件下载链接1](http://ftpkaihongdigi.i234.me:5000/sharing/TRNwP6whE)
[可执行文件下载链接2](http://ftp.kaihong.com:5000/fsdownload/TRNwP6whE/)
[可执行文件下载链接3](http://ftp.kaihongdigi.com:5000/fsdownload/TRNwP6whE/)
访问密码kaihong
压缩包解压密码kaihong20231121
压缩包解压密码kaihong20231121
2.VS Code插件下载路径如下:
DevEco Studio上使用的IntelliJ插件下载路径如下:
[下载链接1]( http://ftpkaihongdigi.i234.me:5000/sharing/PC6uOorrM)
[下载链接2]( http://ftp.kaihong.com:5000/sharing/PC6uOorrM)
[下载链接3]( http://ftp.kaihongdigi.com:5000/sharing/PC6uOorrM)
下载文件说明如下:
│ │ |── generator.jar # IntelliJ插件
│ │ |── gnapi-0.0.1.vsix # VS Code插件
│ │ |── napi_generator-linux # Linux可执行程序
│ │ |── napi_generator-win.exe # Windows可执行程序
│ │ └── napi_generator-macos # Mac可执行程序
IntelliJ插件下载路径如下
[IntelliJ插件下载链接](https://plugins.jetbrains.com/plugin/19593-napi-generator/versions)
[DevEco Studio上使用的IntelliJ插件下载链接](https://plugins.jetbrains.com/plugin/19593-napi-generator/versions)
## 工具介绍
@ -278,11 +266,11 @@ cfg.json是一个数组每一项配置对应一个方法的调用需要对
[VS插件使用说明](https://gitee.com/openharmony/napi_generator/blob/master/napi_vs_plugin/docs/napi/INSTRUCTION_ZH.md)
### IntelliJ插件使用方法
### DevEco Studio上使用的IntelliJ插件使用方法
具体的插件使用步骤,可以左键单击以下链接了解:
[IntelliJ插件使用说明](https://gitee.com/openharmony/napi_generator/blob/master/napi_IntelliJ_plugin/docs/napi/INSTRUCTION_ZH.md)
[DevEco Studio上使用的IntelliJ插件使用说明](https://gitee.com/openharmony/napi_generator/blob/master/napi_IntelliJ_plugin/docs/napi/INSTRUCTION_ZH.md)
## 集成测试
NAPI框架代码生成后系统框架开发者进行二次开发后即可集成到OpenHarmony编译系统生成对应的库文件供应用开发者调用接口。工具集成测试的具体操作步骤可以左键单击以下链接了解

View File

@ -210,13 +210,26 @@ Text('普通方法funcTest返回值 returnVal = ' + this.returnVal).margin({
## 使用说明
步骤一:安装镜像环境。
步骤一:安装镜像环境将out/rk3568/packages/phone目录下的images镜像文件下载并烧录到开发板上
harmony@Ubuntu-64:~/OpenHarmony/out/rk3568-khdvk/packages/phone/images/pack$ ll
总用量 3329884
drwxrwxr-x 2 harmony harmony 4096 9月 27 14:14 ./
drwxrwxr-x 3 harmony harmony 4096 9月 27 15:30 ../
-rw-rw-r-- 1 harmony harmony 3409787466 9月 27 14:14 RK3568-KHDVK-RAMDISK-GPT-20220929-1817.img
OpenHarmony@Ubuntu-64:~/OpenHarmony/out/rk3568/packages/phone/images$ ll
total 767452
drwxrwxrwx 2 root root 4096 Nov 21 05:32 ./
drwxrwxrwx 15 root root 4096 Nov 21 05:32 ../
-rwxrwxrwx 1 root root 67108864 Nov 21 05:04 boot_linux.img*
-rw-r--r-- 1 root root 52428800 Nov 21 05:32 chip_prod.img
-rwxrwxrwx 1 root root 8569 Nov 21 05:04 config.cfg*
-rw-r--r-- 1 root root 12582912 Nov 21 05:32 eng_system.img
-rwxrwxrwx 1 root root 455104 Nov 21 05:04 MiniLoaderAll.bin*
-rwxrwxrwx 1 root root 756 Nov 21 05:04 parameter.txt*
-rw-rw-r-- 1 root root 2507625 Nov 21 05:32 ramdisk.img
-rwxrwxrwx 1 root root 5639680 Nov 21 05:04 resource.img*
-rw-r--r-- 1 root root 52428800 Nov 21 05:32 sys_prod.img
-rw-r--r-- 1 root root 1610608640 Nov 21 05:32 system.img
-rwxrwxrwx 1 root root 4194304 Nov 21 05:04 uboot.img*
-rw-rw-r-- 1 root root 15806303 Nov 21 05:32 updater.img
-rw-r--r-- 1 root root 1468006400 Nov 21 05:32 userdata.img
-rw-r--r-- 1 root root 268431360 Nov 21 05:32 vendor.img
步骤二安装hap包。

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.7 KiB

After

Width:  |  Height:  |  Size: 8.0 KiB

View File

@ -2,7 +2,7 @@
## 简介
NAPI框架代码生成工具它可以根据用户指定路径下的ts(typescript)接口文件一键生成NAPI框架代码、业务代码框架、GN文件等。目前工具支持可执行文件、VS Code插件、IntelliJ插件三种入口本文主要介绍IntelliJ插件使用说明。
NAPI框架代码生成工具它可以根据用户指定路径下的ts(typescript)接口文件一键生成NAPI框架代码、业务代码框架、GN文件等。目前工具支持可执行文件、VS Code插件、DevEco Studio上使用的IntelliJ插件三种入口本文主要介绍IntelliJ插件使用说明。
## 目录
@ -37,7 +37,7 @@ NAPI框架代码生成工具它可以根据用户指定路径下的ts(typescr
插件下载路径如下,选择新版本下载。
[IntelliJ插件下载链接](https://plugins.jetbrains.com/plugin/19593-napi-generator/versions)
[DevEco Studio上使用的IntelliJ插件下载链接](https://plugins.jetbrains.com/plugin/19593-napi-generator/versions)
![](../figures/pic-napi_jar_download.png)
@ -98,7 +98,7 @@ bool func1(std::string& v1, std::string& out)
### 开发步骤
开发者可以根据如下的步骤来完成对工具IntelliJ插件的开发
开发者可以根据如下的步骤来完成对DevEco Studio上使用的工具IntelliJ插件的开发
[工具开发说明](https://gitee.com/openharmony/napi_generator/tree/master/napi_IntelliJ_plugin/docs/napi/DEVELOP_ZH.md)
@ -106,7 +106,7 @@ bool func1(std::string& v1, std::string& out)
当前版本已支持的特性和待开发的特性,如下所示:
[已支持特性](https://gitee.com/openharmony/napi_generator/blob/master/release-notes/napi_generator-1.0.md)
[已支持特性](https://gitee.com/openharmony/napi_generator/blob/master/release-notes)
[待支持特性](https://gitee.com/openharmony/napi_generator/blob/master/docs/ROADMAP_ZH.md)

View File

@ -1,8 +1,8 @@
# NAPI框架生成工具IntelliJ插件开发说明
若当前工具功能不满足开发者需求开发者需增强工具能力则可基于已有源码进行工具二次开发编译打包生成自定义的IntelliJ插件。
若当前工具功能不满足开发者需求,开发者需增强工具能力,则可基于已有源码进行工具二次开发,编译打包生成自定义的DevEco Studio上使用的IntelliJ插件。
## IntelliJ插件打包说明
## DevEco Studio上使用的IntelliJ插件打包说明
### 环境说明
@ -12,13 +12,17 @@
#### 环境准备
1.下载napi工具可执行程序并放置在napi_generator/napi_IntelliJ_plugin/resources/cmds目录下对应系统的文件夹下下载链接如下:
1.下载napi工具可执行程序并放置在napi_generator/napi_IntelliJ_plugin/resources/cmds目录下对应系统的文件夹下可执行文件下载路径如下(由于网络原因,可能会导致有的下载链接失效,因此提供了以下三个下载链接):
[下载链接1]( http://ftpkaihongdigi.i234.me:5000/sharing/PC6uOorrM)
[可执行文件下载链接1](http://ftpkaihongdigi.i234.me:5000/sharing/TRNwP6whE)
[下载链接2]( http://ftp.kaihong.com:5000/sharing/PC6uOorrM)
[可执行文件下载链接2](http://ftp.kaihong.com:5000/fsdownload/TRNwP6whE/)
[下载链接3]( http://ftp.kaihongdigi.com:5000/sharing/PC6uOorrM)
[可执行文件下载链接3](http://ftp.kaihongdigi.com:5000/fsdownload/TRNwP6whE/)
访问密码kaihong
压缩包解压密码kaihong20231121
2.下载并安装IDEA Community、JDK11配置好环境。IDEA Community版本可以左键单击以下链接下载。

View File

@ -2,9 +2,9 @@
## 简介
NAPI框架生成工具目前支持三种入口分别是可执行程序、IntelliJ插件、VS Code插件本文主要介绍IntelliJ插件使用说明。IntelliJ插件下载路径如下选择新版本下载。
NAPI框架生成工具目前支持三种入口分别是可执行程序、DevEco Studio上使用的IntelliJ插件、VS Code插件本文主要介绍DevEco Studio上使用的IntelliJ插件使用说明。DevEco Studio上使用的IntelliJ插件下载路径如下选择新版本下载。
[IntelliJ插件下载链接](https://plugins.jetbrains.com/plugin/19593-napi-generator/versions)
[DevEco Studio上使用的IntelliJ插件下载链接](https://plugins.jetbrains.com/plugin/19593-napi-generator/versions)
![](../../../figures/pic-napi_jar_download.png)
@ -12,7 +12,7 @@ NAPI框架生成工具目前支持三种入口分别是可执行程序、Inte
![](../../../figures/picGoogle-napi_jar_download.png)
## IntelliJ插件使用方法
## DevEco Studio上使用的IntelliJ插件使用方法
### 依赖

View File

@ -32,14 +32,6 @@ NAPI框架代码生成工具它可以根据用户指定路径下的ts(typescr
### 工具使用
插件下载路径如下选择gnapi-0.0.1.vsix下载。
[下载链接1]( http://ftpkaihongdigi.i234.me:5000/sharing/PC6uOorrM)
[下载链接2]( http://ftp.kaihong.com:5000/sharing/PC6uOorrM)
[下载链接3]( http://ftp.kaihongdigi.com:5000/sharing/PC6uOorrM)
具体的工具使用步骤,可以左键单击以下链接了解:
[工具使用说明](https://gitee.com/openharmony/napi_generator/tree/master/napi_vs_plugin/docs/napi/INSTRUCTION_ZH.md)
@ -101,7 +93,7 @@ bool func1(std::string& v1, std::string& out)
当前版本已支持的特性和待开发的特性,如下所示:
[已支持特性](https://gitee.com/openharmony/napi_generator/blob/master/release-notes/napi_generator-1.0.md)
[已支持特性](https://gitee.com/openharmony/napi_generator/blob/master/release-notes)
[待支持特性](https://gitee.com/openharmony/napi_generator/blob/master/docs/ROADMAP_ZH.md)

View File

@ -1,6 +1,18 @@
# NAPI框架生成工具VSCode插件开发说明
若当前工具功能不满足开发者需求开发者需增强工具能力则可基于已有源码进行工具二次开发编译打包生成自定义的VS Code插件。
## 简介
若当前工具功能不满足开发者需求开发者需增强工具能力则可基于已有源码进行工具二次开发编译打包生成自定义的VS Code插件。首先需下载可执行文件可执行文件下载路径如下(由于网络原因,可能会导致有的下载链接失效,因此提供了以下三个下载链接):
[可执行文件下载链接1](http://ftpkaihongdigi.i234.me:5000/sharing/TRNwP6whE)
[可执行文件下载链接2](http://ftp.kaihong.com:5000/fsdownload/TRNwP6whE/)
[可执行文件下载链接3](http://ftp.kaihongdigi.com:5000/fsdownload/TRNwP6whE/)
访问密码kaihong
压缩包解压密码kaihong20231121
## VS Code插件打包说明

View File

@ -1,13 +1,7 @@
# NAPI框架生成工具VSCode插件使用说明
## 简介
NAPI框架生成工具目前支持三种入口分别是可执行程序、IntelliJ插件、VS Code插件本文主要介绍VS Code插件使用说明。VS Code插件下载路径如下选择gnapi-0.0.1.vsix下载。
[下载链接1]( http://ftpkaihongdigi.i234.me:5000/sharing/PC6uOorrM)
[下载链接2]( http://ftp.kaihong.com:5000/sharing/PC6uOorrM)
[下载链接3]( http://ftp.kaihongdigi.com:5000/sharing/PC6uOorrM)
NAPI框架生成工具目前支持三种入口分别是可执行程序、DevEco Studio上使用的IntelliJ插件、VS Code插件本文主要介绍VS Code插件使用说明。
## VS Code插件使用方法