common

package module
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 29, 2022 License: MPL-2.0 Imports: 4 Imported by: 4

README

common

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Json 

func Json(v interface{}, indent bool) string

Types

type AppVersion 

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

AppVersion App客户端的版本信息封装，包括当前版本号、网络情况、操作平台等信息。

func NewAppVersion 

func NewAppVersion(device, version, network string) AppVersion

NewAppVersion 根据给定的App平台信息、版本信息和网络信息进行解析和存储处理，对当前请求线程都适用。 @device 客户端设备载体 @version 客户端版本信息 @network 客户端请求时的网络情况

func (AppVersion) CompareVersion 

func (av AppVersion) CompareVersion(version string) int

CompareVersion 使用给定的版本字符串和当前版本信息进行比较，如果当前版本大于给定的版本则返回1，如果当前版本等于给定的版本则返回0，如果当前版本小于给定的版本则返回-1。

func (AppVersion) Device 

func (av AppVersion) Device() string

Device 获取前端客户端的载体，返回值包括如下几种： 

iOS-Web：基于flutter打包的iOS客户端
iOS-Native：为iOS平台开发的原生客户端
Android-Web：基于flutter打包的Android客户端
Android-Native：为Android平台开发的原生客户端
Web：基于Web浏览器的在线版本
Windows-Web：基于Electron打包方式的windows客户端
Windows-Native：为windows平台开发的原生版本
Mac-Web：基于Electron打包方式的Mac平台客户端
Mac-Native：为Mac平台开发的原生版本
Linux-Web：基于Electron打包方式的Linux平台客户端
Linux-Native：为Linux平台开发的原生版本

func (AppVersion) IsClient 

func (av AppVersion) IsClient() bool

IsClient 判断当前App是否是客户端(包括基于flutter和原生的客户端)，如果是则返回true，否则返回false。

func (AppVersion) IsWeb 

func (av AppVersion) IsWeb() bool

IsWeb 判断当前请求的客户端是否是H5的在线版本，如果是则返回true，否则返回false。

func (AppVersion) IsWifi 

func (av AppVersion) IsWifi() bool

IsWifi 判断当前App请求是否是wifi网络环境，如果是则返回true，如果不是或前端获取不到数据则返回false。

func (AppVersion) Network 

func (av AppVersion) Network() string

Network 获取当前App的网络标示，返回的值包括如下几种（可能还有其他值）： 

2g：客户端使用的是2G网络
3g：客户端使用的是3G网络
4g：客户端使用的是4G网络
5g：客户端使用的是5g网络
wifi：客户端使用的是无线wifi网络
unknown：客户端的网络情况未知，如在线版时就无法获知

func (AppVersion) SimpleDevice 

func (av AppVersion) SimpleDevice() string

func (AppVersion) Version 

func (av AppVersion) Version() string

Version 获取当前客户端的版本信息，如：2.3.1

type Callback 

type Callback struct {
	CbType int    `json:"cbType"` // 业务数据JSON里的参数，回调类型代码
	Opt    string `json:"opt"`    // 操作编号
	Data   string `json:"data"`   // 具体返回数据的JSON格式
}

func NewCallBack 

func NewCallBack(cbType int, v interface{}) Callback

type DtoResult 

type DtoResult struct {
	Result
	Data interface{} `json:"data"` // 具体返回数据的JSON格式
}

DtoResult 返回带有对象信息

type NoProtectedURIProvider 

type NoProtectedURIProvider interface {
	// Patterns 获取不需要运营安全拦截的URI模式地址，符合ant-style规范。
	Patterns() []string
}

NoProtectedURIProvider 当前运营子系统中对不需要进行安全拦截的地址提供器，各运营子系统只需要实现该接口并注册到中即可。

func NewNoProtectedURIProvider 

func NewNoProtectedURIProvider(patterns []string) NoProtectedURIProvider

type Page 

type Page struct {
	PageSize     int `json:"pageSize"`     // 每页大小
	TotalPages   int `json:"totalPages"`   // 总页数
	TotalRecords int `json:"totalRecords"` // 总记录数
}

type PageResult 

type PageResult struct {
	Result
	Pagination Page        `json:"pagination"`
	Opt        string      `json:"opt"`  // 操作编号
	List       interface{} `json:"data"` // 记录集
}

PageResult 返回带在分页信息

