core

package
v0.0.0-...-8ccda10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 15, 2026 License: MIT Imports: 22 Imported by: 0

Documentation

Overview

Package core 提供 tingo 的运行时内核。

设计原则：

  1. 零成本抽象 —— 类型定义零拷贝，指针转换是编译期 no-op。
  2. 零额外分配 —— 不在请求路径上包装、不逃逸、不反射。
  3. 注册期展开 —— 多应用/中间件在启动时全部展开进路由树。

Package core 提供 tingo 的运行时内核。

设计原则：

  1. 零成本抽象 —— 类型定义零拷贝，指针转换是编译期 no-op。
  2. 零额外分配 —— 不在请求路径上包装、不逃逸、不反射。
  3. 注册期展开 —— 多应用/中间件在启动时全部展开进路由树。

driver 提供类型安全的驱动注册和实例管理。

Index

Constants

This section is empty.

Variables

View Source 
var AppConfigProvider func(name string, base AppConfig) AppConfig

AppConfigProvider 由上层（如 frame/t）注入，用于根据框架配置动态解析每个应用的 AppConfig（多应用路由：default_app/app_map/domain_bind/deny_app）。 接收应用名与注册期的基础配置，返回最终生效的配置。在引擎 Boot 阶段（配置已加载）调用。 未注入则直接使用注册期设定的 AppConfig。

View Source 
var ErrNotHijackable = errors.New("tingo: response writer does not support hijacking")

ErrNotHijackable 底层 ResponseWriter 不支持连接接管。

Functions

func Apps 

func Apps(r Router, cfg *AppConfig, apps ...Application)

Apps 注册一组应用到路由。 Deprecated: 使用 MustConfigureApplication。

func Bind 

func Bind[T any](c *Container, factory func(*Container) (T, error))

Bind 将类型 T 绑定到一个懒加载单例工厂。 

core.Bind(c, func(c *core.Container) (*Repo, error) {
    return NewRepo(core.MustResolve[*DB](c)), nil
})

func BindFrameworkApp 

func BindFrameworkApp(c *Ctx, app *App)

BindFrameworkApp 将请求绑定到处理它的框架 App。由 HTTP 适配器在管线首部调用。

func BindInterface 

func BindInterface[I any, T any](c *Container, factory func(*Container) (T, error))

BindInterface 将接口类型 I 绑定到返回 T 的工厂。调用方通常用具体类型构造并断言实现 I。 

core.BindInterface[Repository, *MySQLRepo](c, func(c *core.Container) (*MySQLRepo, error) {
    return &MySQLRepo{}, nil
})

之后即可 core.Resolve[Repository](c) 取到 *MySQLRepo（按接口 I 作为键）。 工厂返回值若不实现 I 会返回错误。

func BindNamed 

func BindNamed[T any](c *Container, name string, factory func(*Container) (T, error))

BindNamed 按名称绑定类型 T 的懒加载单例工厂，与无名称绑定相互独立。 

core.BindNamed[*Cache](c, "redis", func(c *core.Container) (*Cache, error) { ... })
v := core.MustResolveNamed[*Cache](c, "redis")

func BindNamedTransient 

func BindNamedTransient[T any](c *Container, name string, factory func(*Container) (T, error))

BindNamedTransient 按名称绑定为瞬时服务。

func BindNamedValue 

func BindNamedValue[T any](c *Container, name string, v T)

BindNamedValue 按名称直接绑定一个已构造的实例。

func BindTransient 

func BindTransient[T any](c *Container, factory func(*Container) (T, error))

BindTransient 绑定为瞬时服务，每次 Resolve 都重新构造。

func BindValue 

func BindValue[T any](c *Container, v T)

BindValue 直接绑定一个已构造好的实例。

func DefaultApps 

func DefaultApps(r Router, cfg PageConfig, apps ...Application)

DefaultApps 兼容旧写法。 Deprecated: 使用 MustConfigureApplication。

func GinChain 

func GinChain(hs []Handler) gin.HandlersChain

