Go-Lynx 插件文档完善与使用指南

发布日期: 2025年2月13日

本站对 Go-Lynx 的插件文档做了一轮补充与整理：新增十余个插件的独立说明页，并补上统一的插件使用指南，方便你从配置入口一路查到接入方式。

文档更新概览

新增插件文档页

以下插件此前仅在 插件生态 中提供 GitHub 链接，现已在本站拥有独立文档，重点覆盖配置说明与接入方式：

• Elasticsearch — 全文检索、索引与聚合，健康检查与指标
• RabbitMQ — 多实例生产者/消费者、Exchange 类型与健康指标
• RocketMQ — 集群/广播消费、多 Topic 订阅与健康检查
• Pulsar — 生产/消费、批处理、Schema、多租户与 TLS
• Apollo — 配置中心、多命名空间、监听与缓存能力
• Etcd — 配置中心与服务注册发现
• Redis 分布式锁 — 基于 Redis 的分布式锁、续约与协调语义
• Etcd 分布式锁 — 基于 Etcd 的强一致分布式锁
• DTM — 分布式事务（SAGA、TCC、XA、二阶段消息）
• Layout — 官方项目模板与本地开发路径
• SQL SDK — SQL 公共基础层与扩展入口

上述页面统一围绕：能力定位、基础配置、接入方式、使用建议和相关链接 来组织，方便先理解插件在 Lynx 运行时中的职责，再决定是否接入。

新增「插件使用指南」

在 快速开始 体系下新增 插件使用指南，统一说明：

1. 添加依赖 — 如何通过 go get 引入插件
2. 在配置中声明 — lynx.<plugin> 的配置方式与依赖关系
3. 注册插件 — 匿名导入与启动时加载
4. 在业务中注入使用 — Getter 与插件管理器的使用方式

并附常见场景速查表（HTTP/gRPC、数据库、缓存、消息队列、配置中心、服务发现、分布式事务与锁、链路追踪、脚手架等），便于按需求快速跳到对应插件文档。

插件生态页更新

插件生态 中的表格也已更新：原先只链到 GitHub 的插件，现在都能直接跳到站内文档，并附有简短说明，方便在站内完成从选型到配置、接入的闭环。

如何使用插件（速览）

• 打开 插件生态 按类别找到目标插件。
• 阅读该插件的独立文档（能力定位 + 配置 + 接入方式）。
• 若不熟悉通用流程，可先看 插件使用指南 中的四步接入流程与场景速查。

后续计划

• 继续补充各插件的最佳实践与常见问题。
• 根据社区反馈增加更多示例（如多数据源、多实例消息队列等）。
• 保持与主仓库及各插件仓库 README 的同步更新。

感谢使用 Go-Lynx。若有文档建议或发现错误，欢迎在 lynx.github.cn 提 Issue 或 PR。

相关链接

• 文档首页: go-lynx.cn
• 插件生态: 插件生态一览
• 插件使用指南: 插件使用指南
• 快速开始: 快速开始