签入版本
This commit is contained in:
小蚂蚁云
@@ -0,0 +1,169 @@
|
||||
// +======================================================================
|
||||
// | EasyGoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
|
||||
// +----------------------------------------------------------------------
|
||||
// | Copyright (c) 2019-2026 半城风雨团队 版权所有
|
||||
// +----------------------------------------------------------------------
|
||||
// | 开源协议: Apache-2.0
|
||||
// | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
|
||||
// +----------------------------------------------------------------------
|
||||
// | 官方网站: https://www.easygoadmin.vip
|
||||
// +----------------------------------------------------------------------
|
||||
// | 研发团队: 小蚂蚁云团队 荣誉出品
|
||||
// +======================================================================
|
||||
// | 版权和免责声明:
|
||||
// | 一、知识产权声明
|
||||
// | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
|
||||
// | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
|
||||
// | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
||||
// | 二、使用限制与禁止条款
|
||||
// | 您理解并同意，禁止将本产品用于以下任何行为：
|
||||
// | 1. 任何违反中华人民共和国法律法规的用途；
|
||||
// | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
|
||||
// | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
||||
// | 三、责任豁免
|
||||
// | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
|
||||
// | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
||||
// | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
|
||||
// | 四、违约与法律责任
|
||||
// | 如发现任何违反本声明的行为，本团队有权：
|
||||
// | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
|
||||
// | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
|
||||
// | 3. 保留进一步采取刑事控告等法律措施的权利。
|
||||
// | 五、许可范围说明
|
||||
// | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
|
||||
// | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
||||
// | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
||||
// | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
|
||||
// | 成的一切经济损失及商誉损害。
|
||||
// | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
|
||||
// | 许可协议》附件为准。
|
||||
// +======================================================================
|
||||
|
||||
package router
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"reflect"
|
||||
"strings"
|
||||
|
||||
"github.com/gogf/gf/v2/errors/gerror"
|
||||
"github.com/gogf/gf/v2/net/ghttp"
|
||||
"github.com/gogf/gf/v2/net/goai"
|
||||
|
||||
"easygoadmin/internal/consts"
|
||||
"easygoadmin/internal/router/meta"
|
||||
"easygoadmin/utility/response"
|
||||
)
|
||||
|
||||
// ============================== 控制器反射绑定 ==============================
|
||||
|
||||
// BodyUnmarshaler 自定义请求体解析逃生舱
|
||||
//
|
||||
// 当请求体顶层形态无法用结构体标签表达时实现该接口；
|
||||
// 实现后跳过默认的请求参数解析，gvalid 校验需在实现内自行完成
|
||||
type BodyUnmarshaler interface {
|
||||
UnmarshalBody(r *ghttp.Request) error
|
||||
}
|
||||
|
||||
// Bind 反射注册控制器
|
||||
//
|
||||
// 基于 gmeta 扩展标签完成路由注册与统一包装：
|
||||
//
|
||||
// 1. 扫描控制器导出方法，校验签名：
|
||||
// func (c *Xxx) Page(ctx context.Context, req *v1.XxxReq) (*v1.XxxRes, error)
|
||||
// 2. 解析请求结构体内嵌 gmeta.Meta 上的扩展标签：
|
||||
// method、path、summary、permission、log、logType、public
|
||||
// 3. 按 method:path 注册路由并写入路由元数据表
|
||||
// 4. 统一包装：权限校验 → 参数解析（含 gvalid 校验）→ 调用 → 信封写出
|
||||
func Bind(s *ghttp.Server, ctrl any) {
|
||||
ctrlVal := reflect.ValueOf(ctrl)
|
||||
ctrlType := reflect.TypeOf(ctrl)
|
||||
for i := 0; i < ctrlType.NumMethod(); i++ {
|
||||
m := ctrlType.Method(i)
|
||||
// 目标签名：(ctx, *Req) (*Res, error)；In(0) 为接收者
|
||||
if m.Type.NumIn() != 3 || m.Type.NumOut() != 2 {
|
||||
continue
|
||||
}
|
||||
reqType := m.Type.In(2)
|
||||
if reqType.Kind() != reflect.Ptr {
|
||||
continue
|
||||
}
|
||||
metaField, ok := reqType.Elem().FieldByName("Meta")
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
tag := metaField.Tag
|
||||
method := strings.ToLower(tag.Get("method"))
|
||||
path := tag.Get("path")
|
||||
if method == "" || path == "" {
|
||||
continue
|
||||
}
|
||||
rm := meta.RouteMeta{
|
||||
Method: strings.ToUpper(method),
|
||||
Path: path,
|
||||
Summary: tag.Get("summary"),
|
||||
Permission: tag.Get("permission"),
|
||||
Log: tag.Get("log"),
|
||||
LogType: tag.Get("logType"),
|
||||
Public: tag.Get("public") == "true",
|
||||
}
|
||||
meta.Register(rm)
|
||||
// 补注册进 OpenAPI 文档：闭包路由非严格路由，gf 不会自动收集，
|
||||
// 此处将带类型的控制器方法（签名 func(ctx,*Req)(*Res,error)）注册进 goai，
|
||||
// gmeta 的 path/method/summary 标签由 goai 解析为文档条目
|
||||
if err := s.GetOpenApi().Add(goai.AddInput{Object: ctrlVal.Method(i).Interface()}); err != nil {
|
||||
_, _ = fmt.Fprintf(os.Stderr, "openapi 注册失败 %s: %v\n", path, err)
|
||||
}
|
||||
handler := makeHandler(ctrlVal.Method(i), reqType, rm)
|
||||
s.BindHandler(method+":"+path, handler)
|
||||
}
|
||||
}
|
||||
|
||||
// makeHandler 构造统一请求处理包装
|
||||
//
|
||||
// 依次执行权限校验、参数解析、业务调用与响应写出
|
||||
func makeHandler(method reflect.Value, reqType reflect.Type, rm meta.RouteMeta) func(r *ghttp.Request) {
|
||||
return func(r *ghttp.Request) {
|
||||
// 路由元数据入上下文（操作日志读取）
|
||||
r.SetCtxVar(meta.CtxKey, rm)
|
||||
|
||||
// 权限校验（与日志元数据同源；permission 为空 = 登录即可）
|
||||
if rm.Permission != "" && !consts.HasPerm(r.Context(), rm.Permission) {
|
||||
response.Write(r, response.Fail(gerror.NewCode(consts.CodeForbidden)))
|
||||
return
|
||||
}
|
||||
|
||||
// 参数解析：路由参数 + query + body，并执行 gvalid 校验
|
||||
// 逃生舱：请求对象实现 BodyUnmarshaler 时走自定义解析（body 形态不规则的接口，如平铺 map）
|
||||
req := reflect.New(reqType.Elem())
|
||||
if u, ok := req.Interface().(BodyUnmarshaler); ok {
|
||||
if err := u.UnmarshalBody(r); err != nil {
|
||||
response.Write(r, response.Fail(err))
|
||||
return
|
||||
}
|
||||
} else if err := r.Parse(req.Interface()); err != nil {
|
||||
response.Write(r, response.Fail(err))
|
||||
return
|
||||
}
|
||||
|
||||
// 调用业务方法
|
||||
out := method.Call([]reflect.Value{
|
||||
reflect.ValueOf(r.Context()),
|
||||
req,
|
||||
})
|
||||
var err error
|
||||
if !out[1].IsNil() {
|
||||
err, _ = out[1].Interface().(error)
|
||||
}
|
||||
if err != nil {
|
||||
response.Write(r, response.Fail(err))
|
||||
return
|
||||
}
|
||||
if out[0].IsNil() {
|
||||
response.Write(r, response.Ok(nil))
|
||||
return
|
||||
}
|
||||
response.Write(r, response.Ok(out[0].Interface()))
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,112 @@
|
||||
// +======================================================================
|
||||
// | EasyGoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
|
||||
// +----------------------------------------------------------------------
|
||||
// | Copyright (c) 2019-2026 半城风雨团队 版权所有
|
||||
// +----------------------------------------------------------------------
|
||||
// | 开源协议: Apache-2.0
|
||||
// | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
|
||||
// +----------------------------------------------------------------------
|
||||
// | 官方网站: https://www.easygoadmin.vip
|
||||
// +----------------------------------------------------------------------
|
||||
// | 研发团队: 小蚂蚁云团队 荣誉出品
|
||||
// +======================================================================
|
||||
// | 版权和免责声明:
|
||||
// | 一、知识产权声明
|
||||
// | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
|
||||
// | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
|
||||
// | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
||||
// | 二、使用限制与禁止条款
|
||||
// | 您理解并同意，禁止将本产品用于以下任何行为：
|
||||
// | 1. 任何违反中华人民共和国法律法规的用途；
|
||||
// | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
|
||||
// | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
||||
// | 三、责任豁免
|
||||
// | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
|
||||
// | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
||||
// | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
|
||||
// | 四、违约与法律责任
|
||||
// | 如发现任何违反本声明的行为，本团队有权：
|
||||
// | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
|
||||
// | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
|
||||
// | 3. 保留进一步采取刑事控告等法律措施的权利。
|
||||
// | 五、许可范围说明
|
||||
// | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
|
||||
// | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
||||
// | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
||||
// | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
|
||||
// | 成的一切经济损失及商誉损害。
|
||||
// | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
|
||||
// | 许可协议》附件为准。
|
||||
// +======================================================================
|
||||
|
||||
package meta
|
||||
|
||||
import (
|
||||
"sync"
|
||||
)
|
||||
|
||||
// ============================== 路由元数据 ==============================
|
||||
|
||||
// RouteMeta 路由元数据
|
||||
//
|
||||
// 由请求结构体内嵌 gmeta.Meta 的扩展标签在注册时反射解析得出，
|
||||
// 权限校验、操作日志等横切能力按此元数据统一处理。
|
||||
type RouteMeta struct {
|
||||
Method string `json:"method"` // 请求方法：GET/POST/PUT/DELETE
|
||||
Path string `json:"path"` // 路由模板，如 /api/user/detail/:id
|
||||
Summary string `json:"summary"` // 接口摘要（OpenAPI）
|
||||
Permission string `json:"permission"` // 权限节点 sys:user:page；空表示登录即可
|
||||
Log string `json:"log"` // 操作日志标题；空表示不记录
|
||||
LogType string `json:"logType"` // 日志类型：query/add/update/delete/import/export/reset
|
||||
Public bool `json:"public"` // 是否免登录（登录、验证码等）
|
||||
}
|
||||
|
||||
// CtxKey 路由元数据写入请求上下文的键
|
||||
//
|
||||
// 由绑定层写入，操作日志中间件读取
|
||||
var CtxKey = struct{ name string }{"routeMeta"}
|
||||
|
||||
// store 路由元数据存储
|
||||
// 使用读写锁保护并发访问
|
||||
type store struct {
|
||||
mu sync.RWMutex
|
||||
meta map[string]RouteMeta // key: "GET /api/user/page"
|
||||
}
|
||||
|
||||
// s 全局路由元数据存储实例
|
||||
var s = &store{meta: make(map[string]RouteMeta)}
|
||||
|
||||
// key 生成存储键
|
||||
func key(method, path string) string {
|
||||
return method + " " + path
|
||||
}
|
||||
|
||||
// Register 注册路由元数据
|
||||
//
|
||||
// 由绑定层反射时调用
|
||||
func Register(m RouteMeta) {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
s.meta[key(m.Method, m.Path)] = m
|
||||
}
|
||||
|
||||
// Lookup 查询路由元数据
|
||||
func Lookup(method, path string) (RouteMeta, bool) {
|
||||
s.mu.RLock()
|
||||
defer s.mu.RUnlock()
|
||||
m, ok := s.meta[key(method, path)]
|
||||
return m, ok
|
||||
}
|
||||
|
||||
// All 返回全部路由元数据
|
||||
//
|
||||
// 供调试与文档生成使用
|
||||
func All() map[string]RouteMeta {
|
||||
s.mu.RLock()
|
||||
defer s.mu.RUnlock()
|
||||
out := make(map[string]RouteMeta, len(s.meta))
|
||||
for k, v := range s.meta {
|
||||
out[k] = v
|
||||
}
|
||||
return out
|
||||
}
|
||||
@@ -0,0 +1,151 @@
|
||||
// +======================================================================
|
||||
// | EasyGoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
|
||||
// +----------------------------------------------------------------------
|
||||
// | Copyright (c) 2019-2026 半城风雨团队 版权所有
|
||||
// +----------------------------------------------------------------------
|
||||
// | 开源协议: Apache-2.0
|
||||
// | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
|
||||
// +----------------------------------------------------------------------
|
||||
// | 官方网站: https://www.easygoadmin.vip
|
||||
// +----------------------------------------------------------------------
|
||||
// | 研发团队: 小蚂蚁云团队 荣誉出品
|
||||
// +======================================================================
|
||||
// | 版权和免责声明:
|
||||
// | 一、知识产权声明
|
||||
// | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
|
||||
// | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
|
||||
// | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
||||
// | 二、使用限制与禁止条款
|
||||
// | 您理解并同意，禁止将本产品用于以下任何行为：
|
||||
// | 1. 任何违反中华人民共和国法律法规的用途；
|
||||
// | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
|
||||
// | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
||||
// | 三、责任豁免
|
||||
// | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
|
||||
// | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
||||
// | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
|
||||
// | 四、违约与法律责任
|
||||
// | 如发现任何违反本声明的行为，本团队有权：
|
||||
// | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
|
||||
// | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
|
||||
// | 3. 保留进一步采取刑事控告等法律措施的权利。
|
||||
// | 五、许可范围说明
|
||||
// | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
|
||||
// | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
||||
// | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
||||
// | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
|
||||
// | 成的一切经济损失及商誉损害。
|
||||
// | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
|
||||
// | 许可协议》附件为准。
|
||||
// +======================================================================
|
||||
|
||||
package router
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/gogf/gf/v2/net/ghttp"
|
||||
|
||||
"easygoadmin/internal/controller"
|
||||
"easygoadmin/internal/middleware"
|
||||
"easygoadmin/utility/response"
|
||||
)
|
||||
|
||||
// ============================== 路由注册 ==============================
|
||||
|
||||
// errorf 构造状态页错误
|
||||
//
|
||||
// 响应层将其映射为 code=1 并附上消息
|
||||
func errorf(format string, args ...any) error {
|
||||
return fmt.Errorf(format, args...)
|
||||
}
|
||||
|
||||
// Register 注册全局中间件链与路由
|
||||
//
|
||||
// 中间件顺序：CORS → Response（panic 兜底）→ RateLimit（限流）→ Demo（演示拦截）→ JWT → Tenant → OperationLog → 处理器。
|
||||
// 权限校验在 Bind 包装层完成，与路由元数据同源；操作日志按元数据异步落库。
|
||||
func Register(s *ghttp.Server) {
|
||||
s.Use(
|
||||
middleware.CORS,
|
||||
middleware.Response,
|
||||
middleware.RateLimit,
|
||||
middleware.Demo,
|
||||
middleware.JWT,
|
||||
middleware.Tenant,
|
||||
middleware.OperationLog,
|
||||
)
|
||||
|
||||
// 非 200 状态统一输出 JSON（404/500 不返回 HTML）
|
||||
s.BindStatusHandler(404, func(r *ghttp.Request) {
|
||||
response.Write(r, response.Fail(errorf("接口不存在: %s %s", r.Method, r.URL.Path)))
|
||||
})
|
||||
s.BindStatusHandler(500, func(r *ghttp.Request) {
|
||||
response.Write(r, response.Fail(errorf("服务器内部错误")))
|
||||
})
|
||||
|
||||
// 静态文件：将 resource 目录作为静态资源根目录对外访问
|
||||
s.SetServerRoot("resource")
|
||||
|
||||
// 健康检查（免登录；公开路由不带 /v1，见 middleware/public.go）
|
||||
s.BindHandler("get:/api/health", func(r *ghttp.Request) {
|
||||
response.Write(r, response.Ok(map[string]any{"status": "up"}))
|
||||
})
|
||||
|
||||
// API 文档页（本地托管 Redoc，静态资源由 SetServerRoot("resource") 提供）
|
||||
s.BindHandler("get:/swagger", func(r *ghttp.Request) {
|
||||
r.Response.RedirectTo("/swagger/index.html")
|
||||
})
|
||||
|
||||
registerControllers(s)
|
||||
}
|
||||
|
||||
// registerControllers 注册各模块控制器
|
||||
//
|
||||
// 随实施进度追加
|
||||
func registerControllers(s *ghttp.Server) {
|
||||
// —— auth 认证域 ——
|
||||
Bind(s, new(controller.CAuth))
|
||||
|
||||
// —— index 个人中心 ——
|
||||
Bind(s, new(controller.CIndex))
|
||||
|
||||
// —— system 域 ——
|
||||
Bind(s, new(controller.CUser))
|
||||
Bind(s, new(controller.CRole))
|
||||
Bind(s, new(controller.CMenu))
|
||||
Bind(s, new(controller.CDept))
|
||||
Bind(s, new(controller.CLevel))
|
||||
Bind(s, new(controller.CPosition))
|
||||
Bind(s, new(controller.CTenant))
|
||||
|
||||
// —— data 域 ——
|
||||
Bind(s, new(controller.CConfig))
|
||||
Bind(s, new(controller.CConfigItem))
|
||||
Bind(s, new(controller.CParam))
|
||||
Bind(s, new(controller.CDict))
|
||||
Bind(s, new(controller.CDictItem))
|
||||
Bind(s, new(controller.CNotice))
|
||||
Bind(s, new(controller.CCity))
|
||||
|
||||
// —— content 域 ——
|
||||
Bind(s, new(controller.CArticle))
|
||||
Bind(s, new(controller.CCategory))
|
||||
Bind(s, new(controller.CLink))
|
||||
|
||||
// —— monitor 域 ——
|
||||
Bind(s, new(controller.COperLog))
|
||||
Bind(s, new(controller.CLoginLog))
|
||||
Bind(s, new(controller.CJob))
|
||||
Bind(s, new(controller.CJobLog))
|
||||
Bind(s, new(controller.COnlineUser))
|
||||
Bind(s, new(controller.CServerMonitor))
|
||||
Bind(s, new(controller.CCacheMonitor))
|
||||
|
||||
// —— tool 域 ——
|
||||
Bind(s, new(controller.CFileTemplate))
|
||||
Bind(s, new(controller.CGenerator))
|
||||
Bind(s, new(controller.CUpload))
|
||||
|
||||
// —— tool 域（代码生成器注册示例） ——
|
||||
Bind(s, new(controller.CExample))
|
||||
}
|
||||
Reference in New Issue
Block a user