GinChain 批量转换，注册期一次性完成。

func GinOf 

func GinOf(h Handler) gin.HandlerFunc

GinOf 导出的 Handler → gin.HandlerFunc 转换。零成本。

func Has 

func Has[T any](c *Container) bool

Has 判断类型 T 是否已绑定。

func HasNamed 

func HasNamed[T any](c *Container, name string) bool

HasNamed 判断命名服务是否已绑定。

func MustConfigureApplication 

func MustConfigureApplication(r Router, cfg *AppConfig, apps ...Application)

MustConfigureApplication 根据配置注册应用，失败 panic。

func MustConfigureApps 

func MustConfigureApps(r Router, cfg PageConfig, apps ...Application)

MustConfigureApps 根据 tcfg 配置注册应用集。

func MustResolve 

func MustResolve[T any](c *Container) T

MustResolve 解析类型 T，失败时 panic。 适用于启动期装配，此时失败应立即终止进程。

func MustResolveNamed 

func MustResolveNamed[T any](c *Container, name string) T

MustResolveNamed 按名称解析，失败时 panic。

func RegisterApp 

func RegisterApp(name string, app Application)

RegisterApp 注册应用元数据。

func RegisterMeta 

func RegisterMeta(method, fullPath string, meta *RouteMeta)

RegisterMeta 是向默认 App 登记路由元信息的兼容入口。

func ResetApps 

func ResetApps()

ResetApps 清除所有已注册的应用（仅用于测试）。

func ResetMeta 

func ResetMeta()

ResetMeta 清空默认 App 的路由元信息。仅供测试使用。

func Resolve 

func Resolve[T any](c *Container) (T, error)

Resolve 解析类型 T 的实例。

func ResolveNamed 

func ResolveNamed[T any](c *Container, name string) (T, error)

ResolveNamed 按名称解析类型 T 的实例。

func SetResponder 

func SetResponder(r Responder)

SetResponder 替换全局响应协议。应在服务启动前调用。

func ToGin 

func ToGin(c *Ctx) *gin.Context

ToGin 将 *Ctx 转为 *gin.Context。零成本。

func ValidateStruct 

func ValidateStruct(obj any) error

ValidateStruct 使用默认 tvalid 校验器校验结构体的 valid tag。 如果结构体没有任何 valid tag，则直接返回 nil（跳过校验，零开销）。 这是 BindAllAndValidate 的底层实现，也可在自定义绑定场景中独立调用。

Types

type App 

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

App 是实例级框架内核。每个 App 拥有独立容器和服务实例。

func DefaultApp 

func DefaultApp() *App

DefaultApp 返回兼容旧门面的进程级 App。新项目应显式持有 NewApp 的返回值。

func NewApp 

func NewApp() *App

NewApp 创建一个新的 App 实例。

func (*App) ApplicationNames 

func (a *App) ApplicationNames() []string

ApplicationNames 返回所有已注册应用的名称。

func (*App) Applications 

func (a *App) Applications() []AppInfo

Applications 返回所有已注册应用的信息。

func (*App) Boot 

func (a *App) Boot(ctx context.Context) error

Boot 按依赖拓扑执行全部服务的 Register 和 Boot。

func (*App) ConfigureApplication 

func (a *App) ConfigureApplication(name string, config AppConfig) error

ConfigureApplication 合并应用配置元数据。已注册应用的显式值不会被覆盖。

func (*App) Container 

func (a *App) Container() *Container

Container 返回 App 的容器。

func (*App) HasService 

func (a *App) HasService(name string) bool

HasService 判断指定名称的生命周期服务是否已注册。

func (*App) LookupApplication 

func (a *App) LookupApplication(name string) (AppInfo, bool)

LookupApplication 按名称查找已注册应用。

func (*App) MountApplication 

func (a *App) MountApplication(r Router, app Application, cfg *AppConfig) Router

MountApplication 注册应用到路由。这是路由注册入口。

func (*App) Register 

func (a *App) Register(services ...Service) error

