SpringGin

README

spring-gin

[仅发布] 该项目仅为最终发布，开发请关注 go-spring 项目。

封装 github.com/gin-gonic/gin 实现的 Web 框架。

• 创建 Web 容器
  • NewContainer
• 适配 gin 框架
  • Handler
  • Filter
  • GinContext
  • WebContext

创建 Web 容器

NewContainer

创建 gin 实现的 WebContainer。

func NewContainer(config SpringWeb.ContainerConfig) *Container {}

适配 gin 框架

Handler

适配 gin 形式的处理函数。

func Handler(fn gin.HandlerFunc) SpringWeb.Handler {}

Filter

适配 gin 形式的中间件函数。

func Filter(fn gin.HandlerFunc) SpringWeb.Filter {}

GinContext

将 SpringWeb.WebContext 转换为 *gin.Context。

func GinContext(webCtx SpringWeb.WebContext) *gin.Context {}

WebContext

将 *gin.Context 转换为 SpringWeb.WebContext。

func WebContext(ginCtx *gin.Context) SpringWeb.WebContext {}

Documentation

Overview

Package SpringGin 封装 github.com/gin-gonic/gin 实现的 Web 框架

Index

• func Filter(fn gin.HandlerFunc) web.Filter
• func GinContext(c web.Context) *gin.Context
• func Handler(fn gin.HandlerFunc) web.Handler
• func New(config web.ServerConfig) web.Server
• func WebContext(c *gin.Context) web.Context
• type Context
  • func (ctx *Context) NativeContext() interface{}
  • func (ctx *Context) PathParam(name string) string
  • func (ctx *Context) PathParamNames() []string
  • func (ctx *Context) PathParamValues() []string
  • func (ctx *Context) SSEvent(name string, message interface{})
• type Response
  • func (resp *Response) Get() http.ResponseWriter
  • func (resp *Response) Set(w http.ResponseWriter)

Functions

func Filter

func Filter(fn gin.HandlerFunc) web.Filter

Filter Web Gin 中间件适配器

func GinContext

func GinContext(c web.Context) *gin.Context

GinContext 将 web.Context 转换为 *gin.Context

func Handler

func Handler(fn gin.HandlerFunc) web.Handler

Handler 适配 gin 形式的处理函数

func New

func New(config web.ServerConfig) web.Server

New 创建 gin 实现的 web 服务器

func WebContext

func WebContext(c *gin.Context) web.Context

WebContext 将 *gin.Context 转换为 web.Context

Types

type Context

type Context struct {
	*web.BaseContext
	// contains filtered or unexported fields
}

Context 适配 gin 的 Web 上下文

func (*Context) NativeContext

func (ctx *Context) NativeContext() interface{}

NativeContext 返回封装的底层上下文对象

func (*Context) PathParam

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

PathParam returns path parameter by name.

func (*Context) PathParamNames

func (ctx *Context) PathParamNames() []string

PathParamNames returns path parameter names.

func (*Context) PathParamValues

func (ctx *Context) PathParamValues() []string

PathParamValues returns path parameter values.

func (*Context) SSEvent

func (ctx *Context) SSEvent(name string, message interface{})

SSEvent writes a Server-Sent Event into the body stream.

type Response

type Response struct {
	gin.ResponseWriter
}

func (*Response) Get

func (resp *Response) Get() http.ResponseWriter

func (*Response) Set

func (resp *Response) Set(w http.ResponseWriter)