giris2

Documentation

Index

• Constants
• Variables
• func Addr(addr string, hostConfigs ...host.Configurator) iris.Runner
• func AddrServer(addr string) *http.Server
• func AllocsHandler() iris.Handler
• func BindRestAPIs(g iris.Party, api interface{})
• func BlockHandler() iris.Handler
• func CmdlineHandler() iris.Handler
• func ConcurrentLimit(n int) iris.Handler
• func GoroutineHandler() iris.Handler
• func HeapHandler() iris.Handler
• func HttpHandler2IrisHandler(h http.Handler) iris.Handler
• func IndexHandler() iris.Handler
• func Logger() util.ItfLogger
• func MutexHandler() iris.Handler
• func PProfWrapGroup(party iris.Party)
• func ParseRestFunc2handler(fn any, receivers ...any) iris.Handler
• func ProfileHandler() iris.Handler
• func RPCServer2IrisHandler(s j2rpc.Server) iris.Handler
• func RateLimiter() context.Handler
• func RestJSONError(c iris.Context, args ...interface{})
• func RestJSONSuccess(c iris.Context, vs ...interface{}) error
• func SymbolHandler() iris.Handler
• func ThreadCreateHandler() iris.Handler
• func TraceHandler() iris.Handler
• type AppStart
  • func (a *AppStart) Constructor()
  • func (a *AppStart) RootParty() iris.Party
  • func (a *AppStart) RouteApp() iris.Party
  • func (a *AppStart) Shutdown()
  • func (a *AppStart) StartApp(opt StartOption)
  • func (a *AppStart) Wait()
• type Captcha
  • func (c *Captcha) Captcha() iris.Handler
  • func (c *Captcha) Generate() (arg CaptchaArg, err error)
  • func (c *Captcha) Verify(arg *CaptchaArg) bool
• type CaptchaArg
• type ItfTokenStore
• type JSONResponse
• type JWT
  • func DefaultJWT() *JWT
  • func (j *JWT) AfterLogin(id string) (t *Token)
  • func (j *JWT) Logout(id string)
  • func (j *JWT) New() *JWT
  • func (*JWT) User(ctx iris.Context) interface{}
  • func (j *JWT) Verify(c iris.Context, call func(id string) (user interface{}, err error)) (err error)
• type StartOption
• type Token

Constants

const (
	ErrorTokenMissing     = "禁止访问"
	ErrorTokenMalformed   = "令牌错误"
	ErrorTokenNotValidYet = "令牌不存在"
	ErrorTokenExpired     = "令牌过期"
	ErrorTokenInvalid     = "令牌无效"
)

const (
	JWTToken    = "JWT_TOKEN"
	ContextUser = "CONTEXT_USER"
)

Variables

var App = &AppStart{}

Functions

func Addr

func Addr(addr string, hostConfigs ...host.Configurator) iris.Runner

func AddrServer

func AddrServer(addr string) *http.Server

func AllocsHandler

func AllocsHandler() iris.Handler

AllocsHandler will pass the call from /debug/pprof/allocs to pprof

func BindRestAPIs

func BindRestAPIs(g iris.Party, api interface{})

func BlockHandler

func BlockHandler() iris.Handler

BlockHandler will pass the call from /debug/pprof/block to pprof

func CmdlineHandler

func CmdlineHandler() iris.Handler

CmdlineHandler will pass the call from /debug/pprof/cmdline to pprof

func ConcurrentLimit

func ConcurrentLimit(n int) iris.Handler

func GoroutineHandler

func GoroutineHandler() iris.Handler

GoroutineHandler will pass the call from /debug/pprof/goroutine to pprof

func HeapHandler

func HeapHandler() iris.Handler

HeapHandler will pass the call from /debug/pprof/heap to pprof

func HttpHandler2IrisHandler

func HttpHandler2IrisHandler(h http.Handler) iris.Handler

func IndexHandler

func IndexHandler() iris.Handler

IndexHandler will pass the call from /debug/pprof to pprof

func Logger

func Logger() util.ItfLogger

func MutexHandler

func MutexHandler() iris.Handler

MutexHandler will pass the call from /debug/pprof/mutex to pprof

func PProfWrapGroup

func PProfWrapGroup(party iris.Party)

PProfWrapGroup adds several routes from package `net/http/pprof` to *gin.RouterGroup object

