Backstage Monorepo 的宝库：“common-library”的完美使用方法

大家好！今天，我们将深入探讨在Backstage的包管理系统中扮演着非常重要角色的“common-library”角色(Role)。🚀

随着Backstage项目的不断壮大，多个插件中会自然而然地出现一些通用的实用函数或UI组件。此时，为了避免代码重复并进行高效管理，我们就会使用“common-library”。💡

---

🏗️ 理解 Backstage 的包角色(Role)系统

Backstage 为了高效地构建和管理 Monorepo 中的众多包，会为每个包赋予一个“角色”。这在 package.json 文件的 backstage.role 字段中明确指定，并且根据这个角色，构建工具和系统处理该包的方式也会有所不同。

其中，“common-library”顾名思义，就像一个“公共宝库”。

---

🌟 “common-library”包的核心目的

这个角色最主要的目的就是共享可以在其他多个包中重复使用的组件或实用工具。

它不仅仅是用于特定插件内部，而是将整个项目中普遍使用的代码集中起来。

✅ 主要角色详细说明

• 共享可重用组件： 定义多个前端插件中通用的按钮样式、布局组件等，有助于保持UI的一致性。
• 提供实用函数： 提供日期格式转换、API响应处理逻辑等重复使用的业务逻辑或辅助函数。
• 消除插件间的代码重复： 无需在每个插件中复制粘贴相同的代码，通过引用库来最大化维护效率。

---

🛠️ 实际应用：package.json 配置示例

如果您的项目想创建一个通用实用工具包，请按如下方式配置：

JSON

{
  "name": "@internal/common-utils",
  "version": "1.0.0",
  "backstage": {
    "role": "common-library"  // 👈 在这里定义角色。
  },
  "dependencies": {
    "lodash": "^4.17.21"
  }
}

通过此配置，Backstage CLI 会识别到“啊，这个包是供其他地方使用的库！”，并应用适当的构建流程。

---

🏁 结论：整洁 Monorepo 的必备选择

“common-library”是 Backstage 项目代码质量和一致性的坚实后盾。如果能很好地分离并以这个角色管理通用功能，那么无论项目变得多么庞大，您都不会害怕维护！🚀

---