Skip to content

示例插件 ​

插件信息

名称:示例插件(example) 版本:v0.1.0 类型:官方插件 状态:已内置

概述 ​

示例插件是 MengStack 的插件开发参考实现,展示了一个标准插件的完整结构:实体定义、数据迁移、CRUD 接口、事件发布。开发者可以参照此插件快速开发自己的自定义插件。

功能特性 ​

  • 标准 CRUD:提供创建、查询列表、查询详情、删除四个基础接口
  • BaseModel 继承:实体自动获得多租户隔离和软删除能力
  • 事件发布:演示插件事件发布机制(支持通配符事件名)
  • 最简实现:无权限检查,任何已认证用户均可操作

注意

示例插件仅供开发参考,不建议在生产环境启用。它不设置 AdminPanel,不会在管理后台显示入口。

数据模型 ​

示例(Example) ​

字段类型说明
iduuid主键(继承自 BaseModel)
tenant_iduuid租户 ID(继承自 BaseModel)
namevarchar(255)名称
descriptiontext描述
statussmallint状态(默认 1)
expires_attime?过期时间(可为空)
created_attime创建时间(继承自 BaseModel)
updated_attime更新时间(继承自 BaseModel)
deleted_attime软删除时间(继承自 BaseModel)

API 接口 ​

需认证接口(无权限检查) ​

方法路径说明
POST/api/v1/examples创建示例
GET/api/v1/examples获取示例列表(分页)
GET/api/v1/examples/:id获取示例详情
DELETE/api/v1/examples/:id删除示例

事件 ​

示例插件使用通配符事件名,可发布任意事件:

go
eventBus.Publish(ctx, "example.*", payload)

数据库表 ​

表名说明
examples示例表

插件开发要点 ​

从示例插件中提取的开发清单:

  1. 实现 plugin.Plugin 接口:Metadata()、Permissions()、FxOption()、SetupRoutes()、Init()、MigrationsFS()
  2. 实体嵌入 model.BaseModel:自动获得 (id, tenant_id) 复合主键和软删除
  3. 使用 middleware.MultiTenant():所有路由自动注入租户过滤
  4. 通过 uber-go/fx 注册依赖:在 FxOption() 中返回 fx.Provide 和 fx.Invoke
  5. 数据库迁移:GORM AutoMigrate 在 Init() 中执行
  6. 事件发布:通过 eventbus.EventBus 发布领域事件

依赖 ​

  • auth:用户认证
  • org:多租户隔离

Released under the Apache 2.0 License.