cbl

README

cbl-go: Common Basic Library for Go

Install:

go get github.com/zhangjie2012/cbl-go@master # master version, recommand
go get -u github.com/zhangjie2012/cbl-go # new release version

Libraries include

• Common
  • generator: uuid, session id, verfiy code
  • date expand
  • set operations: uniq, union, intersection, difference
  • yinyang: 公历、农历转换 deprecated
• Data Structure
  • MultiError: muliple error expression
  • Pair: key value struct
• cache: a redis wrapper, easy to use, include common operator, mq, dislock, set
• datasize: byte to KB/MB/GB/TB/PB/EB, KiB/MiB/GiB/TiB/PiB/EiB and more elegent to string

Documentation

Overview

Package cbl is a common basic library for go.

• `conv` 类型转换
• `errcode` web 常用错误码
• `gen` token/id 生成器
• `ginext` gin 扩展（标准化）
• `net` 网络扩展
• `prom` prometheus middware
• `strings` 字符串扩展
• `wechat_mini` 微信小程序
• `yinyang` 公历和农历转换
• `set` set
• `date` 日期扩展

More read `README.md`

Index

• Variables
• func B2i(b bool) int
• func ConvYinYang(year int, month int, leap int, day int) (time.Time, error)
• func DayOfWeekCN(n int) string
• func DurationString(d time.Duration) string
• func EndOfDay(t time.Time) time.Time
• func EndOfMonth(t time.Time) time.Time
• func EndOfWeek(t time.Time) time.Time
• func EndOfYear(t time.Time) time.Time
• func ErrorResponse(c *gin.Context, err interface{})
• func FormatDayTime(t time.Time, showSec bool) string
• func GenRSessionID() string
• func GenUSessionID() string
• func GenUUIDV1() string
• func GenUUIDV4() string
• func GenVerifyCodeAny(pool string, width int) string
• func GenVerifyCodeCommon(width int) string
• func GenVerifyCodeNumber(width int) string
• func GetOutboundIP() net.IP
• func I2b(i int) bool
• func Int64SliceToString(a []int64, delim string) string
• func IntSliceToString(a []int, delim string) string
• func PromGinMiddleware() gin.HandlerFunc
• func RangeMonth(t time.Time) []time.Time
• func RangeWeek(t time.Time) []time.Time
• func RangeYear(t time.Time) []time.Time
• func SliceDifference(a []string, b []string) []string
• func SliceIntersection(a []string, b []string) []string
• func SliceUnion(a []string, b []string) []string
• func SliceUniq(a []string) []string
• func SliceUniqInt(a []int) []int
• func SliceUniqInt64(a []int64) []int64
• func StartOfDay(t time.Time) time.Time
• func StartOfMonth(t time.Time) time.Time
• func StartOfWeek(t time.Time) time.Time
• func StartOfYear(t time.Time) time.Time
• func StringSplit(source string, sep string) []string
• func SuccessResponse(c *gin.Context, data interface{})
• func TruncateString(str string, length int) string
• func UrlJoin(host string, subs ...string) (string, error)
• type Resp
• type WXMiniSession
  • func Code2Session(appID string, secret string, code string) (*WXMiniSession, error)
• type YangDate
• type YinDate
  • func ConvYangYin(year int, month int, day int) (*YinDate, error)
  • func (y *YinDate) ToString1() string
  • func (y *YinDate) ToString2() string
  • func (y *YinDate) ToString3() string

Variables

var (
	ErrNone                = ""                      // no error 没错
	ErrBadRequest          = "Bad Request"           // bad request 错误的请求（参数错误）
	ErrInternalServerError = "Internal Server Error" // server logic error 服务器内部错误, 服务器自身逻辑问题
	ErrInvalidParams       = "Invalid Params"        // invalid params 参数格式错误
	ErrInvalidPassword     = "Invalid Password"      // invalid password 密码错误
	ErrInvalidVerifyCode   = "Invalid Verify Code"   // invalid verify code 验证码无效
	ErrLoginRequired       = "Login Required"        // need login 需要登录
	ErrNotFound            = "Not Found"             // resource not found 资源不存在
	ErrOutOfRange          = "Out Of Range"          // out of range 越界访问
	ErrPermissionDenied    = "Permission Denied"     // permission denied 权限不足
	ErrTooManyRequests     = "Too Many Requests"     // too many requests 请求过于频繁, 限流
)

Functions

func B2i

func B2i(b bool) int

B2i bool to int

func ConvYinYang

func ConvYinYang(year int, month int, leap int, day int) (time.Time, error)

ConvYinYang 农历转公历

func DayOfWeekCN

func DayOfWeekCN(n int) string

func DurationString

func DurationString(d time.Duration) string

func EndOfDay

func EndOfDay(t time.Time) time.Time

func EndOfMonth

func EndOfMonth(t time.Time) time.Time

EndOfMonth month end datetime

func EndOfWeek

func EndOfWeek(t time.Time) time.Time

EndOfWeek week last day

func EndOfYear

func EndOfYear(t time.Time) time.Time

func ErrorResponse

func ErrorResponse(c *gin.Context, err interface{})

func FormatDayTime

func FormatDayTime(t time.Time, showSec bool) string

func GenRSessionID

func GenRSessionID() string

