Appearance
插件生态
MengStack 插件生态系统为框架提供标准化的功能扩展机制。每个插件是独立的模块,通过扩展点接入系统。
插件系统版本
| 版本 | 适用宿主 | 特性 | 文档 |
|---|---|---|---|
| v2.0 | MengStack v2.0 | 沙箱隔离、按需装配、声明式扩展点、插件市场 | 查看文档 |
| v1.0 | MengStack v1.0 | 回调注册、基础扩展点 | 查看文档 |
推荐
新功能开发建议使用 v2.0 插件系统,享有沙箱隔离和按需装配能力。
官方插件
MengStack v2.0 内置插件
| 插件 | 功能 | 版本 | 文档 |
|---|---|---|---|
| cms | CMS 内容管理(文章、频道、分类、标签、媒体) | v0.2.0 | 查看文档 |
| comment-interaction | 评论互动(评论、点赞、收藏、举报、分享) | v0.1.0 | 查看文档 |
| topic | 专题管理(专题、专题文章、自动归组规则) | v0.1.0 | 查看文档 |
| flash | 快讯管理(快讯、分类、标签、趋势标记) | v0.1.0 | 查看文档 |
| community | 社区论坛(板块、帖子、回帖、精华帖) | v0.1.0 | 查看文档 |
| search | 全文搜索(多类型搜索、搜索建议、热搜词) | v0.1.0 | 查看文档 |
| seo | SEO 管理(TDK、Sitemap、Robots、重定向、内链) | v0.3.1 | 查看文档 |
| example | 示例插件(插件开发参考实现) | v0.1.0 | 查看文档 |
快速开始
创建新插件
bash
# 克隆 MengStack v2.0 发行版
git clone https://mengstackgit.softunis.com/softunis/mengstack-kernel-dist.git
cd mengstack-kernel-dist
# 使用脚手架创建插件骨架
go run ./cmd/smrm new module my-plugin脚手架会在 internal/modules/ 下生成四层架构骨架代码(domain / application / infrastructure / interfaces)。
插件开发流程
- 创建模块 — 使用
smrm new module生成骨架代码 - 实现 Plugin 接口 — 编写
Metadata()、Permissions()、FxOption()、SetupRoutes()、Init()、MigrationsFS()六个方法 - 声明权限 — 通过
Permissions()方法返回六维权限沙箱配置 - 注册路由 — 在
SetupRoutes()中注册 HTTP 路由和权限中间件 - 编写迁移 — 在
infrastructure/migration/下创建 SQL 迁移文件 - 注册模块 — 在主应用 FX 模块列表中添加新插件
详细步骤请参考 v2.0 插件开发指南。
插件规范
目录结构
my-plugin/
├── plugin.go # Plugin 接口实现(入口)
├── domain/ # 领域层
│ ├── entity.go # 实体定义
│ └── repository.go # 仓储接口
├── application/ # 应用层
│ └── service.go # 业务服务
├── infrastructure/ # 基础设施层
│ ├── repository.go # 仓储实现
│ └── migration/ # 数据库迁移 SQL
├── interfaces/ # 接口层
│ ├── handler.go # HTTP 处理器
│ └── plugin.go # 路由注册 + 扩展点
└── README.mdPlugin 接口
每个插件实现 6 个方法:
go
type Plugin interface {
Metadata() Metadata // 插件元数据
Permissions() Permissions // 六维权限声明
FxOption() fx.Option // FX 依赖注入
SetupRoutes(engine *gin.Engine, authMW gin.HandlerFunc,
tenantResolver tenant.Resolver,
requirePerm RequirePermissionFunc)
Init() error // 初始化
MigrationsFS() fs.FS // 迁移文件
}
