docs: add admin and development documentation

2026-10-10 20:56:36 +08:00
parent f6024f0964
commit f646a0cbf6
122 changed files with 8626 additions and 0 deletions
@@ -0,0 +1,86 @@
+## 模块辅助说明
+
+目录
+
+- 模块结构
+- 获取模块信息
+- 插件路由规则
+
+
+#### 模块结构
+- 文件路径：server/internal/library/addons/module.go
+
+```go
+// Skeleton 模块骨架
+type Skeleton struct {
+    Label       string      `json:"label"`       // 标识
+    Name        string      `json:"name"`        // 名称
+    Group       int         `json:"group"`       // 分组
+    Logo        string      `json:"logo"`        // logo
+    Brief       string      `json:"brief"`       // 简介
+    Description string      `json:"description"` // 详细描述
+    Author      string      `json:"author"`      // 作者
+    Version     string      `json:"version"`     // 版本号
+    RootPath    string      `json:"rootPath"`    // 根路径
+    View        *gview.View `json:"view"`        // 模板引擎
+}
+
+func (s *Skeleton) GetModule() Module {
+	return GetModule(s.Name)
+}
+
+// Module 插件模块
+type Module interface {
+    Start(option *Option) (err error)          // 启动模块
+    Stop() (err error)                         // 停止模块
+    Ctx() context.Context                      // 上下文
+    GetSkeleton() *Skeleton                    // 获取模块
+    Install(ctx context.Context) (err error)   // 安装模块
+    Upgrade(ctx context.Context) (err error)   // 更新模块
+    UnInstall(ctx context.Context) (err error) // 卸载模块
+}
+```
+
+#### 获取模块信息
+
+- 在插件模块内
+
+```go
+package main
+
+import (
+	"fmt"
+	"hotgo/addons/hgexample/global"
+)
+
+func test()  {
+	fmt.Printf("当前插件模块是：%+v", global.GetSkeleton())
+}
+```
+
+- 在插件模块外
+
+```go
+package main
+
+import (
+	"context"
+	"fmt"
+	"hotgo/internal/library/addons"
+	"hotgo/internal/library/contexts"
+)
+
+func test(ctx context.Context)  {
+	fmt.Printf("当前是否为插件请求：%v", contexts.IsAddonRequest(ctx))
+	if contexts.IsAddonRequest(ctx) {
+		fmt.Printf("当前插件名称：%v", contexts.GetAddonName(ctx))
+		fmt.Printf("当前插件信息：%v", addons.GetModule(contexts.GetAddonName(ctx)))
+	}
+}
+```
+
+- 更多辅助方法请参考插件功能库：server/internal/library/addons
+
+#### 插件路由规则
+- 如果你不喜欢现在的路由风格，可以自行调整。修改位置在：\server\internal\library\addons\addons.go的RouterPrefix方法。 
+- 注意调整后如web前端页面中如有之前的路由风格也需同步修改。