mcommon

README

mcommon

目录

• mcommon
  • 目录
  • 背景
  • 使用说明
  • 维护者
  • 使用许可

背景

开发过程中用到的一些通用的golang函数

• log.go 日志
• mysql.go mysql操作

使用说明

go get github.com/moremorefun/mcommon

维护者

@moremorefun 那些年我们De过的Bug

使用许可

MIT © moremorefun

Documentation

Index

• Constants
• Variables
• func DbCreate(dataSourceName string, showSQL bool) *sqlx.DB
• func DbExecuteCountManyContent(ctx context.Context, tx DbExeAble, query string, n int, args ...interface{}) (int64, error)
• func DbExecuteCountNamedContent(ctx context.Context, tx DbExeAble, query string, argMap map[string]interface{}) (int64, error)
• func DbExecuteLastIDNamedContent(ctx context.Context, tx DbExeAble, query string, argMap map[string]interface{}) (int64, error)
• func DbGetNamedContent(ctx context.Context, tx DbExeAble, dest interface{}, query string, ...) (bool, error)
• func DbSelectNamedContent(ctx context.Context, tx DbExeAble, dest interface{}, query string, ...) error
• func DecodeHashID(salt string, minLen int, value string) (int, error)
• func EncodeHashID(salt string, minLen, id int) (string, error)
• func GetUUIDStr() string
• func GinDoRespErr(c *gin.Context, code int64, msg string, data gin.H)
• func GinDoRespInternalErr(c *gin.Context)
• func GinDoRespSuccess(c *gin.Context, data gin.H)
• func GinFillBindError(c *gin.Context, err error)
• func GinRepeatReadBody(c *gin.Context) error
• func GinShouldBindRepeat(c *gin.Context, obj interface{}) error
• func IsIntInSlice(arr []int64, str int64) bool
• func IsStringInSlice(arr []string, str string) bool
• func LogSetLevel(level zapcore.Level) error
• func LogSetToProd() error
• func QiniuGetDownloadURL(ctx context.Context, access string, secret string, domain string, ...) string
• func TencenSms(sdkID, sdkKey, appID, sign, templateID string, tels []string, ...) error
• func UploadToQiniu(ctx context.Context, access string, secret string, zone *storage.Zone, ...) error
• type DbExeAble
• type GinResp
  • func GinFillSuccessData(data gin.H) GinResp
• type LoggerAble

Constants

const (
	// ErrorSuccess 成功
	ErrorSuccess = 0
	// ErrorSuccessMsg 成功
	ErrorSuccessMsg = "success"

	// ErrorInternal 内部错误
	ErrorInternal = -1
	// ErrorInternalMsg 内部错误
	ErrorInternalMsg = "internal"

	// ErrorBind 输入绑定错误
	ErrorBind = -2
	// ErrorBindMsg 输入绑定错误
	ErrorBindMsg = "input bind"
)

Variables

var GinRespInternalErr = GinResp{
	ErrCode: ErrorInternal,
	ErrMsg:  ErrorInternalMsg,
}

GinRespInternalErr 成功返回

var GinRespSuccess = GinResp{
	ErrCode: ErrorSuccess,
	ErrMsg:  ErrorSuccessMsg,
}

GinRespSuccess 成功返回

var ZapLog *zap.Logger

ZapLog zap日志对象

Functions

func DbCreate

func DbCreate(dataSourceName string, showSQL bool) *sqlx.DB

DbCreate 创建数据库链接

func DbExecuteCountManyContent

func DbExecuteCountManyContent(ctx context.Context, tx DbExeAble, query string, n int, args ...interface{}) (int64, error)

DbExecuteCountManyContent 返回sql语句并返回执行行数

func DbExecuteCountNamedContent

func DbExecuteCountNamedContent(ctx context.Context, tx DbExeAble, query string, argMap map[string]interface{}) (int64, error)

DbExecuteCountNamedContent 执行sql语句返回执行个数

