system

Documentation

Index

• Variables
• func GetConfig() *config
• func GetGinConfig() (ginConfig *ginConfig)
• func GetServerConfig() (serverConfig *serverConfig)
• func GetSignKey() string
• func GetTokenConfig() (tokenConfig *tokenConfig)
• func GetWechatConfig() (wechatConfig *wechatConfig)
• func JWTAuth() gin.HandlerFunc
• func LoadConfig(path string) error
• func LoadDatasourceConfig(path string) error
• func LoadServerConfig(path string) error
• func LoadTokenConfig(path string) error
• func Logger(log *logrus.Logger) gin.HandlerFunc
• func SetSignKey(key string) string
• type CustomClaims
• type DB
  • func GetDatasource() (datasource []*DB)
• type Header
• type JWT
  • func NewJWT() *JWT
  • func (j *JWT) CreateToken(claims CustomClaims) (string, error)
  • func (j *JWT) RefreshToken(tokenString string) (string, error)
  • func (j *JWT) ResolveToken(tokenString string) (*CustomClaims, error)

Variables

var (
	TokenExpired     = errors.New("token 已经过期")
	TokenNotValidYet = errors.New("token 尚未激活")
	TokenMalformed   = errors.New("token 格式错误")
	TokenInvalid     = errors.New("token 无法解析")
	SignKey          = "82060692FEFAC4511FC65110ADAB0F88a"
)

定义一些常量

Functions

func GetConfig

func GetConfig() *config

获取配置文件

func GetGinConfig

func GetGinConfig() (ginConfig *ginConfig)

获取 gin 配置

func GetServerConfig

func GetServerConfig() (serverConfig *serverConfig)

获取项目启动配置

func GetSignKey

func GetSignKey() string

获取 signKey

func GetTokenConfig

func GetTokenConfig() (tokenConfig *tokenConfig)

获取Token配置

func GetWechatConfig

func GetWechatConfig() (wechatConfig *wechatConfig)

获取 wechat 配置

func JWTAuth

func JWTAuth() gin.HandlerFunc

func LoadConfig

func LoadConfig(path string) error

如果配置文件写成一个文件，调下面的方法

func LoadDatasourceConfig

func LoadDatasourceConfig(path string) error

func LoadServerConfig

func LoadServerConfig(path string) error

func LoadTokenConfig

func LoadTokenConfig(path string) error

func Logger

func Logger(log *logrus.Logger) gin.HandlerFunc

定义 基于logrus 的log中间件

func SetSignKey

func SetSignKey(key string) string

Types

type CustomClaims

type CustomClaims struct {
	ID     uint64 `json:"userId"`
	Name   string `json:"name"`
	Phone  string `json:"phone"`
	Openid string `json:"openid"`
	jwt.StandardClaims
}

载荷，加一些系统需要的信息

type DB

type DB struct {
	Driver string
	Nodes  datasource
}

func GetDatasource

func GetDatasource() (datasource []*DB)

获取数据库连接配置

type Header

type Header struct {
	Token string `form:"token" `
}

type JWT

type JWT struct {
	SigningKey []byte
}

jwt签名结构

func NewJWT

func NewJWT() *JWT

新建一个 jwt 实例

func (*JWT) CreateToken

func (j *JWT) CreateToken(claims CustomClaims) (string, error)

生成 tokenConfig

func (*JWT) RefreshToken

func (j *JWT) RefreshToken(tokenString string) (string, error)

更新token

func (*JWT) ResolveToken

func (j *JWT) ResolveToken(tokenString string) (*CustomClaims, error)

解析 tokenConfig