Register 添加服务定义。实际 Register 钩子在 Boot 时按依赖顺序执行。

func (*App) RegisterApplication 

func (a *App) RegisterApplication(name string, app Application)

RegisterApplication 登记一个应用（仅存储元数据，不注册路由）。

func (*App) RegisterRouteMeta 

func (a *App) RegisterRouteMeta(method, fullPath string, meta *RouteMeta)

RegisterRouteMeta 在当前 App 的注册期登记路由元信息。

func (*App) Shutdown 

func (a *App) Shutdown(ctx context.Context) error

Shutdown 按 Boot 的逆序释放服务和容器资源，重复调用无副作用。

func (*App) Start 

func (a *App) Start() error

Start 将已完成 Boot 的 App 标记为运行中。 HTTP、CLI 或其他宿主应在开始对外提供服务前调用。

func (*App) State 

func (a *App) State() State

State 返回当前生命周期阶段。

type AppBooter 

type AppBooter interface {
	Boot() error
}

AppBooter 可选接口：应用实现它可在启动时执行初始化。

type AppConfig 

type AppConfig struct {
	Path       string
	Prefix     string
	Domain     string // 域名绑定（可选）
	Disabled   bool   // 是否禁用
	Priority   int    // 优先级（越大越优先注册）
	Default    bool   // 是否为默认应用
	Middleware []Handler
}

AppConfig 是每个应用的配置。

type AppConfigurer 

type AppConfigurer interface {
	Config() AppConfig
}

AppConfigurer 可选接口：应用实现它来提供配置。

type AppInfo 

type AppInfo struct {
	App    Application
	Config *AppConfig
	Name   string
}

AppInfo 包含已注册应用的信息。

type AppMiddlewarer 

type AppMiddlewarer interface {
	Middlewares() []Handler
}

AppMiddlewarer 可选接口：应用实现它来声明专属中间件。

type Application 

type Application interface {
	Routes(r Router)
}

Application 代表一个可挂载的应用。

type Container 

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

Container 是类型安全的服务容器。

使用 Go 类型本身作为键，解析结果无需类型断言，且错误在编译期即可发现。

服务默认为单例且懒加载，首次 Resolve 时构造，之后复用。

providers 通过 atomic.Pointer 发布只读快照：绑定只在启动期发生， 运行期 Resolve 读取快照免加锁。

func Default 

func Default() *Container

Default 返回默认 App 所属的容器。

func NewContainer 

func NewContainer() *Container

NewContainer 创建一个空容器。

func (*Container) Close 

func (c *Container) Close() error

Close 按单例构造的逆序释放实现 Close() error 的服务。

func (*Container) NewScope 

func (c *Container) NewScope() *Container

NewScope 创建继承当前容器绑定的子作用域。子作用域可覆盖父级服务。

func (*Container) Reset 

func (c *Container) Reset()

Reset 清空容器。仅供测试使用。

func (*Container) ResolveUntyped 

func (c *Container) ResolveUntyped(t reflect.Type) (any, error)

ResolveUntyped 按反射类型从容器解析实例。

它复用与 Resolve[T] 完全相同的绑定查找与单例缓存逻辑，区别在于键由 调用方以 reflect.Type 形式提供，从而支持在反射驱动的装配（如控制器字段注入） 中解析任意类型，无需调用方提供编译期泛型参数。

func (*Container) String 

func (c *Container) String() string

String 返回容器中已绑定服务的概览，便于调试。

type Ctx 

type Ctx gin.Context

Ctx 是 tingo 的请求上下文。

通过类型定义（而非结构体嵌入）实现零拷贝，指针转换不产生任何堆分配， 也不增加一层间接寻址。

注意：Ctx 只能通过转换获得，不要直接 new(Ctx)。

func FromGin 

func FromGin(c *gin.Context) *Ctx

FromGin 将 *gin.Context 转为 *Ctx。零成本。

func (*Ctx) Abort 

func (c *Ctx) Abort()

Abort 终止后续 handler 的执行。

func (*Ctx) AbortWithStatus 

