dto

Documentation

Index

• type BaseResponse
• type BizRequest
  • func (r *BizRequest) GetBizId() int64
  • func (r *BizRequest) ToUrlQuery() url.Values
• type DataPager
  • func NewDataPager(data interface{}, index, size, total int64) *DataPager
• type IRow
• type Page
  • func (dto *Page) GetAfterID() any
  • func (dto *Page) GetBegin() int64
  • func (dto *Page) GetPageIndex() int64
  • func (dto *Page) GetPageSize() int64
  • func (dto *Page) GetSize() int64
  • func (dto *Page) GetSorts() []dependency.ISortField
• type Pager
  • func (r Pager) GetTotal() int64
  • func (r Pager) GetTotalRecord() int64
  • func (p *Pager) Paginator() *Pager
• type Range
  • func (i *Range) GetBeg() int64
  • func (i *Range) GetEnd() int64
• type RecordPager
  • func NewRecordPager[T IRow](index, size int64, total int64, records ...T) *RecordPager[T]
  • func (r RecordPager[T]) ToRows() [][]string
• type Response
  • func ErrorResponse(err error) *Response
  • func NewResponse(data interface{}, ex exception.Exception) *Response
  • func OkResponse(data interface{}) *Response
• type SortField
  • func (r *SortField) GetField() string
  • func (r *SortField) GetIsDesc() bool

Types

type BaseResponse

type BaseResponse struct {
	Code    int32  `json:"code"`
	Message string `json:"message"`
}

type BizRequest

type BizRequest struct {
	BizId int64 `json:"bizId" form:"bizId" uri:"bizId"`
}

BizRequest default business tag reqquest

func (*BizRequest) GetBizId

func (r *BizRequest) GetBizId() int64

func (*BizRequest) ToUrlQuery

func (r *BizRequest) ToUrlQuery() url.Values

type DataPager

type DataPager struct {
	Data interface{} `json:"data"`
	Pager
}

Deprecate : 后期启用

func NewDataPager

func NewDataPager(data interface{}, index, size, total int64) *DataPager

Deprecate : 后期启用 NewDataPager 返回一个 DataPager 结构体的指针，该结构体包含分页相关的信息和数据。 参数 data 是要分页的数据。 参数 index 是当前页的索引。 参数 size 是每页显示的记录数。 参数 total 是总记录数。

type IRow

type IRow interface {
	ToRow() []string
}

type Page

type Page struct {
	PageIndex int64       `json:"page" form:"page" uri:"page" binding:"required,gte=1"`             // currect page no
	AfterId   interface{} `json:"afterId"`                                                          // previous page last id, when sort by pk
	PageSize  int64       `json:"pageSize" form:"pageSize" uri:"pageSize" binding:"required,gte=1"` // page size
	Sorts     []string    `json:"sorts" form:"sorts" uri:"sorts"`                                   // eg; field|desc
}

Page default page request

func (*Page) GetAfterID

func (dto *Page) GetAfterID() any

func (*Page) GetBegin

func (dto *Page) GetBegin() int64

func (*Page) GetPageIndex

func (dto *Page) GetPageIndex() int64

func (*Page) GetPageSize

func (dto *Page) GetPageSize() int64

func (*Page) GetSize

func (dto *Page) GetSize() int64

func (*Page) GetSorts

func (dto *Page) GetSorts() []dependency.ISortField

type Pager

type Pager struct {
	Page
	TotalRecord int64 `json:"total"`
	TotalPage   int64 `json:"totalPage"`
}

func (Pager) GetTotal

func (r Pager) GetTotal() int64

func (Pager) GetTotalRecord

func (r Pager) GetTotalRecord() int64

func (*Pager) Paginator

func (p *Pager) Paginator() *Pager

type Range

type Range struct {
	Beg int64 `json:"beg" form:"beg"`
	End int64 `json:"end" form:"end"`
}

Range range

func (*Range) GetBeg

func (i *Range) GetBeg() int64

func (*Range) GetEnd

func (i *Range) GetEnd() int64

type RecordPager

type RecordPager[T IRow] struct {
	Data []T `json:"data"`
	Pager
}

func NewRecordPager

func NewRecordPager[T IRow](index, size int64, total int64, records ...T) *RecordPager[T]

NewRecordPager函数用于创建一个RecordPager对象。 RecordPager对象用于分页展示记录数据。 参数index表示当前页码，参数size表示每页显示的记录数量，参数total表示总记录数，参数records为记录数据。 返回值为创建的RecordPager对象指针。

func (RecordPager[T]) ToRows

func (r RecordPager[T]) ToRows() [][]string

type Response

type Response struct {
	BaseResponse
	Data interface{} `json:"data"`
}

func ErrorResponse

func ErrorResponse(err error) *Response

ErrorResponse 函数接收一个错误对象 err，返回一个指向 Response 结构体的指针 res。 该函数用于生成一个错误响应对象，将错误信息赋值给 Response 结构体的 Message 字段， 并将 Code 字段设为 -1。

func NewResponse

func NewResponse(data interface{}, ex exception.Exception) *Response

NewResponse 返回一个新的 Response 结构体指针。 如果 exception.Exception 不为 nil，则使用异常信息初始化 Response 结构体， 否则使用 data 初始化 OkResponse 结构体。

func OkResponse

func OkResponse(data interface{}) *Response

OkResponse函数用于生成一个成功的响应结果。 参数data为要返回的数据。 返回值为一个指向Response结构体的指针，其中Message字段为"success"，Data字段为data。

type SortField

type SortField struct {
	Field  string `json:"field" form:"field"`   // order by col
	IsDesc bool   `json:"isDesc" form:"isDesc"` // asc or desc, default is asc
}

SortField default sort field

func (*SortField) GetField

func (r *SortField) GetField() string

func (*SortField) GetIsDesc

func (r *SortField) GetIsDesc() bool