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

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

2025-07-04 19:06:24作者:尤峻淳Whitney

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

功能背景

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

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

技术实现方案

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

---
visualiser: false
---

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

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

设计决策过程

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

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

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

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

最佳实践建议

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

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

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

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

最新内容推荐

项目优选

收起
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
136
187
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
880
520
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
361
381
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
181
264
kernelkernel
deepin linux kernel
C
22
5
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
7
0
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.09 K
0
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
613
60
open-eBackupopen-eBackup
open-eBackup是一款开源备份软件,采用集群高扩展架构,通过应用备份通用框架、并行备份等技术,为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力,帮助用户实现关键数据高效保护。
HTML
118
78