func (c *Ctx) AbortWithStatus(code int)

AbortWithStatus 终止链并写出状态码。

func (*Ctx) Action 

func (c *Ctx) Action() string

Action 返回当前请求命中的方法名。

func (*Ctx) App 

func (c *Ctx) App() string

App 返回当前请求归属的应用名，如 admin、api。

func (*Ctx) Bind 

func (c *Ctx) Bind(obj any) error

Bind 根据 Content-Type 自动绑定并校验请求数据。

func (*Ctx) BindAll 

func (c *Ctx) BindAll(obj any) error

BindAll 依次绑定 uri、query、body，后者覆盖前者。

绑定顺序与语义：

  1. uri —— 仅在存在路由参数时执行；
  2. query —— 始终执行。即便 query 为空也不能跳过， 因为 `form:"page,default=1"` 这类默认值依赖此步生效；
  3. body —— 仅在确有请求体时执行，空体不视为错误。

校验（binding tag）在最后一步统一触发， 以保证前面步骤填入的默认值也参与校验。

func (*Ctx) BindAllAndValidate 

func (c *Ctx) BindAllAndValidate(obj any) error

BindAllAndValidate 依次绑定 uri、query、body，然后自动校验 valid tag。

绑定完成后会自动调用 tvalid.CheckStruct(obj) 对 valid tag 进行校验。 如果绑定失败返回绑定错误，如果校验失败返回 tvalid.Errors。

用法： 

type LoginReq struct {
    Name string `form:"name" valid:"required|len:3,20" label:"用户名"`
    Age  int    `form:"age"  valid:"min:1|max:120"`
}

var req LoginReq
if err := c.BindAllAndValidate(&req); err != nil {
    // 绑定或校验失败
    c.JSON(400, gin.H{"error": err.Error()})
    return
}

func (*Ctx) BindHeader 

func (c *Ctx) BindHeader(obj any) error

BindHeader 绑定请求头。

func (*Ctx) BindJSON 

func (c *Ctx) BindJSON(obj any) error

BindJSON 绑定 JSON 请求体。

func (*Ctx) BindQuery 

func (c *Ctx) BindQuery(obj any) error

BindQuery 绑定 URL query。

func (*Ctx) BindURI 

func (c *Ctx) BindURI(obj any) error

BindURI 绑定路由参数。

func (*Ctx) Body 

func (c *Ctx) Body() ([]byte, error)

Body 读取并返回请求体原始字节。可重复调用：首次读取后会将内容 还原回 Request.Body，因此后续读取（包括内部的 Bind/ShouldBind） 都能拿到完整数据，不会返回空。

func (*Ctx) ContentType 

func (c *Ctx) ContentType() string

ContentType 返回请求的 Content-Type（已剥离参数）。

func (*Ctx) Controller 

func (c *Ctx) Controller() string

Controller 返回当前请求命中的控制器名。

func (*Ctx) Cookie 

func (c *Ctx) Cookie(name string) string

Cookie 返回 cookie 值，不存在时返回空串。

func (*Ctx) Data 

func (c *Ctx) Data(code int, contentType string, data []byte)

Data 输出原始字节。

func (*Ctx) Deadline 

func (c *Ctx) Deadline() (time.Time, bool)

Deadline 实现 context.Context。

func (*Ctx) DefaultPost 

func (c *Ctx) DefaultPost(key, def string) string

DefaultPost 返回 POST 表单字段，不存在时返回默认值。

func (*Ctx) DefaultQuery 

func (c *Ctx) DefaultQuery(key, def string) string

DefaultQuery 返回 URL query 参数，不存在时返回默认值。

func (*Ctx) Done 

func (c *Ctx) Done() <-chan struct{}

Done 实现 context.Context。

func (*Ctx) Download 

func (c *Ctx) Download(filepath, filename string)

Download 触发文件下载。

func (*Ctx) Err 

func (c *Ctx) Err() error

Err 实现 context.Context。

func (*Ctx) File 

