libgin

README

libgin

Starter for building web, including RESTful, applications using Gin

Documentation

Index

• Constants
• func NewDemoModule() *application.ModuleBuilder
• func NewDevtoolsModule() *application.ModuleBuilder
• func NewMainModule() *application.ModuleBuilder
• type Connector
• type ConnectorRegistration
• type ConnectorRegistry
• type ContentTypeManager
• type Context
• type ContextHolder
  • func BindContext(c *gin.Context) *ContextHolder
  • func GetContextHolder(cc context.Context) (*ContextHolder, error)
  • func (inst *ContextHolder) Context() context.Context
  • func (inst *ContextHolder) GetValue(key any) any
  • func (inst *ContextHolder) GinContext() *gin.Context
  • func (inst *ContextHolder) SetValue(key, value any)
• type Controller
• type ControllerRegistration
• type Group
• type GroupRegistration
• type GroupRegistry
• type Responder
• type ResponderRegistration
• type ResponderRegistry
• type Response
• type Router
• type RouterProxy
• type RouterRegistration
• type RouterRegistry
• type Routing

Constants

const (
	GroupREST   = "rest"
	GroupStatic = "static"
)

定义常用的分组名称

Functions

func NewDemoModule

func NewDemoModule() *application.ModuleBuilder

NewDemoModule 创建模块 [github.com/starter-go/libgin#demo]

func NewDevtoolsModule

func NewDevtoolsModule() *application.ModuleBuilder

NewDevtoolsModule 导出模块 [github.com/starter-go/libgin#devtools]

func NewMainModule

func NewMainModule() *application.ModuleBuilder

NewMainModule 导出模块 github.com/starter-go/libgin

Types

type Connector

type Connector interface {
}

Connector ...

type ConnectorRegistration

type ConnectorRegistration struct {
	Name      string
	Connector Connector
}

ConnectorRegistration ...

type ConnectorRegistry

type ConnectorRegistry interface {
	ListRegistrations() []*ConnectorRegistration
}

ConnectorRegistry ...

type ContentTypeManager

type ContentTypeManager interface {
	FindTypeBySuffix(suffix string) (string, error)
}

ContentTypeManager 是文档类型管理器

type Context

type Context interface {
	GetConnectorByName(name string) (Connector, error)
	GetGroupByName(name string) (Group, error)
	GetRouterByName(name string) (Router, error)
	ListControllersForGroup(groupName string) ([]*ControllerRegistration, error)
}

Context 是 libgin 上下文，它集中管理各种 libgin 资源

type ContextHolder

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

ContextHolder 用来绑定 gin.Context & context.Context

func BindContext

func BindContext(c *gin.Context) *ContextHolder

BindContext 绑定 gin.Context & context.Context

func GetContextHolder

func GetContextHolder(cc context.Context) (*ContextHolder, error)

GetContextHolder 取 ContextHolder

func (*ContextHolder) Context

func (inst *ContextHolder) Context() context.Context

Context ...

func (*ContextHolder) GetValue

func (inst *ContextHolder) GetValue(key any) any

GetValue ...

func (*ContextHolder) GinContext

func (inst *ContextHolder) GinContext() *gin.Context

GinContext 获取绑定的 gin.Context

func (*ContextHolder) SetValue

func (inst *ContextHolder) SetValue(key, value any)

SetValue ...

type Controller

type Controller interface {
	Registration() *ControllerRegistration
}

Controller 表示一个 gin 控制器

type ControllerRegistration

type ControllerRegistration struct {
	Groups []string                   // 分组名称, 如果为空表示默认分组
	Route  func(rp RouterProxy) error // 控制器
}

ControllerRegistration 是控制器注册信息

type Group

type Group interface {
	// Registration( ... ) *GroupRegistration
	Route(r Router) error
}

Group ...

type GroupRegistration

type GroupRegistration struct {
	Enabled bool
	Name    string
	Path    string
	Group   Group
}

GroupRegistration ...

type GroupRegistry

type GroupRegistry interface {
	ListRegistrations() []*GroupRegistration
}

GroupRegistry ...

type Responder

type Responder interface {
	Accept(resp *Response) bool

	Send(resp *Response)
}

Responder 是 REST 响应发送器的接口

type ResponderRegistration

type ResponderRegistration struct {
	Priority  int // 优先级，数值越大，越先处理
	Name      string
	Enabled   bool
	Responder Responder
}

ResponderRegistration 是 Responder 的注册信息

type ResponderRegistry

type ResponderRegistry interface {
	ListRegistrations() []*ResponderRegistration
}

ResponderRegistry 是 Responder 的注册接口

type Response

type Response struct {
	Context   *gin.Context
	Status    int
	Error     error
	Responder string // 用于选择 Responder，它的值为 ResponderRegistration.Name
	Data      any
}

Response 表示一个 REST 响应结果

type Router

type Router interface {
	// Registration(  ) *RouterRegistration
	Engine() *gin.Engine
}

Router ...

type RouterProxy

type RouterProxy interface {
	For(path string) RouterProxy
	Route(r *Routing)
	Handle(method string, path string, h ...gin.HandlerFunc)
	NoMethod(h ...gin.HandlerFunc)
	NoRoute(h ...gin.HandlerFunc)

	GET(path string, h ...gin.HandlerFunc)
	POST(path string, h ...gin.HandlerFunc)
	PUT(path string, h ...gin.HandlerFunc)
	DELETE(path string, h ...gin.HandlerFunc)
}

RouterProxy ...

type RouterRegistration

type RouterRegistration struct {
	Name   string
	Router Router
}

RouterRegistration ...

type RouterRegistry

type RouterRegistry interface {
	ListRegistrations() []*RouterRegistration
}

RouterRegistry ...

type Routing

type Routing struct {
	Method      string
	Path        string
	Priority    int
	NoMethod    bool
	NoRoute     bool
	Middleware  bool
	AsIndexPage bool
	Handlers    []gin.HandlerFunc
}

Routing 表示一条路由记录