GenRSessionID generate a random session id, most business scene recommand

func GenUSessionID

func GenUSessionID() string

GenSessionID generate a unique session id

func GenUUIDV1

func GenUUIDV1() string

GenUUIDV1 global unique id

func GenUUIDV4

func GenUUIDV4() string

GenUUIDV4 wikipedia said Randomly generated UUIDs have 122 random bits. One's annual risk of being hit by a meteorite is estimated to be one chance in 17 billion, that means the probability is about 0.00000000006 (6 x 10−11), equivalent to the odds of creating a few tens of trillions of UUIDs in a year and having one duplicate.

(most business scene recommand)

func GenVerifyCodeAny

func GenVerifyCodeAny(pool string, width int) string

GenVerifyCodeAny generate verify code, get from pool

func GenVerifyCodeCommon

func GenVerifyCodeCommon(width int) string

GenVerifyCodeCommon generate verify code, letter + number

func GenVerifyCodeNumber

func GenVerifyCodeNumber(width int) string

GenVerifyCodeNumber generate verify code, all is number

func GetOutboundIP

func GetOutboundIP() net.IP

GetOutboundIP get IP address code via https://stackoverflow.com/a/37382208/802815

func I2b

func I2b(i int) bool

I2b int t bool

func Int64SliceToString

func Int64SliceToString(a []int64, delim string) string

Int64SliceToString a int64 slice to string Ref: https://stackoverflow.com/questions/37532255/one-liner-to-transform-int-into-string

func IntSliceToString

func IntSliceToString(a []int, delim string) string

IntSliceToString a int64 slice to string Ref: https://stackoverflow.com/questions/37532255/one-liner-to-transform-int-into-string

func PromGinMiddleware

func PromGinMiddleware() gin.HandlerFunc

PromGinMiddleware prometheus for gin, register code:

router.GET("/metrics", gin.WrapH(promhttp.HandlerFor(prometheus.DefaultGatherer, promhttp.HandlerOpts{})))

func RangeMonth

func RangeMonth(t time.Time) []time.Time

RangeMonth get month every day date

func RangeWeek

func RangeWeek(t time.Time) []time.Time

func RangeYear

func RangeYear(t time.Time) []time.Time

func SliceDifference

func SliceDifference(a []string, b []string) []string

SliceDifference 差集

func SliceIntersection

func SliceIntersection(a []string, b []string) []string

SliceIntersection 交集

func SliceUnion

func SliceUnion(a []string, b []string) []string

SliceUnion 并集

func SliceUniq

func SliceUniq(a []string) []string

SliceUniq 去重

func SliceUniqInt

func SliceUniqInt(a []int) []int

func SliceUniqInt64

func SliceUniqInt64(a []int64) []int64

func StartOfDay

func StartOfDay(t time.Time) time.Time

func StartOfMonth

func StartOfMonth(t time.Time) time.Time

StartOfMonth month start datetime

func StartOfWeek

func StartOfWeek(t time.Time) time.Time

StartOfWeek week first day

func StartOfYear

func StartOfYear(t time.Time) time.Time

func StringSplit

func StringSplit(source string, sep string) []string

StringSplit string split by `sep` the standard library `Split` when `source` is a empty string, will return a `[""]` slice. In fact, most of time, we want return a length equal 0 slice, `[]`

func SuccessResponse

func SuccessResponse(c *gin.Context, data interface{})

func TruncateString

func TruncateString(str string, length int) string

TruncateString Ref: https://dev.to/takakd/go-safe-truncate-string-9h0

func UrlJoin

func UrlJoin(host string, subs ...string) (string, error)

UrlJoin via https://stackoverflow.com/questions/34668012/combine-url-paths-with-path-join

Types

type Resp

type Resp struct {
	Code  int         `json:"code"`
	Data  interface{} `json:"data"`
	Error string      `json:"error"`
}

type WXMiniSession

type WXMiniSession struct {
	OpenID     string `json:"openid"`
	SessionKey string `json:"session_key"`
	UnionID    string `json:"unionid"`
}

func Code2Session

func Code2Session(appID string, secret string, code string) (*WXMiniSession, error)

Code2Session wxlogin code to session id. https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/login/auth.code2Session.html

type YangDate

type YangDate struct {
	Year  int `json:"year"`
	Month int `json:"month"`
	Day   int `json:"day"`
}

type YinDate

type YinDate struct {
	YearNum    int    `json:"year_num"`
	YearTian   string `json:"year_tian"`
	YearDi     string `json:"year_di"`
	YearZodiac string `json:"year_zodiac"`
	MonthNum   int    `json:"month_num"`
	MonthName  string `json:"month_name"`
	MonthLeap  bool   `json:"month_leap"`
	DayNum     int    `json:"day_num"`
	DayName    string `json:"day_name"`
	WeekDay    string `json:"weekday"`
	SolarTerm  string `json:"solarterm"`
}

func ConvYangYin

func ConvYangYin(year int, month int, day int) (*YinDate, error)

ConvYangYin 公历转农历

func (*YinDate) ToString1

func (y *YinDate) ToString1() string

func (*YinDate) ToString2

func (y *YinDate) ToString2() string

func (*YinDate) ToString3

func (y *YinDate) ToString3() string