模型代码联动难? BizWorks来助力

小咪咪 2024-04-08 10:04 26阅读 0赞

**简介：** 本文介绍了业务模型设计和实现保持一致的重要性以及实际落地可能遇到的问题，以及BizWorks如何设计并提供一种双向联动能力， 通过BizWorks Toolkit(IDE 插件) 来解决和优化双向联动过程中的一系列问题。

业务模型设计和沉淀是企业数字化转型过程中非常重要的一个环节, 日趋复杂的业务场景和协作模式给建模的有效性以及模型作为业务资产如何持续发挥价值带来了新的挑战:

*  设计完成的业务模型是否被合理实现了?
 *  经过数月、半年、1年迭代后，模型设计还能否对业务系统的演进起到有效价值?
 *  当企业供应商更换时, 业务系统的关键模型设计是否被有效保留了? 如何最大程度降低切换成本?

### BizWorks双向联动机制 ###

针对这一系列问题，BizWorks建模平台设计并提供了一种平台模型和代码的双向联动机制, 其主要原理如下所示:

![5d202e1f7fce96dabc327b03adba75ce.png][]

1.  模型到代码 - 设计阶段

*  设计阶段, 在建模平台完成模型设计, 实现模型的可视化和在线化
 *  通过平台预置能力生成脚手架，模型对应的代码框架也同时生成

1.  代码到模型 - 开发阶段

进入开发阶段后，研发人员更聚焦在代码侧，可以借助BizWorks Toolkit(IDE 插件) 快速完成

*  本地模型批量标注
 *  本地模型批量扫描上报

1.  联动效率和有效性

如何将平台(重设计)，代码IDE(重开发)这两个不同定位的场景有效串联是双向联动需重点解决的问题。

BizWorks Toolkit(IDE 插件)通过提供了一系列配套能力使联动效率得到很大提升，也使得双向联动这一流程能有效落地:

*  平台模型实时同步
 *  模型&代码实时校验
 *  模型&代码一致性规约扫描
 *  错误修复辅助(快速定位错误代码、QuickFix)
 *  针对模型变更的代码增量生成
 *  代码侧模型批量扫描上报

此外，结合模型灵活的多版本机制，双向联动可有效支持如下场景:

![367cd2d085aa693515424724b065731c.png][]

### BizWorks Toolkit能力介绍 ###

BizWorks Toolkit(IDE 插件)对双向联动的有效性起到了很大的作用，下面我们来看下具体是如何工作的。

1. BizWorks Toolkit安装和配置

首先通过插件市场完成BizWorks Toolkit安装

![079b1bb7e42913e6918e471355fdf079.png][]

完成登录认证信息(具体步骤请参见 [BizWorks Toolkit在线帮助][BizWorks Toolkit] )

2. 完成应用和业务域版本的关联和相关配置

![aa26dcf3e0f75b1b0753ed7cd8cc3e33.png][]

![025c969392b7f4fdba59513b7c89bc0a.png][]

![468072114542b1592ccda4fdce49ed1b.png][]

3. 查看和同步平台模型数据

首先打开BizWorks视图窗口

![6265256336ad112f851f1d90f8194e43.png][]

可以通过以下两种方式触发同步建模平台模型数据操作：

通过BizWorks菜单

![ba1a848b9640fe5386c1535bffe587b1.png][]

或通过平台模型标签的同步下载入口

![4ad05f724ff1046b389a654b4bcc56ce.png][]

同步元数据成功后，界面会出现下图所示的提示

![9e8ac46a9672d73637cb444aa14bac6e.png][]

同步建模平台模型后，插件可以实时对比模型与代码差异，并提供修复建议。

4. 模型增量生成到本地/删除平台模型

右键单击目标模型，选择同步模型到本地

![c95f1eb494d8bc76a7514b6feede29b9.png][]

选择目标路径

![5a70b90644015b40583cc2f79144bca2.png][]

模型增量生成代码

![e586cd5248103e0a60f12b8935b3944d.png][]

此外当有必要时，我们也可以在代码侧删除平台非必要模型

![e18dc28be2b16664cabf4b35921e0674.png][]

![c0e6e1c5b001b9124f2036a37656628e.png][]

5. 代码标记为模型

我们可以通过多种方式快速完成将代码标记为模型:

*  根据目录批量标注

![24678e040cc3b31a8ec9f7782f7e3c8f.png][]

*  单文件标注

类导航树右键菜单：

![b98ef5391419691f43ee86be1fbb7c7e.png][]

或当前类编辑区域右键菜单：

![1f2dec8b16eaddcdd2744781038a9e0e.png][]

6. 新建模型代码模板

我们可以根据需要选择具体模型类型，快速创建其对应的代码模板，新建的模型代码可通过后续的模型上报更新到建模平台。

![d9f2a814edb6a90abf09649958ee2a69.png][]

7. 本地代码与平台模型的一致性约束

BizWorks Toolkit(IDE 插件)会实时校验本地代码和平台模型的一致性，当代码内容与平台模型存在不一致时，会标注下划线突出显示，在鼠标悬停或使用快捷键（Ctrl+F1）时界面会出现相应的错误提示。

![9c8dbab880bd4c5ec6f8b2371a3178fe.png][]

或通过一致性规约扫描，会对平台模型和本地代码进行批量扫描并显示不一致问题

![ec4e7636b05f6cb5e2109884d6a0f186.png][]

![2b36d768938f61d7d1f56cb62bd8b3cc.png][]

如果安装BizWorks插件的同时也安装了阿里规约扫描（Alibaba Java Coding Guidelines）插件，触发BizWorks规约扫描时会同时触发阿里规约扫描。

![50fac7c73984d6feda5727b0aa69de30.png][]