func (c *Ctx) File(name string) (*multipart.FileHeader, error)

File 返回上传的单个文件。

func (*Ctx) Files 

func (c *Ctx) Files(name string) ([]*multipart.FileHeader, error)

Files 返回上传的多个同名文件。

func (*Ctx) Framework 

func (c *Ctx) Framework() *App

Framework 返回处理当前请求的框架 App；未显式绑定时兼容返回 DefaultApp。

func (*Ctx) FullPath 

func (c *Ctx) FullPath() string

FullPath 返回匹配到的路由模式，如 /user/:id。未匹配时返回空串。

func (*Ctx) G 

func (c *Ctx) G() *gin.Context

G 返回底层上下文对象，零成本。

当需要使用 tingo 尚未封装的原生能力时使用。

func (*Ctx) Get 

func (c *Ctx) Get(key string) (any, bool)

Get 读取请求级键值。

func (*Ctx) GetBool 

func (c *Ctx) GetBool(key string) bool

GetBool 读取 bool 型请求级键值。

func (*Ctx) GetInt 

func (c *Ctx) GetInt(key string) int

GetInt 读取 int 型请求级键值。

func (*Ctx) GetInt64 

func (c *Ctx) GetInt64(key string) int64

GetInt64 读取 int64 型请求级键值。

func (*Ctx) GetString 

func (c *Ctx) GetString(key string) string

GetString 读取字符串型请求级键值。

func (*Ctx) HTML 

func (c *Ctx) HTML(name string, data any)

HTML 渲染模板。

func (*Ctx) Header 

func (c *Ctx) Header(key string) string

Header 返回请求头。

func (*Ctx) Hijack 

func (c *Ctx) Hijack() (net.Conn, error)

Hijack 接管底层连接，用于 WebSocket 等场景。

func (*Ctx) Host 

func (c *Ctx) Host() string

Host 返回请求 Host。

func (*Ctx) IP 

func (c *Ctx) IP() string

IP 返回客户端 IP（经可信代理链解析）。

func (*Ctx) IsAborted 

func (c *Ctx) IsAborted() bool

IsAborted 返回当前链是否已被终止。

func (*Ctx) IsAjax 

func (c *Ctx) IsAjax() bool

IsAjax 判断是否为 XMLHttpRequest 请求。

func (*Ctx) JSON 

func (c *Ctx) JSON(v any)

JSON 输出 JSON，状态码 200。

func (*Ctx) JSONStatus 

func (c *Ctx) JSONStatus(code int, v any)

JSONStatus 以指定状态码输出 JSON。

func (*Ctx) Method 

func (c *Ctx) Method() string

Method 返回请求方法，如 GET、POST。

func (*Ctx) MustGet 

func (c *Ctx) MustGet(key string) any

MustGet 读取请求级键值，不存在时 panic。

func (*Ctx) Next 

func (c *Ctx) Next()

Next 执行链中后续的 handler。仅在中间件中使用。

func (*Ctx) NoContent 

func (c *Ctx) NoContent()

NoContent 输出 204。

func (*Ctx) Param 

func (c *Ctx) Param(key string) string

Param 返回路由参数，如 /user/:id 中的 id。

func (*Ctx) Path 

func (c *Ctx) Path() string

Path 返回请求路径（不含 query）。

func (*Ctx) Post 

func (c *Ctx) Post(key string) string

Post 返回 POST 表单字段。

func (*Ctx) PostArray 

func (c *Ctx) PostArray(key string) []string

PostArray 返回同名的多个 POST 表单字段。

func (*Ctx) PostMap 

func (c *Ctx) PostMap(key string) map[string]string

PostMap 返回形如 key[sub]=v 的 POST 表单集合。

func (*Ctx) Query 

func (c *Ctx) Query(key string) string

Query 返回 URL query 参数。

func (*Ctx) QueryArray 

func (c *Ctx) QueryArray(key string) []string

QueryArray 返回同名的多个 query 参数。

func (*Ctx) QueryMap 

