基于idea的YonBuilder Premium开发者工具(原NCC开发插件)使用说明

1 插件安装

1.1、添加自定义插件存储库：打开设置窗口，添加自定义插件存储库路径：https://nccdev.yonyou.com/ide/idea/latest/updatePlugin.xml

1.2、安装插件：在 Marketplace 中搜索 YonBuilder Premium开发者工具 点击安装。

2 Home配置–此功能是安装插件后必须首先使用的

2.1、点击Home配置按钮，位置在工具栏右侧第一个。

2.2、首先要配置home路径，点击【浏览】选择要使用的home根路径文件夹。

2.3、检查数据源配置，要注意：design数据源是我们启动项目时使用的数据源；基准库是导出预制脚本时用到的数据源；本插件支持的数据库类型与配置的home支持的数据库类型一致。

3 新建一个YonBIP高级版项目

3.1、新建YonBIP高级版项目共三个入口：

1)File->New->project->New Project右侧列表选择YonBuilder Premium项目；

2)File->New->创建YonBIP高级版项目;

3)项目右键->YonBIP高级版项目工具->创建YonBIP高级版项目

3.2、以第一个入口说明

1)以第一个入口说明：此步骤适合第一次打开idea，未选择过工作空间的。首先选择jdk，如果没有就新建；然后点击【Next】。

2)输入项目名称，选择项目存放路径，点击【FInish】即可。

3)以二三入口新建项目使用说明：适合已经打开了一个工作空间。点击【创建NCC项目】后，弹出窗口，填写项目名称即可。

4)新建完成

4 新建一个YonBIP高级版业务组件

4.1、选中YonBIP高级版项目，项目右键->YonBIP高级版项目工具->创建YonBIP高级版业务组件

4.2、弹窗填写业务组件名称，点击【确定】即可。

4.3、完成新建。

5 导入已有YonBIP高级版项目

5.1、点击【Project Structure】按钮，不同版本的按钮位置不同，但是File目录下一定有这个按钮。

5.2、选择左侧的【Modules】，点击【+】，选择【New Module】

5.3、弹出了新建项目的窗口，选择对应jdk，点击【Next】

5.4、点击【Content root】后的文件夹图标，选择要导入的项目即可,2022版本可能有报错，忽略掉就可以了。

6 将已有项目转化成YonBIP高级版项目

6.1、首先要确保要转化的项目处在打开的工作空间根目录下，且未转化成idea中的模块。选中该文件夹右键->YonBIP高级版项目工具->转化成YonBIP高级版项目

6.2、在弹窗中填入模块名称，用于生成module.xml文件；

7 更新Home类路径

7.1、如果home中装了新盘或者打了补丁造成jar或.class更新，可以使用此功能。选中YonBIP高级版项目，项目右键->YonBIP高级版项目工具->更新Home类路径

7.2、等到进度条消失即可，此时不允许其他操作。

8 创建中间件服务、client服务并启动

8.1、选中YonBIP高级版项目，项目右键->YonBIP高级版项目工具->NCC项目调试服务创建->根据需要点击启动YonBIP高级版中间件或者启动YonBIP高级版重量端

8.2、点击后，服务就会启动。如果服务已启动，点击会重启服务

8.3、中间件服务中包含：hotwebs启动项、虚拟机参数和启动模块的配置。根据具体情况配置相应内容

9 导出补丁

9.1、编译项目成功后，选中要导出的文件，右键->YonBIP高级版项目工具->导出补丁包

9.2、根据需要填入信息,其中为保证导出的补丁模块名称的正确，可以编辑所选文件目录的所属模块

9.3、【扩展信息】页签中的提供者和提供者部门必须填写，然后点击导出完成。

注意：如果【扩展信息】页签中的产品版本、适用操作系统、适用中间件、适用数据库没有的话请参考文章【idea的YonBuilder Premium开发者工具(原NCC开发插件)中导出补丁功能补充说明】

10 OpenAPI接口测试

10.1、点击右侧侧边栏的[OpenAPI Tool],打开界面

10.2、首先点击左侧绿色加号配置链接信息，配置完成后点击【保存】

