README
¶
beego-tool
beego框架适用工具
安装
go get -u github.com/adam-qiang/beego-tool
一、context
适用于beego框架的上下文工具
1、NewContext
创建一个新的上下文
2、PostForm
接收POST表单参数
3、Query
接收GET请求的查询参数
4、JsonParams
接收application/json请求头的请求参数
5、SetStatus
设置网络状态
6、SetHeader
设置响应状态
7、OtuPut
输出响应
8、OtuPutString
输出普通字符串响应
9、OtuPutJson
输出application/json响应
10、OtuPutHtml
输出HTML响应
二、data_tool
适用于beego框架的数据工具
1、ExportCsv
导出CSV
2、ExportExcel
数据导出excel
三、validate
适用于beego框架的参数校验工具
1、InitValidate
初始化校验（在main中进行初始化）
2、Valid
公共的表单校验方法
四、数据库
适用于beego框架的数据库工具
1、初始化数据库（在main中进行初始化）
import _ "github.com/adam-qiang/beego-tool/database"
2、配置
[mysql]
mysql_urls =
mysql_port =
mysql_user =
mysql_pass =
mysql_db =
[redis]
address =
port =
password =
database =
key =
cache_database =
cache_key =
- 注：redis配置中key和cache_key分别为redis普通操作前缀key和为redis缓存前缀key（可以不配置）
3、数据库操作
1、MySQL
操作遵循beego官方操作具体见beego官方文档
2、Redis
使用github.com/redis/go-redis/v9作为redis操作库进行二次封装，同时只封装了经常用到的方法，如有其他需求可自行封装可随时issue
支持以下操：
- Del
- Dump
- Restore
- Exists
- Expire
- ExpireAt
- Keys
- Move
- Persist
- PExpire
- PExpireAt
- TTL
- PTTL
- Rename
- RenameNX
- Type
- Set
- SetNX
- Get
- Incr
- IncrBy
- Decr
- DecrBy
- MSet
- MSetNX
- MGetMap
- StrLen
- HSet
- HGet
- HGetAll
- HMSet
- HMGetMap
- HExists
- HDel
- HIncrBy
- HKeys
- HLen
- LPop
- LPush
- BLPop
- LPushX
- RPop
- RPush
- RPushX
- BRPop
- RPopLPush
- BRPopLPush
- LIndex
- LInsert
- LLen
- LRange
- LRem
- LSet
- SAdd
- SCard
- SDiff
- SDiffStore
- SInter
- SInterStore
- SIsMember
- SMembers
- SMove
- SRem
- SUnion
- SUnionStore
- ZAdd
- ZCard
- ZCount
- ZIncrBy
- ZRange
- ZRangeByScore
- ZRank
- ZRem
- ZRemRangeByRank
- ZRemRangeByScore
- ZRevRange
- ZRevRangeByLex
- ZRevRangeByScore
- ZRevRangeByScoreWithScores
- ZRevRangeWithScores
- ZRevRank
- ZScore
操作遵循beego官方操作具体见beego官方文档
Documentation
¶
Index ¶
- Variables
- func ExportCsv(ctx *beegoContext.Context, title []string, dataList [][]string, ...) error
- func ExportExcel(w http.ResponseWriter, r *http.Request, titleList []string, ...)
- func InitValidate()
- func Valid(obj interface{}, validate interface{}) (error string)
- type Content
- type Context
- func (ctx *Context) JsonParams(params map[string]interface{})
- func (ctx *Context) OtuPut(code int, data []byte)
- func (ctx *Context) OtuPutHtml(code int, html string)
- func (ctx *Context) OtuPutJson(code int, obj interface{})
- func (ctx *Context) OtuPutString(code int, format string, values ...interface{})
- func (ctx *Context) PostForm(key string) string
- func (ctx *Context) Query(key string) string
- func (ctx *Context) SetHeader(key string, value string)
- func (ctx *Context) SetStatus(code int)
- type ReturnMsg
Constants ¶
This section is empty.
Variables ¶
var MessageTemples = map[string]string{
"Required": "不能为空",
"Min": "最小为%d",
"Max": "最大为%d",
"Range": "范围在%d至%d",
"MinSize": "最小长度为%d",
"MaxSize": "最大长度为%d",
"Length": "长度必须是%d",
"Alpha": "必须是有效的字母字符",
"Numeric": "必须是有效的数字字符",
"AlphaNumeric": "必须是有效的字母或数字字符",
"Match": "必须匹配格式%s",
"NoMatch": "必须不匹配格式%s",
"AlphaDash": "必须是有效的字母或数字或破折号(-_)字符",
"Email": "必须是有效的邮件地址",
"IP": "必须是有效的IP地址",
"Base64": "必须是有效的base64字符",
"Mobile": "必须是有效手机号码",
"Tel": "必须是有效电话号码",
"Phone": "必须是有效的电话号码或者手机号码",
"ZipCode": "必须是有效的邮政编码",
}
MessageTemples 错误提示模板
Functions ¶
func ExportCsv ¶ added in v1.0.2
func ExportCsv(ctx *beegoContext.Context, title []string, dataList [][]string, fileName string) error
ExportCsv 数据导出CSV @param ctx *beegoContext.Context @param title []string @param dataList [][]string @param fileName string @return error
func ExportExcel ¶ added in v1.0.2
func ExportExcel(w http.ResponseWriter, r *http.Request, titleList []string, dataList [][]interface{}, fileName string)
ExportExcel 数据导出excel @param w http.ResponseWriter @param r *http.Request @param titleList []string @param dataList [][]interface{} @param fileName string
Types ¶
type Context ¶
type Context struct {
Writer *beegoContext.Response
Req *beegoContext.Context
Path string
Method string
StatusCode int
}
Context 上下文结构
func NewContext ¶
func NewContext(ctx *beegoContext.Context) *Context
NewContext 创建新的上下文 @param ctx *beegoContext.Context @return *Context
func (*Context) JsonParams ¶
JsonParams 接收application/json请求头的请求参数 @receiver ctx *Context @param params map[string]interface{}
func (*Context) OtuPut ¶ added in v1.0.2
OtuPut 响应输出 @receiver ctx *Context @param code int @param data []byte
func (*Context) OtuPutHtml ¶ added in v1.0.2
OtuPutHtml 输出HTML响应 @receiver ctx *Context @param code int @param html string
func (*Context) OtuPutJson ¶ added in v1.0.2
OtuPutJson 输出json @receiver ctx *Context @param code int @param obj interface{}
func (*Context) OtuPutString ¶ added in v1.0.2
OtuPutString 输出字符串 @receiver ctx *Context @param code int @param format string @param values ...interface{}
func (*Context) PostForm ¶
PostForm 获取post表单参数 @receiver ctx *Context @param key string @return string
Source Files
Directories