配置BizWorks Toolkit(适用于0.12.0之前版本)

更新时间: 2023-09-13 16:31:32

使用BizWorks Toolkit插件前您需要完成相关配置,例如:基础信息配置、关联平台配置、代码配置、双向联动配置和modules.yaml配置等。

配置基础信息

  1. 打开IDEA,在顶部导航栏选择File > Settings1
  2. BizWorks Toolkit插件的一些基础配置,例如,是否使用BizWorks Toolkit、是否启用代码检查等,这些配置项建议您全部选中开启。1

配置关联平台

如果在配置关联平台的过程中,IDEA界面展示信息中的任意一项与下文中图片示例不符,请您检查平台是否有相关信息。例如,该项目下是否新建了应用,应用是否有关联业务域或商业能力,项目是否正确导入且构建通过,配置modules.yaml是否存在以及正确。更多相关信息,请参见使用BizWorks Toolkit注意事项

  1. Settings对话框的左侧导航栏中,选择BizWorks > 关联平台配置1

    如果您还未登录,项目应用版本为置灰不可编辑状态,您可以单击Settings对话框右上角的登录去进行登录操作。具体操作,请参见登录BizWorks Toolkit账号

    1
  2. 选择目标项目应用版本,完成后页面会展示出平台关联的业务域和商业能力信息。1
  3. 单击导入配置文件内容后,单击OK1
    完成配置后,后台开始下载平台模型到本地,您可以在IDEA右侧BizWorks导航栏查看平台模型以及进行本地模型扫描等操作。1

配置代理

  1. Settings对话框的左侧导航栏中,选择BizWorks > 动态代理配置
  2. 您可以参考下图进行动态代理配置。1
    相关配置项说明请参见下表。
    配置项说明
    No proxy如果您选中该配置项,则不能使用代理功能。
    HTTP如果您选中该配置项,则网络使用HTTP代理。
    Host name代理服务器地址。
    Post number代理服务器端口号。
    Proxy authentication支持配置是否需要验证。
    Login验证账号。
    Password验证密码。

配置双向联动

您可以通过双向联动配置,设置在提交本地扫描结果时是否删除平台上本地不存在的模型,默认为不删除。

Settings对话框的左侧导航栏中,选择BizWorks > 双向联动配置1
双向联动配置用于上报模型、下拉模型时进行一些自定义的配置。例如,上报时是否删除本地不存在的模型,扫描时是否扫描一些staticfinal修饰的fieldmethod等。

配置modules.yaml

说明
  • 平台模块代码包目录理论上是一对多的关系,即任意一个平台模块可以对应多个代码包
  • modules.yaml用于配置平台模块与代码包的关联关系,该文件可以配置多个平台模块的关系。代码的位置是默认生成的,如果modules.yaml文件不存在,您可以在相应位置新建该文件。

查找modules.yaml

您可以通过以下目录路径查看是否存在modules.yaml文件。

  • 项目名称-starter/src/main/resources/bizworks/modules.yaml
  • 项目名称/src/main/resources/bizworks/modules.yaml
  • 根目录/.bizworks/modules.yaml

modules.yaml相关参数说明

modules.yaml文件样例如下:
bizworks:
  modules:
    - type: "MODULE_CENTER"
      code: "TestDomain"
      packages:
        - "demo.demo.businessdomain.testdomain"
    - type: "BUSINESS_CAPABILITY"
      code: "TestBusiness"
      packages:
        - "demo.demo.businesscapability.testbusiness"
        - "demo.demo.businesscapability.testpackages"
modules.yaml相关参数说明如下表所示。
参数说明
bizworksBizWorks modules需配置固定key
bizworks.modules模块列表。modules.yaml文件支持配置多个模块。
bizworks.modules.type各个模块的类型。支持的可选项如下:
  • MODULE_CENTER:业务域。
  • BUSINESS_CAPABILITY:商业能力。
bizworks.modules.code模块编码,从平台获取。
bizworks.modules.packages反映模型的代码所在Package,在关联平台配置操作中被导入。modules.yaml文件支持配置多个Package。
说明 平台扫描本地代码时只会扫描已关联的Package下的类。
阿里云首页 BizWorks 相关技术圈