首页
/ EventCatalog项目新增可视化组件按资源禁用功能

EventCatalog项目新增可视化组件按资源禁用功能

2025-07-04 18:55:11作者:尤峻淳Whitney

在EventCatalog项目的最新版本2.39.2中,开发团队引入了一项重要功能改进:允许用户针对单个资源文件禁用可视化组件。这项功能优化了大型目录场景下的使用体验,同时提升了构建效率。

功能背景

EventCatalog作为事件驱动架构的文档工具,其可视化功能原本会为所有资源自动生成交互式图表。但在实际使用中,部分用户反馈:

  1. 大型目录中存在不需要可视化的资源
  2. 不必要的可视化组件会增加构建时间
  3. 某些资源类型的可视化展示价值有限

技术实现方案

新版本通过在资源文件的frontmatter区域添加visualiser字段实现精细控制:

---
visualiser: false
---

当该字段设为false时,系统将:

  • 跳过当前资源的可视化组件生成
  • 减少构建时的渲染开销
  • 保持其他功能的正常运作

设计决策过程

开发团队在方案设计阶段考虑了两种实现路径:

  1. 全局配置:通过配置文件批量禁用某类资源(如所有事件/服务)的可视化
  2. 细粒度控制:允许每个资源文件独立配置

最终选择了后者,主要基于以下考量:

  • 提供更灵活的配置能力
  • 适应异构资源场景
  • 保持与现有配置体系的兼容性

最佳实践建议

对于不同规模的项目,建议:

  • 小型目录:保持默认开启,充分利用可视化优势
  • 中型目录:对数据模型复杂的资源保持可视化
  • 大型目录:仅为核心资源启用可视化

该功能已在2.39.2版本稳定发布,用户升级后即可立即使用。这项改进体现了EventCatalog团队对用户体验的持续优化,特别是在处理大规模架构文档时的性能考量。

登录后查看全文
热门项目推荐
相关项目推荐