types

Documentation

Index

• type ApiVersion
  • func (av ApiVersion) Verify() bool
• type BodyProperty
  • func (bp BodyProperty) Verify() bool
• type DayStatRequest
  • func (in DayStatRequest) StatAtRange() ([]time.Time, error)
  • func (in DayStatRequest) StatAtRangeOrLastWeek() []time.Time
  • func (in DayStatRequest) StatDayRange() ([]uint, error)
  • func (in DayStatRequest) StatDayRangeOrLastWeek() []uint
• type HttpContext
  • func MustParseHttpContext(ctx context.Context) (*HttpContext, error)
  • func NewHttpContext() *HttpContext
  • func ParserHttpContext(ctx context.Context) (*HttpContext, error)
  • func (sc *HttpContext) Deadline() (deadline time.Time, ok bool)
  • func (sc *HttpContext) Done() <-chan struct{}
  • func (sc *HttpContext) Err() error
  • func (sc *HttpContext) GetUser() *User
  • func (sc *HttpContext) HasRole(roles []IRole) bool
  • func (sc *HttpContext) IsRole(role IRole) bool
  • func (sc *HttpContext) Logger() xlog.XLogger
  • func (sc *HttpContext) Set(key string, value interface{})
  • func (sc *HttpContext) StorageTo(ctx *gin.Context) bool
  • func (sc *HttpContext) TraceId() string
  • func (sc *HttpContext) User() *User
  • func (sc *HttpContext) Value(key interface{}) interface{}
• type IRole
• type ResponseModel
• type SearchRequest
  • func (sr SearchRequest) GetLimit() int64
• type ToRole
• type User
  • func (u *User) GetAccount() string
  • func (u *User) GetExtend() map[string]string
  • func (u *User) GetExtendValue(field string) string
  • func (u *User) GetID() uint
  • func (u *User) GetIP() string
  • func (u *User) GetName() string
  • func (u *User) GetRoles() []IRole
  • func (u *User) Is(role IRole, others ...IRole) bool

Types

type ApiVersion

type ApiVersion string

ApiVersion 版本号

func (ApiVersion) Verify

func (av ApiVersion) Verify() bool

type BodyProperty

type BodyProperty string

BodyProperty 响应正文属性

const (
	BodyPropertyRaw  BodyProperty = "raw"
	BodyPropertyText BodyProperty = "text"
	BodyPropertyHtml BodyProperty = "html"
	BodyPropertyFull BodyProperty = "full"
)

func (BodyProperty) Verify

func (bp BodyProperty) Verify() bool

type DayStatRequest

type DayStatRequest struct {
	SearchRequest

	StartDay string `form:"startDay" format:"2006-01-02"`
	EndDay   string `form:"endDay" format:"2006-01-02"`
}

DayStatRequest 通用日统计请求。都为空时，默认获取当周数据

func (DayStatRequest) StatAtRange

func (in DayStatRequest) StatAtRange() ([]time.Time, error)

func (DayStatRequest) StatAtRangeOrLastWeek

func (in DayStatRequest) StatAtRangeOrLastWeek() []time.Time

func (DayStatRequest) StatDayRange

func (in DayStatRequest) StatDayRange() ([]uint, error)

func (DayStatRequest) StatDayRangeOrLastWeek

func (in DayStatRequest) StatDayRangeOrLastWeek() []uint

type HttpContext

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

func MustParseHttpContext

func MustParseHttpContext(ctx context.Context) (*HttpContext, error)

MustParseHttpContext 从 gin 上下文中解析自定义上下文

func NewHttpContext

func NewHttpContext() *HttpContext

NewHttpContext 创建自定义上下文

func ParserHttpContext

func ParserHttpContext(ctx context.Context) (*HttpContext, error)

ParserHttpContext 从 gin 上下文中解析自定义上下文 Deprecated. use MustParseHttpContext

func (*HttpContext) Deadline

func (sc *HttpContext) Deadline() (deadline time.Time, ok bool)

func (*HttpContext) Done

func (sc *HttpContext) Done() <-chan struct{}

func (*HttpContext) Err

func (sc *HttpContext) Err() error

func (*HttpContext) GetUser

func (sc *HttpContext) GetUser() *User

func (*HttpContext) HasRole

func (sc *HttpContext) HasRole(roles []IRole) bool

HasRole 判断用户角色

func (*HttpContext) IsRole

func (sc *HttpContext) IsRole(role IRole) bool

IsRole 判断用户角色

func (*HttpContext) Logger

func (sc *HttpContext) Logger() xlog.XLogger

func (*HttpContext) Set

func (sc *HttpContext) Set(key string, value interface{})

Set 设置参数 会根据 value 的类型，自动设置对应属性的值，目前支持： ApiVersion, BodyProperty, types.User, xlog.XLogger

func (*HttpContext) StorageTo

func (sc *HttpContext) StorageTo(ctx *gin.Context) bool

StorageTo 将已变更的数据，存储到 gin 上下文中，继续传输

func (*HttpContext) TraceId

func (sc *HttpContext) TraceId() string

func (*HttpContext) User

func (sc *HttpContext) User() *User

func (*HttpContext) Value

func (sc *HttpContext) Value(key interface{}) interface{}

type IRole

type IRole interface {
	String() string
}

type ResponseModel

type ResponseModel struct {
	ID          uint   `json:"id" copy:"ID"`
	CreatedTime string `json:"createdTime" copy:"createdAt"`
	UpdatedTime string `json:"updatedTime" copy:"updatedAt"`
}

ResponseModel 通用响应基础模型

type SearchRequest

type SearchRequest struct {
	// 数据开始位置
	Start int64 `form:"start"`
	// 返回数据条数
	Limit int64 `form:"limit"`
	// 排序规则：sort=otc_type,-created_at,*custom
	// 以符号开头，可选符号：(+或空 正序）（- 倒序）（* 自定义复杂排序标识关键词）
	Sort string `form:"sort"`
}

SearchRequest 通用搜索请求

func (SearchRequest) GetLimit

func (sr SearchRequest) GetLimit() int64

GetLimit 获得分页数据条数

type ToRole

type ToRole func(role string) (IRole, error)

ToRole 转换成角色 IRole

type User

type User struct {
	ID      uint
	Account string
	Name    string
	Roles   []IRole

	IP     string            // 用户登录ID
	Extend map[string]string // 扩展信息
}

User 用户基本信息

func (*User) GetAccount

func (u *User) GetAccount() string

func (*User) GetExtend

func (u *User) GetExtend() map[string]string

func (*User) GetExtendValue

func (u *User) GetExtendValue(field string) string

func (*User) GetID

func (u *User) GetID() uint

func (*User) GetIP

func (u *User) GetIP() string

func (*User) GetName

func (u *User) GetName() string

func (*User) GetRoles

func (u *User) GetRoles() []IRole

func (*User) Is

func (u *User) Is(role IRole, others ...IRole) bool