utils

Documentation

Index

• Constants
• func BcryptCheck(password, hash string) bool
• func BcryptHash(password string) string
• func ClearToken(c *gin.Context)
• func CreateDir(dirName string) bool
• func CreateUUID() string
• func DeleteFile(key string) error
• func DirExistOrNot(fileAddr string) bool
• func GetClaims(c *gin.Context) (*model.CustomClaims, error)
• func GetFileExt(fileHeader *multipart.FileHeader) string
• func GetMsg(code int) string
• func GetToken(c *gin.Context) string
• func GetUserId(c *gin.Context) int64
• func GetUserRole(c *gin.Context) string
• func IsAnyBlank(values ...interface{}) bool
• func Md5(str []byte, b ...byte) string
• func ParseDuration(d string) (time.Duration, error)
• func SaveFileLocal(fileHeader *multipart.FileHeader) (string, error)
• func SetToken(c *gin.Context, token string, maxAge int)
• func UploadFile(fileHeader *multipart.FileHeader) (string, error)
• type JWT
  • func NewJWT() *JWT
  • func (j *JWT) CreateClaims(baseClaims model.BaseClaims) model.CustomClaims
  • func (j *JWT) CreateToken(claims model.CustomClaims) (string, error)
  • func (j *JWT) ParseToken(token string) (*model.CustomClaims, int)

Constants

const (
	Success = 0 // 成功
	Error   = 1 // 失败
	Params  = 2 // 参数错误

	ErrorSystem           = 10001 // 系统错误
	ErrorDatabase         = 10002 // 数据库错误
	ErrorTokenAuth        = 10003 // token 认证错误
	ErrorTokenExpired     = 10004 // token 已经过期
	ErrorTokenNotValidYet = 10005 // token 尚未生效
	ErrorTokenMalformed   = 10006 // token 不符合规范
	ErrorTokenInvalid     = 10007 // token 无法处理
	ErrorRedis            = 10008 // redis 错误
	ErrorUpdate           = 10009 // 修改用户信息失败
	ErrorSearch           = 10010 // 搜索失败
	ErrorAdmin            = 10011 // 权限不足
	ErrorDelete           = 10012 // 删除失败
	ErrorFile             = 10013 // 上传文件失败

	ErrorRegister = 20001 // 注册失败
	ErrorNotLogin = 20002 // 未登录
	ErrorLogin    = 20003 // 登录失败
)

Functions

func BcryptCheck

func BcryptCheck(password, hash string) bool

BcryptCheck 对比明文密码和数据库的哈希值

func BcryptHash

func BcryptHash(password string) string

BcryptHash 使用 bcrypt 对密码进行加密

func ClearToken

func ClearToken(c *gin.Context)

ClearToken 用于清除名为 "a-token" 的 Cookie

func CreateDir

func CreateDir(dirName string) bool

CreateDir 创建文件夹

func CreateUUID

func CreateUUID() string

CreateUUID 创建 uuid

func DeleteFile

func DeleteFile(key string) error

DeleteFile 删除文件

func DirExistOrNot

func DirExistOrNot(fileAddr string) bool

DirExistOrNot 判断文件夹路径是否存在

func GetClaims

func GetClaims(c *gin.Context) (*model.CustomClaims, error)

func GetFileExt

func GetFileExt(fileHeader *multipart.FileHeader) string

GetFileExt 获取文件扩展名

func GetMsg

func GetMsg(code int) string

func GetToken

func GetToken(c *gin.Context) string

GetToken 用于从 Gin 上下文中获取名为 "a-token" 的 Token 优先从 Cookie 中获取，如果 Cookie 中没有，则从 Header 中获取

func GetUserId

func GetUserId(c *gin.Context) int64

func GetUserRole

func GetUserRole(c *gin.Context) string

func IsAnyBlank

func IsAnyBlank(values ...interface{}) bool

IsAnyBlank 判断传入的值是否有空值，如果有为空，就返回 true

func Md5

func Md5(str []byte, b ...byte) string

func ParseDuration

func ParseDuration(d string) (time.Duration, error)

ParseDuration 解析字符串表示的时间间隔，并返回 time.Duration 对象

func SaveFileLocal

func SaveFileLocal(fileHeader *multipart.FileHeader) (string, error)

SaveFileLocal 保存文件到文件, 返回的是相对路径

func SetToken

func SetToken(c *gin.Context, token string, maxAge int)

SetToken 用于在 Gin 上下文中设置名为 "a-token" 的 Cookie maxAge 参数表示 Cookie 的最大存活时间，单位是秒

func UploadFile

func UploadFile(fileHeader *multipart.FileHeader) (string, error)

UploadFile 上传文件

Types

type JWT

type JWT struct {
	SigningKey []byte // JWT 签名密钥
}

JWT 结构体定义了 JWT 相关的操作

func NewJWT

func NewJWT() *JWT

NewJWT 返回一个新的 JWT 实例，使用全局配置中的签名密钥

func (*JWT) CreateClaims

func (j *JWT) CreateClaims(baseClaims model.BaseClaims) model.CustomClaims

CreateClaims 组装 JWT 所需的声明信息

func (*JWT) CreateToken

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

CreateToken 根据传入的 claims 构造一个 token

func (*JWT) ParseToken

func (j *JWT) ParseToken(token string) (*model.CustomClaims, int)

ParseToken 解析 JWT 令牌，返回 CustomClaims 和状态码