gin

README

gofast-gin

GoFast 框架的 Gin HTTP 引擎驱动插件。

框架核心 go-fast-framework 不再内置 HTTP 引擎，需显式安装并注册本插件（或 gofast-fiber）。

安装

go get github.com/zhoudm1743/gofast-gin@v0.9.0

接入

import (
    gohttp "github.com/zhoudm1743/go-fast-framework/http"
    "github.com/zhoudm1743/go-fast-framework/foundation"
    gofastgin "github.com/zhoudm1743/gofast-gin"
)

app.SetProviders([]foundation.ServiceProvider{
    // ...
    &gohttp.ServiceProvider{},
    &gofastgin.ServiceProvider{},
})

server:
  driver: gin

依赖

• github.com/zhoudm1743/go-fast-framework >= v0.9.0
• github.com/gin-gonic/gin

License

Apache-2.0

Documentation

Index

• func NewRoute(cfg contracts.Config, validator contracts.Validation, ...) (contracts.Route, error)
• type Context
  • func NewContext(c *gin.Context, v contracts.Validation, s contracts.Storage, ...) *Context
  • func (ctx *Context) Abort() error
  • func (ctx *Context) AbortWithCode(code int) error
  • func (ctx *Context) AbortWithJson(code int, obj any) error
  • func (ctx *Context) Bind(obj any) error
  • func (ctx *Context) BodyRaw() []byte
  • func (ctx *Context) ClearCookie(name string)
  • func (ctx *Context) ContentType() string
  • func (ctx *Context) Cookie(name string) string
  • func (ctx *Context) File(key string) (contracts.File, error)
  • func (ctx *Context) Files(key string) ([]contracts.File, error)
  • func (ctx *Context) FormValue(key string) string
  • func (ctx *Context) FullPath() string
  • func (ctx *Context) HTML(code int, name string, data any) error
  • func (ctx *Context) Header(key string) string
  • func (ctx *Context) IP() string
  • func (ctx *Context) JSON(code int, obj any) error
  • func (ctx *Context) Method() string
  • func (ctx *Context) Next() error
  • func (ctx *Context) Param(key string) string
  • func (ctx *Context) Path() string
  • func (ctx *Context) Query(key string, defaultValue ...string) string
  • func (ctx *Context) QueryBool(key string, defaultValue ...bool) bool
  • func (ctx *Context) QueryFloat64(key string, defaultValue ...float64) float64
  • func (ctx *Context) QueryInt(key string, defaultValue ...int) int
  • func (ctx *Context) QueryInt64(key string, defaultValue ...int64) int64
  • func (ctx *Context) Redirect(code int, location string) error
  • func (ctx *Context) Response() contracts.Response
  • func (ctx *Context) SendFile(path string) error
  • func (ctx *Context) SetCookie(name, value string, opts contracts.CookieOptions)
  • func (ctx *Context) SetHeader(key, value string) contracts.Context
  • func (ctx *Context) Status(code int) contracts.Context
  • func (ctx *Context) Storage() contracts.Storage
  • func (ctx *Context) String(code int, s string) error
  • func (ctx *Context) Underlying() any
  • func (ctx *Context) UserAgent() string
  • func (ctx *Context) Value(key string) any
  • func (ctx *Context) WithValue(key string, value any) contracts.Context
  • func (ctx *Context) Write(data []byte) error
• type ServiceProvider
  • func (sp *ServiceProvider) Boot(app foundation.Application) error
  • func (sp *ServiceProvider) Register(app foundation.Application)

Functions

func NewRoute

func NewRoute(cfg contracts.Config, validator contracts.Validation, storage contracts.Storage, log contracts.Log) (contracts.Route, error)

NewRoute 创建基于 Gin 的 HTTP 路由服务实例。

Types

type Context

type Context struct {
	// contains filtered or unexported fields
}

Context 实现 contracts.Context，内部包装 *gin.Context。 应用代码只见 contracts.Context，不感知 Gin。

func NewContext

func NewContext(c *gin.Context, v contracts.Validation, s contracts.Storage, ve contracts.ViewEngine) *Context

NewContext 创建 Gin 上下文包装器。

func (*Context) Abort

func (ctx *Context) Abort() error