func (c *Ctx) QueryMap(key string) map[string]string

QueryMap 返回形如 key[sub]=v 的 query 参数集合。

func (*Ctx) RawQuery 

func (c *Ctx) RawQuery() string

RawQuery 返回原始 query 字符串。

func (*Ctx) Redirect 

func (c *Ctx) Redirect(code int, location string)

Redirect 重定向。

func (*Ctx) Referer 

func (c *Ctx) Referer() string

Referer 返回 Referer 头。

func (*Ctx) RemoteIP 

func (c *Ctx) RemoteIP() string

RemoteIP 返回直连对端 IP。

func (*Ctx) Req 

func (c *Ctx) Req() *http.Request

Req 返回原始 *http.Request。

func (*Ctx) RequestID 

func (c *Ctx) RequestID() string

RequestID 返回请求追踪 ID。

func (*Ctx) Res 

func (c *Ctx) Res() gin.ResponseWriter

Res 返回响应写入器。

func (*Ctx) Route 

func (c *Ctx) Route() *RouteMeta

Route 返回当前请求的路由归属信息。 未启用元信息绑定或路由未登记时返回空的 RouteMeta，不会返回 nil。

本方法零分配：FullPath 由 gin 在路由匹配时已填好， 拼接键使用栈上小字符串，map 查找不产生逃逸。

func (*Ctx) SSE 

func (c *Ctx) SSE(event string, data any)

SSE 推送一条 Server-Sent Event。

func (*Ctx) SaveFile 

func (c *Ctx) SaveFile(f *multipart.FileHeader, dst string) error

SaveFile 保存上传文件到指定路径。

func (*Ctx) Scheme 

func (c *Ctx) Scheme() string

Scheme 返回请求协议 http 或 https。

func (*Ctx) ServeFile 

func (c *Ctx) ServeFile(filepath string)

ServeFile 直接输出文件内容。

func (*Ctx) Set 

func (c *Ctx) Set(key string, val any)

Set 写入请求级键值。

func (*Ctx) SetCookie 

func (c *Ctx) SetCookie(name, value string, maxAge int, path, domain string, secure, httpOnly bool) *Ctx

SetCookie 设置 cookie。

func (*Ctx) SetHeader 

func (c *Ctx) SetHeader(key, val string) *Ctx

SetHeader 设置响应头。

func (*Ctx) SetRequestID 

func (c *Ctx) SetRequestID(id string)

SetRequestID 设置请求追踪 ID。

func (*Ctx) Status 

func (c *Ctx) Status(code int) *Ctx

Status 设置响应状态码。

func (*Ctx) Stream 

func (c *Ctx) Stream(step func(w io.Writer) bool) bool

Stream 以流式方式写出响应。step 返回 false 时结束。

func (*Ctx) String 

func (c *Ctx) String(format string, values ...any)

String 输出纯文本，状态码 200。

func (*Ctx) StringStatus 

func (c *Ctx) StringStatus(code int, format string, values ...any)

StringStatus 以指定状态码输出纯文本。

func (*Ctx) URL 

func (c *Ctx) URL() *url.URL

URL 返回请求 URL。

func (*Ctx) UserAgent 

func (c *Ctx) UserAgent() string

UserAgent 返回 User-Agent 头。

func (*Ctx) Value 

func (c *Ctx) Value(key any) any

Value 实现 context.Context。

func (*Ctx) XML 

func (c *Ctx) XML(v any)

XML 输出 XML，状态码 200。

func (*Ctx) YAML 

func (c *Ctx) YAML(v any)

YAML 输出 YAML，状态码 200。

type CtxKey 

type CtxKey[T any] struct {
	// contains filtered or unexported fields
}

CtxKey 是类型安全的请求级键。

用法： 

var UserKey = core.NewCtxKey[*model.User]("auth.user")
UserKey.Set(c, u)
u, ok := UserKey.Get(c)

func NewCtxKey 

func NewCtxKey[T any](name string) CtxKey[T]

NewCtxKey 创建一个类型安全的请求级键。

