Files
EasyGoAdmin_GoFrame_EleVue/internal/router/bind.go
T
2026-10-20 11:37:25 +08:00

129 lines
4.1 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
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()))
}
}