func DbExecuteLastIDNamedContent

func DbExecuteLastIDNamedContent(ctx context.Context, tx DbExeAble, query string, argMap map[string]interface{}) (int64, error)

DbExecuteLastIDNamedContent 执行sql语句并返回lastID

func DbGetNamedContent

func DbGetNamedContent(ctx context.Context, tx DbExeAble, dest interface{}, query string, argMap map[string]interface{}) (bool, error)

DbGetNamedContent 执行sql查询并返回当个元素

func DbSelectNamedContent

func DbSelectNamedContent(ctx context.Context, tx DbExeAble, dest interface{}, query string, argMap map[string]interface{}) error

DbSelectNamedContent 执行sql查询并返回多行

func DecodeHashID

func DecodeHashID(salt string, minLen int, value string) (int, error)

DecodeHashID 解析hash id

func EncodeHashID

func EncodeHashID(salt string, minLen, id int) (string, error)

EncodeHashID 获取hash id

func GetUUIDStr

func GetUUIDStr() string

GetUUIDStr 获取唯一字符串

func GinDoRespErr

func GinDoRespErr(c *gin.Context, code int64, msg string, data gin.H)

GinDoRespErr 返回特殊错误

func GinDoRespInternalErr

func GinDoRespInternalErr(c *gin.Context)

返回错误信息

func GinDoRespSuccess

func GinDoRespSuccess(c *gin.Context, data gin.H)

GinDoRespSuccess 返回成功信息

func GinFillBindError

func GinFillBindError(c *gin.Context, err error)

GinFillBindError 检测gin输入绑定错误

func GinRepeatReadBody

func GinRepeatReadBody(c *gin.Context) error

GinRepeatReadBody 创建可重复度body

func GinShouldBindRepeat

func GinShouldBindRepeat(c *gin.Context, obj interface{}) error

GinShouldBindRepeat 可重复绑定参数

func IsIntInSlice

func IsIntInSlice(arr []int64, str int64) bool

IsIntInSlice 数字是否在数组中

func IsStringInSlice

func IsStringInSlice(arr []string, str string) bool

IsStringInSlice 字符串是否在数组中

func LogSetLevel

func LogSetLevel(level zapcore.Level) error

LogSetLevel 设置日志等级

func LogSetToProd

func LogSetToProd() error

LogSetToProd 设置为生产环境

func QiniuGetDownloadURL

func QiniuGetDownloadURL(ctx context.Context, access string, secret string, domain string, fileKey string, deadline int64) string

QiniuGetDownloadURL 获取私有下载链接

func TencenSms

func TencenSms(sdkID, sdkKey, appID, sign, templateID string, tels []string, templateParam []string) error

TencenSms 发送短信

func UploadToQiniu

func UploadToQiniu(ctx context.Context, access string, secret string, zone *storage.Zone, bucket string, fileKey string, bs []byte) error

UploadToQiniu 上传到qiniu

Types

type DbExeAble

type DbExeAble interface {
	Rebind(string) string
	Get(dest interface{}, query string, args ...interface{}) error
	Exec(query string, args ...interface{}) (sql.Result, error)
	Select(dest interface{}, query string, args ...interface{}) error
	GetContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
	ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)
	SelectContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
}

DbExeAble 数据库接口

type GinResp

type GinResp struct {
	ErrCode int64  `json:"error"`
	ErrMsg  string `json:"error_msg"`
	Data    gin.H  `json:"data,omitempty"`
}

func GinFillSuccessData

func GinFillSuccessData(data gin.H) GinResp

GinFillSuccessData 填充返回数据

type LoggerAble

type LoggerAble interface {
	Debugf(template string, args ...interface{})
	Infof(template string, args ...interface{})
	Warnf(template string, args ...interface{})
	Errorf(template string, args ...interface{})
	Fatalf(template string, args ...interface{})
}

LoggerAble 日志对象接口

var Log LoggerAble

Log 对外服务的日志对象