func ParseRestFunc2handler

func ParseRestFunc2handler(fn any, receivers ...any) iris.Handler

ParseRestFunc2handler fn param like those func Handler(c *lhttp.Context,bound any) (any, error) func Handler(c *lhttp.Context,bound any) any func Handler(c *lhttp.Context,bound any) error func Handler(c *lhttp.Context,bound any) func Handler(bound any) (any, error) func Handler(bound any) any func Handler(bound any) error func Handler(bound any) func Handler() (any, error) func Handler() any func Handler() error func Handler()

func ProfileHandler

func ProfileHandler() iris.Handler

ProfileHandler will pass the call from /debug/pprof/profile to pprof

func RPCServer2IrisHandler

func RPCServer2IrisHandler(s j2rpc.Server) iris.Handler

func RateLimiter

func RateLimiter() context.Handler

func RestJSONError

func RestJSONError(c iris.Context, args ...interface{})

func RestJSONSuccess

func RestJSONSuccess(c iris.Context, vs ...interface{}) error

func SymbolHandler

func SymbolHandler() iris.Handler

SymbolHandler will pass the call from /debug/pprof/symbol to pprof

func ThreadCreateHandler

func ThreadCreateHandler() iris.Handler

ThreadCreateHandler will pass the call from /debug/pprof/threadcreate to pprof

func TraceHandler

func TraceHandler() iris.Handler

TraceHandler will pass the call from /debug/pprof/trace to pprof

Types

type AppStart

type AppStart struct {
	IrisApp   *iris.Application
	WebLogger *midLogger
	Captcha   *Captcha
	RPC       j2rpc.Server
	// contains filtered or unexported fields
}

func (*AppStart) Constructor

func (a *AppStart) Constructor()

func (*AppStart) RootParty

func (a *AppStart) RootParty() iris.Party

func (*AppStart) RouteApp

func (a *AppStart) RouteApp() iris.Party

RouteApp ......

func (*AppStart) Shutdown

func (a *AppStart) Shutdown()

Shutdown ...

func (*AppStart) StartApp

func (a *AppStart) StartApp(opt StartOption)

StartApp ......

func (*AppStart) Wait

func (a *AppStart) Wait()

Wait ...

type Captcha

type Captcha struct {
	Driver base64Captcha.Driver
	Store  base64Captcha.Store
	// contains filtered or unexported fields
}

func (*Captcha) Captcha

func (c *Captcha) Captcha() iris.Handler

Captcha ......

func (*Captcha) Generate

func (c *Captcha) Generate() (arg CaptchaArg, err error)

func (*Captcha) Verify

func (c *Captcha) Verify(arg *CaptchaArg) bool

type CaptchaArg

type CaptchaArg struct {
	ID      string `json:"id"`
	Answer  string `json:"answer,omitempty"`
	Content string `json:"content,omitempty"`
}

type ItfTokenStore

type ItfTokenStore interface {
	SetToken(key string, t *Token)
	GetToken(key string) (t *Token, has bool)
	DelToken(key string)
	ClearExpiredToken()
}

type JSONResponse

type JSONResponse struct {
	Code int         `json:"code"`
	Msg  string      `json:"msg,omitempty"`
	Data interface{} `json:"data,omitempty"`
}

JSONResponse ...

type JWT

type JWT struct {
	Expire int64
	Store  ItfTokenStore
	// contains filtered or unexported fields
}

JWT is middleware for the RPC web framework that provides JWT authentication.

func DefaultJWT

func DefaultJWT() *JWT

func (*JWT) AfterLogin

func (j *JWT) AfterLogin(id string) (t *Token)

AfterLogin ...

func (*JWT) Logout

func (j *JWT) Logout(id string)

Logout ...

func (*JWT) New

func (j *JWT) New() *JWT

New ...

func (*JWT) User

func (*JWT) User(ctx iris.Context) interface{}

func (*JWT) Verify

func (j *JWT) Verify(c iris.Context, call func(id string) (user interface{}, err error)) (err error)

Verify verifies the token and returns the user ID if the token is valid.

type StartOption

type StartOption struct {
	PORT  string
	PPROF string
}

type Token

type Token struct {
	ID        string `json:"id,omitempty"`
	ExpiresAt int64  `json:"expires_at,omitempty"`
	Token     string `json:"token,omitempty"`
}