10.3、输入请求路径和请求参数后，点击发送按钮，结果会出现在下方。返回结果会自动格式化，方便查看。需要注意的是请求路径是以nccloud开头！

11 搜索Action类路径

我们在开发或修改bug的过程中或者通过spr，不能知道某个操作所对应的action类路径是什么。因此通过插件提供根据请求url搜索Action类的功能。

1、该功能集成在idea本身自带的搜索功能上，或者通过菜单栏中的【Navigate】菜单下的【搜索Action类路径】，再或者通过快捷键【Ctrl+Shift+Alt+F】打开对应的搜索界面。

2、输入前端请求路径或spr中的远程调用方法路径，等待片刻，下方显示对应的类，点击或Enter即可打开类

12 创建提交信息

在代码提交界面中增加【创建提交信息】的功能，可根据需要填入信息，帮助使用者规范提交信息。

1、打开提交代码页面，点击【创建提交信息】按钮；

2、在弹窗中选择对应的提交类型，填入信息，如果提交类型选择缺陷必须填写BUG编号；

3、点击【OK】后，信息自动填入提交信息输入框中。

12 代码多语抽取工具使用说明

1 本工具支持从前缀、后缀、连接符、流水号位数自定义设置多语ID生成规则；

2 本工具支持选择多文件、多文件夹进行批量抽取多语；

3 本工具支持选择Java类中某个中文词条抽取多语；

4 本工具支持提交代码时检验是否有多语需要处理；

5 本工具规定标准输出结构下，支持自动匹配多语文件，非标准输出结构支持用户自选多语文件，生成多语时支持自动匹配多语ID。

1 默认多语规范
1.1 编码格式规范
默认Java文件编码格式为GBK，多语文件（properties）编码格式为UTF-16BE

1.2 文件路径规范
标准输出默认java文件层级在项目/业务组件名/src/private(public、client)下，多语文件层级在项目/业务组件名/resources/lang/simpchn/业务组件号_0下。注：默认业务组件名为nccloud下的java文件对应多语在业务组件名为pub下

1.3 多语生成规范
默认多语码按“0业务组件号0-四位流水号”规则生成，支持用户自行设置多语码生成规则

1.4 文本识别规范

2 工具使用说明
2.1 按文件、文件夹抽取多语
在需要抽取多语的目录或文件上右键-YonBIP高级版项目工具-抽取代码多语

默认标准输出，自动根据Java文件路径匹配对应模块下多语文件,确定时会进行是否标准校验，不是标准目录需要自己取消勾选，手工进行目录选择；

可选非标准输出，需要手动指定多语文件路径

确认后自动识别所选Java文件，自动匹配代码多语文件（标准输出下自动匹配同模块下代码多语文件，非标准输出匹配指定多语文件），若已有对应多语则记录多语ID

点击左下角设置按钮后弹出设置框，用户可自行设置生成多语ID的规则，生成多语ID时按照前缀+业务组件号+后缀+连接符+流水号规则生成，在进行设置时流水号位数必填。默认规则如下图所示

点击生成多语会根据匹配多语文件的结果展示业务组件名和业务组件号，若原来业务组件下没有多语文件支持手动输入业务组件号作为生成多语的规范

点击确定会生成虚拟的多语文件和多语ID（不影响实际文件），再次确认后会更新对应的代码文件以及多语文件

生成完成后可以检查生成情况，点击确定会进行多语信息写入并且替换java代码中的中文。

2.2 抽取单个词条多语
抽取单个词条多语时，需要选中对应的文字之后右键，即可看到抽取单个词条菜单项

选择多语文件后点击生成词条多语即可生成对应的多语ID，确定后写入文件

选择完多语文件路径后，点击生成多语词条，就可以看到生成好的多语词条了

最后点击确定会进行多语信息写入并且替换java代码中的中文，生成后可能不能及时显示，可以尝试切换下代码类，既可以看到效果。

2.3 代码提交前自动检测是否有多语需要处理
可以通过设置提交信息弹窗中的“是否提交自动检测多语”选中框控制提交前校验，勾选则代码提交前会校验是否有多语未处理

如果不想要git提交检测可以在配置处取消勾选检测多语功能

在这里插入图片描述