func (CtxKey[T]) Get 

func (k CtxKey[T]) Get(c *Ctx) (T, bool)

Get 读取值。第二个返回值表示是否存在且类型匹配。

func (CtxKey[T]) Must 

func (k CtxKey[T]) Must(c *Ctx) T

Must 读取值，不存在时返回零值。

func (CtxKey[T]) Name 

func (k CtxKey[T]) Name() string

Name 返回键名。

func (CtxKey[T]) Set 

func (k CtxKey[T]) Set(c *Ctx, v T)

Set 写入值。

type DriverFactory 

type DriverFactory[Config, Driver any] func(context.Context, Config) (Driver, error)

DriverFactory 是创建驱动的工厂函数。

type DriverManager 

type DriverManager[Config, Driver any] struct {
	// contains filtered or unexported fields
}

DriverManager 按连接名惰性创建并缓存驱动实例。

func NewDriverManager 

func NewDriverManager[Config, Driver any](cfg DriverManagerConfig[Config, Driver]) *DriverManager[Config, Driver]

NewDriverManager 创建一个驱动管理器。

func (*DriverManager[Config, Driver]) Close 

func (m *DriverManager[Config, Driver]) Close(ctx context.Context) error

Close 关闭所有已创建的驱动实例（逆序关闭）。

func (*DriverManager[Config, Driver]) Connection 

func (m *DriverManager[Config, Driver]) Connection(ctx context.Context, names ...string) (Driver, error)

Connection 获取指定连接名的驱动实例。未指定则使用默认连接。

func (*DriverManager[Config, Driver]) Forget 

func (m *DriverManager[Config, Driver]) Forget(ctx context.Context, names ...string) error

Forget 释放并关闭指定连接名的驱动实例。

type DriverManagerConfig 

type DriverManagerConfig[Config, Driver any] struct {
	Registry *DriverRegistry[Config, Driver]
	Default  func() string
	Resolve  func(name string) (Config, error)
	Type     func(Config) string
	Close    func(context.Context, Driver) error
}

DriverManagerConfig 是 DriverManager 的配置项。

type DriverRegistry 

type DriverRegistry[Config, Driver any] struct {
	// contains filtered or unexported fields
}

DriverRegistry 是泛型驱动注册表，按名称管理工厂函数。

func NewDriverRegistry 

func NewDriverRegistry[Config, Driver any]() *DriverRegistry[Config, Driver]

NewDriverRegistry 创建一个新的驱动注册表。

func (*DriverRegistry[Config, Driver]) Factory 

func (r *DriverRegistry[Config, Driver]) Factory(name string) (DriverFactory[Config, Driver], bool)

Factory 按名称获取驱动工厂。

func (*DriverRegistry[Config, Driver]) Names 

func (r *DriverRegistry[Config, Driver]) Names() []string

Names 返回所有已注册的驱动名称，排序后返回。

func (*DriverRegistry[Config, Driver]) Register 

func (r *DriverRegistry[Config, Driver]) Register(name string, factory DriverFactory[Config, Driver]) error

Register 注册一个驱动工厂。名称不区分大小写。

type Handler 

type Handler func(*Ctx)

Handler 是 tingo 的原生 handler，与 gin.HandlerFunc 内存布局一致。 由于 Ctx 与 gin.Context 布局相同，Handler 与 gin.HandlerFunc 之间 可以通过 unsafe-free 的函数值转换互转，无运行时开销。

func Adapt 

func Adapt(h any) Handler

Adapt 将多种 handler 签名统一适配为 Handler。

支持的签名（按性能从高到低排列，前三种为零反射快路径）： 

func(*Ctx)                            原生，零开销
func(*gin.Context)                   gin 原生，零开销
func(*Ctx) error                     带错误，零开销
func(*Ctx) (T, error)                泛型返回，需用 W 包装
func(ctx context.Context, req *Req) (*Res, error)   反射适配

反射仅发生在注册期，运行时通过预编译的闭包执行， 每请求成本为一次 sync.Pool 取用 + 反射 Call。 对性能敏感的路由请使用前三种签名或 codegen 生成的适配器。

