• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# NAPI框架生成工具IntelliJ插件开发说明
2
3若当前工具功能不满足开发者需求,开发者需增强工具能力,则可基于已有源码进行工具二次开发,编译打包生成自定义的DevEco Studio上使用的IntelliJ插件。
4
5## DevEco Studio上使用的IntelliJ插件打包说明
6
7### 环境说明
8
9系统:建议Windows 10
10
11### 开发步骤
12
13#### 环境准备
14
151.下载napi工具可执行程序,并放置在napi_generator/src/intellij_plugin/dts2cpp/napi_IntelliJ_plugin/resources/cmds目录下对应系统的文件夹下,可执行文件下载路径如下(由于网络原因,可能会导致有的下载链接失效,因此提供了以下三个下载链接):
16
17[可执行文件下载链接1](http://ftpkaihongdigi.i234.me:5000/sharing/yaRiKSjBI)
18
19[可执行文件下载链接2](http://ftp.kaihong.com:5000/fsdownload/yaRiKSjBI/)
20
21[可执行文件下载链接3](http://ftp.kaihongdigi.com:5000/fsdownload/yaRiKSjBI/)
22
23访问密码:kaihong
24
25压缩包解压密码:kaihong20231121
26
272.下载并安装IDEA Community、JDK11配置好环境。IDEA Community版本可以左键单击以下链接下载。
28
29[下载链接](https://www.jetbrains.com/idea/download/)
30
313.打开IDEA Community应用程序
32依次点击项目File>Open 选择napi_generator/src/intellij_plugin/dts2cpp/napi_IntelliJ_plugin项目文件夹。
33![](../figures/IntelliJ_env_config_open_proj.png)
34
354.配置Project
36项目打开完成,点击File>Project Structure,在出现的界面中点击Project,下图的SDK选择JDK 11,选择或者新建complier output目录为项目文件下的out目录。
37![](../figures/IntelliJ_env_proj_structure.png)
38
395.配置Modules
40Project Settings > Modules 新建Modules。点击上方“-”删除原有的Modules,然后点击“+”选择 New Module。
41![](../figures/IntelliJ_env_Proj_Module.png)
42
436.配置Module SDK
44在New Module对话框中,选择IntelliJ Platform Plugin。若Module SDK中无可选SDK,请在Module SDK 下拉框中点击 Add IntelliJ Platform Plugin SDK 选择IDEA Community安装目录,点击OK,在Select Internal Java Platform 选择 JAVA SDK 11(213版本只支持 11),点击New Module对话框中Next。
45![](../figures/IntelliJ_env_Proj_Module_New.png)
46
477.配置Content root
48Content root选择~/napi_generator/src/intellij_plugin/dts2cpp/napi_IntelliJ_plugin文件夹,module name填写napi_generator。点击Finish,若出现提示已存在是否覆盖的提示,请点“Yes”完成配置。
49
50![](../figures/IntelliJ_env_module_root.png)
51
528.Modules配置完成后,若在SDKs中无相应JDK和Plugin SDK,请点击+号分别添加 Add Java JDK和Add Intellij PlantForm Plugin SDK,Java JDK为java11的安装目录,Plugin SDK为 IDEA Community 2021.3.3的安装目录。
53![](../figures/IntelliJ_env_config_SDKs.png)
54
559.配置Libraries
56
57由于IntellIj插件市场兼容性问题,原使用的json库与新版本的IDE不兼容,因此使用新的json库解决兼容性问题,新的json库需要从Maven仓库下载并将依赖配置到工程中(napi 1.0.3版本以及之后版本才需要配置依赖,之前的版本跳过此步骤 )。
58
59步骤:点击"+",选择"From Maven...";在搜索框搜索依赖的jar包:com.alibaba.fastjson2:fastjson2:2.0.42,勾选"Download to"并点击OK,将依赖下载至工程目录下的lib文件夹;点击"Choose Modules"中的OK。
60
61![](../figures/IntelliJ_env_config_libs.png)
62
63![](../figures/IntelliJ_env_config_libs_download.png)
64
65![](../figures/IntelliJ_env_config_libs_choose_module.png)
66
67![](../figures/IntelliJ_env_config_libs_check.png)
68
6910.若完成以上步骤配置,点击OK完成配置。Rebuild项目,若IDEA不能点击右上角的运行,点击Plugin后下三角选择Edit Configurations...选项,Run/Debug Configurations框中Use classpath of moudle选择napi_generator,点击ok,等待安装完成。
70
71![](../figures/IntelliJ_env_configurations.png)
72
73![](../figures/IntelliJ_env_run_debug.png)
74
7510.点击Intellij IDEA工具右上角Built Project按钮,等待工程built完成。
76
77![](../figures/IntelliJ_env_built_pro.png)
78
7911.在IDEA Community中依次点击Build>Prepare All Plugin Modules for development",然后在Select Modules框中点击ok,jar/zip包生成完成后在工具右下角提示jar/zip包生成成功,且包含jar/zip包存放位置。
80
81![](../figures/IntelliJ_env_built_jar.png)
82
83![](../figures/IntelliJ_env_select_moudles.png)
84
851.0.3之前版本,版本格式.jar,由于1.0.3及之后新增了lib依赖(com.alibaba.fastjson2:fastjson2:2.0.42),版本格式为.zip。
86
87![](../figures/IntelliJ_env_built_jar_success.png)
88
89![](../figures/IntelliJ_env_built_zip_success.png)
90
91
92
93## 工具测试
94
95进行工具二次开发后,本地可进行单元测试、story特性测试确保工具的可用性。左键单击以下链接了解详情:
96
97[单元测试](https://gitee.com/openharmony/napi_generator/blob/master/test/unittest/README_ZH.md)
98
99[story测试](https://gitee.com/openharmony/napi_generator/blob/master/test/storytest/README_ZH.md)
100
101