8. 快速修复代码和模型不一致问题

对于一致性校验不符合的内容，BizWorks Toolkit(IDE插件)提供了在代码侧或平台侧快速修复的方式

![97da04506108502995384e5b6c97e3d6.png][]

![719a9b0a4b310316640fe82c8c8d4d9d.png][]

9. 批量扫描上报模型

可以通过"BizWorks菜单 - 扫描项目代码为模型"或 "BizWorks - 本地模型"标签页的扫描入口进行本地模型批量扫描

![164b6f6a7cef4ac8a41d5115ef933ee6.png][]

扫描后可查看本地模型

![87611a27f3c14341e09af5edbbfe6d95.png][]

以及本地模型和平台模型的差异

![bf63a64552808defaa065d3e8ec2d4df.png][]

并选择批量上报或选择单个模型进行上报

![50c4167f0272afaeee4f6e415ecb39ed.png][]

关于BizWorks Toolkit(IDE插件) 更多内容，请参见 [BizWorks Toolkit在线帮助][BizWorks Toolkit]

### 总结 ###

本文介绍了业务模型设计和实现保持一致的重要性以及实际落地可能遇到的问题，以及BizWorks如何设计并提供一种双向联动能力， 通过BizWorks Toolkit(IDE 插件) 来解决和优化双向联动过程中的一系列问题。

BizWorks Toolkit(IDE 插件)也还在持续演进和优化，希望通过更高效、更易用的机制帮助大家得心应手地完成模型设计和实现的一致性联动并持续演进，非常欢迎大家的试用并提供宝贵的优化建议。

如果大家对BizWorks（企业级云原生应用数字工作台）相关产品有兴趣，也欢迎访问BizWorks主页做详细了解： [https://www. aliyun.com/product/appl icationservice/bizworks][https_www. aliyun.com_product_appl icationservice_bizworks]

同时也欢迎钉钉扫码与我们联系：

[5d202e1f7fce96dabc327b03adba75ce.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/74264dfe007042e0942bc71f4476914c.png
[367cd2d085aa693515424724b065731c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/ab6a66d582744ccc82116b1c7c7e9dfa.png
[079b1bb7e42913e6918e471355fdf079.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/d443aa01680e428e84005a8c54026bc8.png
[BizWorks Toolkit]: https://link.zhihu.com/?target=https%3A//help.aliyun.com/document_detail/421535.html
[aa26dcf3e0f75b1b0753ed7cd8cc3e33.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/9a89bf5012b841aa8a5dbd0a33f7da2a.png
[025c969392b7f4fdba59513b7c89bc0a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/28ef1786765941e79bf8870bc24b25cb.png
[468072114542b1592ccda4fdce49ed1b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/d9365d06c35344308058172be18ef457.png
[6265256336ad112f851f1d90f8194e43.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/eed094ff59b74b429a40c31b9e1e2f21.png
[ba1a848b9640fe5386c1535bffe587b1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/2dadf7deb89b419f98732994fe17f19f.png
[4ad05f724ff1046b389a654b4bcc56ce.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/1b612b5459f94274a07c0f27608a837b.png
[9e8ac46a9672d73637cb444aa14bac6e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/c4f36798dec34abc829a6cfdcf30e4c3.png
[c95f1eb494d8bc76a7514b6feede29b9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/13505147cd6f4a61ba23b8042bc31641.png
[5a70b90644015b40583cc2f79144bca2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/6eef2528190541c0b17a678ec990e294.png
[e586cd5248103e0a60f12b8935b3944d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/d0efa0f8abb840ca8019ad2b84b246c1.png
[e18dc28be2b16664cabf4b35921e0674.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/482f0ebd613643fe97d6eb18bd6cfb46.png
[c0e6e1c5b001b9124f2036a37656628e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/9818bd2493744f3c80c9ddf4651347b3.png
[24678e040cc3b31a8ec9f7782f7e3c8f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/991120a6d6a74792bdfd27030f4a3c26.png
[b98ef5391419691f43ee86be1fbb7c7e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/7d1418e157c341c6a183f8680b55b021.png
[1f2dec8b16eaddcdd2744781038a9e0e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/7031116623a54f2c86ec70b8dd962728.png
[d9f2a814edb6a90abf09649958ee2a69.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/667d4088746c485c9f126cddd52ec051.png
[9c8dbab880bd4c5ec6f8b2371a3178fe.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/e4e5912d7eaa44ec86d9a8824e8e361c.png
[ec4e7636b05f6cb5e2109884d6a0f186.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/d65dd1e26d84408ea7e604b20566e9b9.png
[2b36d768938f61d7d1f56cb62bd8b3cc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/40aeef213e034f32a4583716852ccd42.png
[50fac7c73984d6feda5727b0aa69de30.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/6d6233e140de4d4899af9d82a9328a8b.png
[97da04506108502995384e5b6c97e3d6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/a80e33323f714462a45e125f1792b946.png
[719a9b0a4b310316640fe82c8c8d4d9d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/378a0de10fb749c48540838e3b6c1568.png
[164b6f6a7cef4ac8a41d5115ef933ee6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/58dfa3bcfccf4412885130b947b980fe.png
[87611a27f3c14341e09af5edbbfe6d95.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/e4fe60984e9d43c4835227986fda7bdf.png
[bf63a64552808defaa065d3e8ec2d4df.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/494fdada94ed4ba9a32a16b998b1267f.png
[50c4167f0272afaeee4f6e415ecb39ed.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/f6f0ba4a1abc427aaa5637eb84587f82.png
[https_www. aliyun.com_product_appl icationservice_bizworks]: https://link.zhihu.com/?target=https%3A//www.aliyun.com/product/applicationservice/bizworks