type Pagination 

type Pagination struct {
	PageSize     int // 每页大小
	TotalPages   int // 总页数
	TotalRecords int // 总记录数
	// contains filtered or unexported fields
}

func DefaultPagination 

func DefaultPagination() *Pagination

func NewPagination 

func NewPagination(pageNo, pageSize, totalPages int) *Pagination

func (*Pagination) HasNext 

func (p *Pagination) HasNext() bool

HasNext 如果存在相对于当前页面的下一页，则返回true.

func (*Pagination) HasPrevious 

func (p *Pagination) HasPrevious() bool

HasPrevious 如果存在相对于当前页面的上一页，则返回true.

func (*Pagination) IsFirst 

func (p *Pagination) IsFirst() bool

IsFirst 如果当前页面是第一页，则返回true.

func (*Pagination) IsLast 

func (p *Pagination) IsLast() bool

IsLast 如果当前页面是最后一页，则返回true.

func (*Pagination) Limit 

func (p *Pagination) Limit() (limit int, offset int)

Limit 获取mysql分页值（limit,offset）

func (*Pagination) Next 

func (p *Pagination) Next() int

func (*Pagination) Pages 

func (p *Pagination) Pages() []*Paginator

Pages 返回相对于当前页面的附近页码的列表。如果值为-1表示"..."，则不会显示更多页面。

func (*Pagination) Previous 

func (p *Pagination) Previous() int

func (*Pagination) SetPageNumber 

func (p *Pagination) SetPageNumber(pageNo int)

SetPageNumber 设置当前分页的页码信息，必须大于0，否则设置无效。默认是1

func (*Pagination) SetPageSize 

func (p *Pagination) SetPageSize(pageSize int)

SetPageSize 设置页大小，必须大于0，否则设置无效

func (*Pagination) SetTotalRecord 

func (p *Pagination) SetTotalRecord(totalRecords int)

SetTotalRecord 设置当前分页信息的总记录数

func (*Pagination) Total 

func (p *Pagination) Total() int

Total returns number of total rows.

func (*Pagination) TotalPage 

func (p *Pagination) TotalPage() int

TotalPage 返回总页数.

type PaginationList 

type PaginationList struct {
	Pagination
	List interface{} // 记录集
}

type Paginator 

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

Paginator 在分页器中显示页面

func (*Paginator) IsCurrent 

func (p *Paginator) IsCurrent() bool

func (*Paginator) Num 

func (p *Paginator) Num() int

type Query 

type Query struct {
	PageSize int32 `json:"pageSize"`
	Page     int32 `json:"page"`
	Sorted   []struct {
		Id   string `json:"id"`
		Desc bool   `json:"desc"`
	} `json:"sorted"`
	Filtered []struct {
		Id    string      `json:"id"`
		Value interface{} `json:"value"`
	} `json:"filtered"`
}

Query 查询参数结构体 {"pageSize":10,"page":0,"sorted":[{"id":"firstName","desc":false}],"filtered":[{"id":"firstName","value":"3"}]}

func (*Query) ForPb 

func (sp *Query) ForPb(pq *pb.Query) *Query

func (Query) MarkPage 

func (sp Query) MarkPage() *Pagination

func (*Query) SetFiltered 

func (sp *Query) SetFiltered(id string, value interface{})

func (*Query) SetPage 

func (sp *Query) SetPage(page int32)

func (*Query) SetPageSize 

func (sp *Query) SetPageSize(pageSize int32)

func (*Query) SetSorted 

func (sp *Query) SetSorted(id string, desc bool)

func (*Query) ToPb 

func (sp *Query) ToPb() (pq *pb.Query)

type Result 

type Result struct {
	Code    int    `json:"code"` // 返回状态,接口返回码等于0表示SDK错误
	Message string `json:"msg"`  // 返回信息,业务描述
	Opt     string `json:"opt"`  // 操作编号
}

Result 纯状态返回

func (*Result) SetOpt 

func (r *Result) SetOpt(opt string)

Source Files

View all Source files

Directories

Path Synopsis
Package jwt @Title jwt.go @Description jwt token @Author Brandon 时间（2022/8/29） @Update Brandon 时间（2022/8/29）
 Package jwt @Title jwt.go @Description jwt token @Author Brandon 时间（2022/8/29） @Update Brandon 时间（2022/8/29）

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.