framework_request.go

package gin

import (
	"mime/multipart"

	"github.com/spf13/cast"
)

// 代表请求包含的方法
type IRequest interface {
	// 请求地址url中带的参数
	// 形如: foo.com?a=1&b=bar&c[]=bar
	DefaultQueryInt(key string, def int) (int, bool)
	DefaultQueryInt64(key string, def int64) (int64, bool)
	DefaultQueryFloat64(key string, def float64) (float64, bool)
	DefaultQueryFloat32(key string, def float32) (float32, bool)
	DefaultQueryBool(key string, def bool) (bool, bool)
	DefaultQueryString(key string, def string) (string, bool)
	DefaultQueryStringSlice(key string, def []string) ([]string, bool)

	// 路由匹配中带的参数
	// 形如 /book/:id
	DefaultQueryParamInt(key string, def int) (int, bool)
	DefaultQueryParamInt64(key string, def int64) (int64, bool)
	DefaultQueryParamFloat64(key string, def float64) (float64, bool)
	DefaultQueryParamFloat32(key string, def float32) (float32, bool)
	DefaultQueryParamBool(key string, def bool) (bool, bool)
	DefaultQueryParamString(key string, def string) (string, bool)
	DefaultQueryParam(key string) interface{}

	// form表单中带的参数
	DefaultQueryFormInt(key string, def int) (int, bool)
	DefaultQueryFormInt64(key string, def int64) (int64, bool)
	DefaultQueryFormFloat64(key string, def float64) (float64, bool)
	DefaultQueryFormFloat32(key string, def float32) (float32, bool)
	DefaultQueryFormBool(key string, def bool) (bool, bool)
	DefaultQueryFormString(key string, def string) (string, bool)
	DefaultQueryFormStringSlice(key string, def []string) ([]string, bool)
	DefaultQueryFormFile(key string) (*multipart.FileHeader, error)
	DefaultQueryForm(key string) interface{}

	// json body
	BindJson(obj interface{}) error

	// xml body
	BindXml(obj interface{}) error

	// 其他格式
	GetRawData() ([]byte, error)

	// 基础信息
	Uri() string
	Method() string
	Host() string
	ClientIp() string

	// header
	Headers() map[string][]string
	Header(key string) (string, bool)

	// cookie
	Cookies() map[string]string
	Cookie(key string) (string, bool)
}

func (ctx *Context) Queryall() map[string][]string {
	ctx.initQueryCache()
	return map[string][]string(ctx.queryCache)
}

func (ctx *Context) DefaultQueryInt(key string, def int) (int, bool) {
	params := ctx.Queryall()
	if param, ok := params[key]; ok {
		if len(param) > 0 {
			return cast.ToInt(param[0]), true
		}
	}
	return def, false
}

func (ctx *Context) DefaultQueryInt64(key string, def int64) (int64, bool) {
	params := ctx.Queryall()
	if param, ok := params[key]; ok {
		if len(param) > 0 {
			return cast.ToInt64(param[0]), true
		}
	}
	return def, false
}

func (ctx *Context) DefaultQueryFloat64(key string, def float64) (float64, bool) {
	params := ctx.Queryall()
	if param, ok := params[key]; ok {
		if len(param) > 0 {
			return cast.ToFloat64(param[0]), true
		}
	}
	return def, false
}

func (ctx *Context) DefaultQueryFloat32(key string, def float32) (float32, bool) {
	params := ctx.Queryall()
	if param, ok := params[key]; ok {
		if len(param) > 0 {
			return cast.ToFloat32(param[0]), true
		}
	}
	return def, false
}

func (ctx *Context) DefaultQueryBool(key string, def bool) (bool, bool) {
	params := ctx.Queryall()
	if param, ok := params[key]; ok {
		if len(param) > 0 {
			return cast.ToBool(param[0]), true
		}
	}
	return def, false
}

func (ctx *Context) DefaultQueryString(key string, def string) (string, bool) {
	params := ctx.Queryall()
	if param, ok := params[key]; ok {
		if len(param) > 0 {
			return param[0], true
		}
	}
	return def, false
}

func (ctx *Context) DefaultQueryStringSlice(key string, def []string) ([]string, bool) {
	params := ctx.Queryall()
	if param, ok := params[key]; ok {
		return param, true
	}
	return def, false
}

func (ctx *Context) JwParam(key string) interface{} {
	if val, ok := ctx.params.Get(key); ok {
		return val
	}
	return nil
}

func (ctx *Context) DefaultParamInt(key string, def int) (int, bool) {
	if val := ctx.JwParam(key); val != nil {
		return cast.ToInt(val), true
	}
	return def, false
}
func (ctx *Context) DefaultParamInt64(key string, def int64) (int64, bool) {
	if val := ctx.JwParam(key); val != nil {
		return cast.ToInt64(val), true
	}
	return def, false
}

func (ctx *Context) DefaultParamFloat64(key string, def float64) (float64, bool) {
	if val := ctx.JwParam(key); val != nil {
		return cast.ToFloat64(val), true
	}
	return def, false
}

func (ctx *Context) DefaultParamFloat32(key string, def float32) (float32, bool) {
	if val := ctx.JwParam(key); val != nil {
		return cast.ToFloat32(val), true
	}
	return def, false
}

func (ctx *Context) DefaultParamBool(key string, def bool) (bool, bool) {
	if val := ctx.JwParam(key); val != nil {
		return cast.ToBool(val), true
	}
	return def, false
}

func (ctx *Context) DefaultParamString(key string, def string) (string, bool) {
	if val := ctx.JwParam(key); val != nil {
		return cast.ToString(val), true
	}
	return def, false
}

func (ctx *Context) FormAll() map[string][]string {
	ctx.initFormCache()
	return map[string][]string(ctx.formCache)
}

func (ctx *Context) DefaultFormInt(key string, def int) (int, bool) {
	params := ctx.FormAll()
	if vals, ok := params[key]; ok {
		return cast.ToInt(vals[0]), true
	}
	return def, false
}

func (ctx *Context) DefaultFormInt64(key string, def int64) (int64, bool) {
	params := ctx.FormAll()
	if vals, ok := params[key]; ok {
		return cast.ToInt64(vals[0]), true
	}
	return def, false
}

func (ctx *Context) DefaultFormFloat64(key string, def float64) (float64, bool) {
	params := ctx.FormAll()
	if vals, ok := params[key]; ok {
		return cast.ToFloat64(vals[0]), true
	}
	return def, false
}

func (ctx *Context) DefaultFormFloat32(key string, def float32) (float32, bool) {
	params := ctx.FormAll()
	if vals, ok := params[key]; ok {
		return cast.ToFloat32(vals[0]), true
	}
	return def, false
}

func (ctx *Context) DefaultFormBool(key string, def bool) (bool, bool) {
	params := ctx.FormAll()
	if vals, ok := params[key]; ok {
		return cast.ToBool(vals[0]), true
	}
	return def, false
}

func (ctx *Context) DefaultFormString(key string, def string) (string, bool) {
	params := ctx.FormAll()
	if vals, ok := params[key]; ok {
		return cast.ToString(vals[0]), true
	}
	return def, false
}

func (ctx *Context) DefaultFormStringSlice(key string, def []string) ([]string, bool) {
	params := ctx.FormAll()
	if vals, ok := params[key]; ok {
		return vals, true
	}
	return def, false
}

func (ctx *Context) DefaultForm(key string) interface{} {
	params := ctx.FormAll()
	if vals, ok := params[key]; ok {
		return vals[0]
	}
	return nil
}