tool

Documentation

Index

• Constants
• func Decode(io io.ReadCloser, v interface{}) error
• func Failed(context *gin.Context, v interface{})
• func GetSeess(context *gin.Context, key interface{}) interface{}
• func InitSession(app *gin.Engine)
• func SetSeess(context *gin.Context, key interface{}, value interface{}) error
• func Success(context *gin.Context, v interface{})
• func VerifyCaptcha(id string, value string) bool
• type CaptchaResult
  • func GenerateCaptcha(context *gin.Context) CaptchaResult
• type Config
  • func GetConfig() *Config
  • func ParseConfig(path string) (*Config, error)
• type DataBaseConfig
• type JsonParse
• type OrmTool
  • func InitOrmEngine(cfg *Config) (*OrmTool, error)
• type RedisConfig
• type RedisStore
  • func InitRedisStore() *RedisStore
  • func (s *RedisStore) Get(id string, clear bool) (value string)
  • func (s *RedisStore) Set(id string, value string)
• type SmsConfig

Constants

const (
	SUCCESS = 0 // 操作成功
	FAILED  = 1 // 失败
)

Functions

func Decode

func Decode(io io.ReadCloser, v interface{}) error

* 参数解析 io 用户请求接口传过来的参数

func Failed

func Failed(context *gin.Context, v interface{})

操作失败返回的内容

func GetSeess

func GetSeess(context *gin.Context, key interface{}) interface{}

* 获取Session

func InitSession

func InitSession(app *gin.Engine)

func SetSeess

func SetSeess(context *gin.Context, key interface{}, value interface{}) error

* 设置Session

func Success

func Success(context *gin.Context, v interface{})

请求成功返回的抽取封装

func VerifyCaptcha

func VerifyCaptcha(id string, value string) bool

* 这里验证的时候会自动调用刚刚实现的SET POST

Types

type CaptchaResult

type CaptchaResult struct {
	Id           string `json:"id"`
	Base64Blob   string `json:"base_64_blob"`
	VertifyValue string `json:"vertify_value"`
}

func GenerateCaptcha

func GenerateCaptcha(context *gin.Context) CaptchaResult

* 生成图形化验证码

type Config

type Config struct {
	AppName     string         `json:"app_name"`
	AppMode     string         `json:"app_mode"`
	AppHost     string         `json:"app_host"`
	AppPort     string         `json:"app_port"`
	Sms         SmsConfig      `json:"sms"`
	DataBase    DataBaseConfig `json:"database"`
	RedisConfig RedisConfig    `json:"redis_config"`
}

func GetConfig

func GetConfig() *Config

* 返回Config对象

func ParseConfig

func ParseConfig(path string) (*Config, error)

type DataBaseConfig

type DataBaseConfig struct {
	Driver   string `json:"driver"`
	User     string `json:"user"`
	Password string `json:"password"`
	Host     string `json:"host"`
	Port     string `json:"port"`
	DBName   string `json:"db_name"`
	Charset  string `json:"charset"`
	ShowSql  bool   `json:"show_sql"`
}

type JsonParse

type JsonParse struct {
}

type OrmTool

type OrmTool struct {
	*xorm.Engine
}

var DBEngine *OrmTool

func InitOrmEngine

func InitOrmEngine(cfg *Config) (*OrmTool, error)

type RedisConfig

type RedisConfig struct {
	Addr     string `json:"addr"`
	Port     string `json:"port"`
	Password string `json:"password"`
	Db       int    `json:"db"`
}

type RedisStore

type RedisStore struct {
	Client *redis.Client
}

func InitRedisStore

func InitRedisStore() *RedisStore

初始化RedisStore

func (*RedisStore) Get

func (s *RedisStore) Get(id string, clear bool) (value string)

* 这个库是直接集成了Redis,这里实现的是GET方法

func (*RedisStore) Set

func (s *RedisStore) Set(id string, value string)

* 这里实现的是Set方法

type SmsConfig

type SmsConfig struct {
	SignName     string `json:"sign_name"`
	TemplateCode string `json:"template_code"`
	AppKey       string `json:"app_key"`
	AppSecret    string `json:"app_secret"`
	RegionId     string `json:"region_id"`
}