使用BizWorks Toolkit注意事项

本文介绍BizWorks Toolkit插件支持的项目结构和使用项目的前提。

BizWorks Toolkit插件支持的项目结构

重要

如果多个应用在一个项目根目录下,需要使用IDEA单独打开应用进行配置以及上报。

BizWorks Toolkit插件支持一级Module和二级Module项目,同时需在BizWorks平台拥有对应的项目与应用,且需要拥有modules.yaml(适用于0.12.0之前版本)或bizworks.yml(适用于0.12.0版本及之后的版本)配置。更多相关信息,请参见生成代码配置modules.yaml配置bizworks.yml

BizWorks Toolkit插件使用项目前提

项目使用前提项

说明

账号登录

具体操作,请参见登录BizWorks Toolkit账号

语言限制

需支持Java语言。

modules.yaml(适用于0.12.0之前版本)或bizworks.yml(适用于0.12.0版本及之后的版本)

项目需存在配置正确的modules.yaml(适用于0.12.0之前版本)或bizworks.yml(适用于0.12.0版本及之后的版本)文件。更多信息,请参见配置modules.yaml配置bizworks.yml

项目被正常导入且构建通过

因为插件使用IDEA的索引,所以项目需在IDEA中构建通过(非构建工具,例如:mavengradle的构建)。

更多信息,请参见如何判断项目被正常导入和打开如何判断项目构建通过

如何判断项目被正常导入和打开?

说明

要保证项目(例如:多级项目)正常构建打开,您需要检查每一级是否正常。

打开IDEA,您可以通过以下两种方式判断项目是否被正常导入和打开。

  • 通过Project窗口查看相应项目的目录是否解析为IDEA的Module(有1图标)。1

  • 在顶部导航栏选择File > Project Structure。在Project Structure对话框中,查看Modules模块是否被正常解析验证。1

    如果Project Structure对话框显示如上图所示,则说明项目被正常导入和打开。

如何判断项目构建通过?

在确认项目正常导入后,您可通过以下方式检查项目是否构建通过。

在顶部导航栏选择Build > Build Project1

如果IDEA未弹出构建窗口展示错误提示,且任意打开一个源代码文件可以正常解析提示,且无报错,则表明项目构建索引通过。