cmfx

README

cmfx

Documentation

Index

• Constants
• func AddProblems(p *server.Problems)
• func Init(cleanup func(), f ...func() error)
• type DateRange
  • func (s *DateRange) UnmarshalQuery(data string) error
• type Limit
  • func (l *Limit) CTXSanitize(ctx *web.Context, v *web.Validation)
  • func (l *Limit) Paging(sql *sqlbuilder.SelectStmt) (count, curr int64, err error)
• type Text

Constants

const (
	BadRequest              = "40000"
	BadRequestInvalidParam  = "40001"
	BadRequestInvalidQuery  = "40002"
	BadRequestInvalidHeader = "40003"
	BadRequestInvalidBody   = "40004"
)

定义可用的错误代码

const (
	Unauthorized                   = "40100"
	UnauthorizedInvalidState       = "40101"
	UnauthorizedInvalidToken       = "40102"
	UnauthorizedInvalidPassword    = "40103"
	UnauthorizedInvalidAccount     = "40104"
	UnauthorizedNeedChangePassword = "40105"
)

401

const (
	Forbidden                    = "40300"
	ForbiddenStateNotAllow       = "40301"
	ForbiddenCaNotDeleteYourself = "40302"
)

403

Functions

func AddProblems

func AddProblems(p *server.Problems)

func Init

func Init(cleanup func(), f ...func() error)

Init 执行一系列的初始化操作

依次执行 f 中的函数，碰到第一个返回错误的函数时即退出整个流程，并执行 cleanup 进行清理操作。

cleanup 清理操作，只有当 f 出错时，才会执行 cleanup。

Types

type DateRange

type DateRange struct {
	Start time.Time
	End   time.Time
}

DateRange 时间范围。

将查询参数中的 xx-xx 转换成两个时间戳。

其中 0 表示未传递过来。

func (*DateRange) UnmarshalQuery

func (s *DateRange) UnmarshalQuery(data string) error

type Limit

type Limit struct {
	Page int `query:"page,0"`
	Size int `query:"size,20"`
}

Limit 分页查询中总会带的查询参数

func (*Limit) CTXSanitize

func (l *Limit) CTXSanitize(ctx *web.Context, v *web.Validation)

CTXSanitize 实现查询参数的验证

func (*Limit) Paging

func (l *Limit) Paging(sql *sqlbuilder.SelectStmt) (count, curr int64, err error)

Paging 获取分页信息

count 表示符合条件的数量； curr 表示当前页的数量；

type Text

type Text struct {
	Limit
	Text string `query:"text"`
}

Text 带分页的文字查询