func (*Context) AbortWithCode

func (ctx *Context) AbortWithCode(code int) error

func (*Context) AbortWithJson

func (ctx *Context) AbortWithJson(code int, obj any) error

func (*Context) Bind

func (ctx *Context) Bind(obj any) error

Bind 将请求数据填充到 obj（URI → Query → Body），最后统一验证。

1. `uri:"xxx"` → URL 路径参数
2. `query:"xxx"` → Query String
3. `json:"xxx"` → 请求体（仅有 body 时解析）

func (*Context) BodyRaw

func (ctx *Context) BodyRaw() []byte

func (*Context) ClearCookie

func (ctx *Context) ClearCookie(name string)

func (*Context) ContentType

func (ctx *Context) ContentType() string

func (*Context) Cookie

func (ctx *Context) Cookie(name string) string

func (*Context) File

func (ctx *Context) File(key string) (contracts.File, error)

func (*Context) Files

func (ctx *Context) Files(key string) ([]contracts.File, error)

Files 返回 multipart 表单中指定 key 的所有上传文件，兼容单文件和多文件。

func (*Context) FormValue

func (ctx *Context) FormValue(key string) string

func (*Context) FullPath

func (ctx *Context) FullPath() string

func (*Context) HTML

func (ctx *Context) HTML(code int, name string, data any) error

HTML 渲染 HTML 模板并发送响应。 name 为相对于模板目录的路径，例如 "home/index.html"。

func (*Context) Header

func (ctx *Context) Header(key string) string

func (*Context) IP

func (ctx *Context) IP() string

func (*Context) JSON

func (ctx *Context) JSON(code int, obj any) error

func (*Context) Method

func (ctx *Context) Method() string

func (*Context) Next

func (ctx *Context) Next() error

func (*Context) Param

func (ctx *Context) Param(key string) string

func (*Context) Path

func (ctx *Context) Path() string

func (*Context) Query

func (ctx *Context) Query(key string, defaultValue ...string) string

func (*Context) QueryBool

func (ctx *Context) QueryBool(key string, defaultValue ...bool) bool

func (*Context) QueryFloat64

func (ctx *Context) QueryFloat64(key string, defaultValue ...float64) float64

func (*Context) QueryInt

func (ctx *Context) QueryInt(key string, defaultValue ...int) int

func (*Context) QueryInt64

func (ctx *Context) QueryInt64(key string, defaultValue ...int64) int64

func (*Context) Redirect

func (ctx *Context) Redirect(code int, location string) error

Redirect 发送 HTTP 重定向响应。

func (*Context) Response

func (ctx *Context) Response() contracts.Response

func (*Context) SendFile

func (ctx *Context) SendFile(path string) error

SendFile 使用 Gin 发送文件响应。

func (*Context) SetCookie

func (ctx *Context) SetCookie(name, value string, opts contracts.CookieOptions)

func (*Context) SetHeader

func (ctx *Context) SetHeader(key, value string) contracts.Context

func (*Context) Status

func (ctx *Context) Status(code int) contracts.Context

func (*Context) Storage

func (ctx *Context) Storage() contracts.Storage

func (*Context) String

func (ctx *Context) String(code int, s string) error

func (*Context) Underlying

func (ctx *Context) Underlying() any

Underlying 返回底层 *gin.Context，用于 SSE 等高级场景。

func (*Context) UserAgent

func (ctx *Context) UserAgent() string

func (*Context) Value

func (ctx *Context) Value(key string) any

func (*Context) WithValue

func (ctx *Context) WithValue(key string, value any) contracts.Context

func (*Context) Write

func (ctx *Context) Write(data []byte) error

Write 写入原始字节到响应体。

type ServiceProvider

type ServiceProvider struct{}

ServiceProvider Gin HTTP 驱动接入点（可选驱动，需显式加入应用 providers）。

import gofastgin "github.com/zhoudm1743/gofast-gin"
app.SetProviders(append(providers, &gofastgin.ServiceProvider{}))

配置 server.driver: gin

func (*ServiceProvider) Boot

func (sp *ServiceProvider) Boot(app foundation.Application) error

func (*ServiceProvider) Register

func (sp *ServiceProvider) Register(app foundation.Application)