func HandlerOf 

func HandlerOf(h gin.HandlerFunc) Handler

HandlerOf 将 gin.HandlerFunc 转为 Handler，用于复用 gin 生态中间件。零成本。

func W 

func W[Req any, Res any](f func(*Ctx, *Req) (Res, error)) Handler

W 将业务方法包装为 Handler，全程零反射。 

r.GET("/users", core.W(ctrl.List))

其中 ctrl.List 的签名为： 

func(c *Ctx, req *ListReq) (*ListRes, error)

Req 结构体通过 sync.Pool 复用，绑定后清零，实现每请求零分配。

func WN 

func WN[Res any](f func(*Ctx) (Res, error)) Handler

WN 包装无入参的业务方法。 

func(c *Ctx) (Res, error)

type HandlerE 

type HandlerE func(*Ctx) error

HandlerE 是可返回错误的 handler，错误由统一的错误中间件处理。

type Middleware 

type Middleware = Handler

Middleware 是中间件类型，等同于 Handler。

type PageConfig 

type PageConfig interface {
	Path() string
	Prefix() string
	Middleware() []Handler
}

PageConfig 是从配置文件中读取单应用页面配置的接口。

type Responder 

type Responder interface {
	// Reply 在 handler 成功返回时调用。data 可能为 nil。
	Reply(c *Ctx, data any)
	// Fail 在 handler 返回错误时调用。
	Fail(c *Ctx, err error)
}

Responder 决定 handler 返回值如何写入响应。 框架提供默认实现，业务可全局替换以定制响应格式。

func CurrentResponder 

func CurrentResponder() Responder

CurrentResponder 返回当前响应协议。

type RouteMeta 

type RouteMeta struct {
	// App 是所属应用名。
	App string
	// Controller 是控制器名。
	Controller string
	// Action 是动作名。
	Action string
}

RouteMeta 描述一条路由的静态归属信息。

该结构在「注册期」构造一次并被同一路由的所有请求共享， 它是只读的，可安全并发访问。

type Router 

type Router interface {
	Use(handler ...Handler) Router
	// UseOrdered 按优先级升序追加中间件（数值越小越先执行，同级保序）。
	UseOrdered(mws ...WeightedMiddleware) Router
	Group(relativePath string, fn func(Router), mws ...Handler) Router
	// Module 创建按模块名隔离的子路由组。
	// 自动套 /{module} 前缀并与外层中间件隔离，模块内再 Group 时基于该前缀展开。
	Module(name string, fn func(Router), mws ...Handler) Router
	GET(path string, handler any) Router
	POST(path string, handler any) Router
	PUT(path string, handler any) Router
	DELETE(path string, handler any) Router
	PATCH(path string, handler any) Router
	HEAD(path string, handler any) Router
	OPTIONS(path string, handler any) Router
	Any(path string, handler any) Router
	Controller(path string, controller any) Router
	Resource(path string, controller any) Router
}

Router 定义了路由注册接口。

type Service 

type Service interface {
	Name() string
	DependsOn() []string
	Register(*App) error
	Boot(context.Context, *App) error
	Shutdown(context.Context) error
}

Service 是框架能力的生命周期单元。 Register 仅声明容器绑定；Boot 才建立连接、启动 goroutine 或挂载资源。

type State 

type State uint8

State 描述框架 App 的生命周期阶段。 

const (
	StateCreated State = iota
	StateRegistering
	StateRegistered
	StateBooting
	StateBooted
	StateRunning
	StateStopping
	StateStopped
	StateFailed
)

func (State) String 

func (s State) String() string

type WeightedMiddleware 

type WeightedMiddleware struct {
	H        Handler
	Priority int
}

WeightedMiddleware 是带优先级的中间件。

数值越小越先执行（全局 -> 模块 -> 控制器 -> 动作 由小到大注册）。 同级按注册顺序。通过 Router.UseOrdered 注册。

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.