common

package

v0.0.0-...-26cf1d4 Latest Latest Go to latest Published: Jan 31, 2021 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

gitee.com/marcellos/wyi-admin

Documentation ¶

Index ¶

Constants
Variables
func DelCache(token string) error
func Error(ctx *gin.Context, err error)
func ErrorSystem(ctx *gin.Context, err error)
func FieldTraceId(ctx interface{}) zap.Field
func GetCache(token string) string
func GetLoginSession(token string) (*model.User, error)
func Paginator(page, pageSize int, count int64) map[string]interface{}
func ParseBody(ctx *gin.Context, header *proto.RequestHeader, request interface{}) error
func RenderJson(ctx *gin.Context, data interface{})
func ResetCache(token string, expiration time.Duration) bool
func SetCache(token, session string, expiration time.Duration) bool
func SetLoginSession(token string, data *model.User) error
func SwapGinContext(ctx2 *context.Context, ctx *gin.Context)
type AdminContext
- func GetAdminContext(ctx context.Context) *AdminContext
- func GetAdminContextFromGin(ctx *gin.Context) *AdminContext
type AdminError
- func NewAdminError(code proto.RetCode, message string) *AdminError
- func (a *AdminError) Code() proto.RetCode
- func (a *AdminError) Error() string
type Request
type Result

Constants ¶

View Source

const (
	ViewAdminGroupName = "/admin"
	ApiAdminGroupName  = "/cgi-bin/v1"
)

View Source

const (
	ViewUrlLogin              = "/login"
	ViewUrlDashboard          = "/dashboard"
	ViewUrlArticleList        = "/article/list"
	ViewUrlArticleSave        = "/article/save"
	ViewUrlUserList           = "/user/list"
	ViewUrlUserSave           = "/user/save"
	ViewUrlUserModifyPassword = "/user/modify-password"
	ViewUrlSitePreferences    = "/site/preferences"
)

界面url定义

View Source

const (
	ApiUrlArticleList    = "/Admin/GetArticleList"
	ApiUrlArticleSave    = "/Admin/SaveArticle"
	ApiUrlArticleDelete  = "/Admin/DeleteArticle"
	ApiUrlArticleGetById = "/Admin/GetArticleById"

	ApiUrlLogin              = "/Admin/UserLogin"
	ApiUrlUserLogout         = "/Admin/UserLogout"
	ApiUrlUserSave           = "/Admin/UserSave"
	ApiUrlUserModifyPassword = "/Admin/UserModifyPassword"
	ApiUrlUserList           = "/Admin/GetUserList"

	// 公共接口
	ApiUrlCommonUploadAttach = "/Admin/UploadAttachment"
)

接口url定义

View Source

const AdminContextName = "AdminContext"

将前端传过来的东西转换成后端的context.Context必要的

Variables ¶

View Source

var AuthWhitePrefixUrl = map[string]byte{
	"/source":     0x0,
	"/attachment": 0x0,
}

鉴权白名单前缀匹配

View Source

var AuthWhiteUrl = map[string]byte{
	UrlMap["U10001"]: 0x0,
	UrlMap["U00005"]: 0x0,
	UrlMap["U00004"]: 0x0,
}

鉴权白名单, 不需要鉴权的url

View Source

var ErrCodeString = map[proto.RetCode]string{
	proto.RetCode_Success:             "成功",
	proto.RetCode_ErrorParam:          "参数错误",
	proto.RetCode_ErrorSystem:         "系统错误",
	proto.RetCode_ErrorNotFound:       "没有找到数据",
	proto.RetCode_ErrorSessionExpired: "登录过期或没有登录",
	proto.RetCode_ErrorOldPassword:    "旧密码错误",
	proto.RetCode_ErrorPassword:       "密码错误",
	proto.RetCode_ErrorEmailFormat:    "邮箱格式错误",
}

错误码对应的文字

View Source

var UrlMap = map[string]string{

	"U10001": ViewAdminGroupName + ViewUrlLogin,
	"U10002": ViewAdminGroupName + ViewUrlDashboard,
	"U10003": ViewAdminGroupName + ViewUrlArticleList,
	"U10004": ViewAdminGroupName + ViewUrlArticleSave,
	"U10005": ViewAdminGroupName + ViewUrlUserList,
	"U10006": ViewAdminGroupName + ViewUrlUserSave,
	"U10008": ViewAdminGroupName + ViewUrlUserModifyPassword,
	"U10007": ViewAdminGroupName + ViewUrlSitePreferences,

	"U00004": ApiAdminGroupName + ApiUrlCommonUploadAttach,

	"U00005": ApiAdminGroupName + ApiUrlLogin,
	"U00011": ApiAdminGroupName + ApiUrlUserLogout,

	"U00006": ApiAdminGroupName + ApiUrlArticleList,
	"U00007": ApiAdminGroupName + ApiUrlArticleSave,
	"U00008": ApiAdminGroupName + ApiUrlArticleDelete,
	"U00010": ApiAdminGroupName + ApiUrlArticleGetById,

	"U00012": ApiAdminGroupName + ApiUrlUserList,
	"U00009": ApiAdminGroupName + ApiUrlUserSave,
	"U00013": ApiAdminGroupName + ApiUrlUserModifyPassword,
}

Functions ¶

func DelCache ¶

func DelCache(token string) error

func Error ¶

func Error(ctx *gin.Context, err error)

自定义错误

func ErrorSystem ¶

func ErrorSystem(ctx *gin.Context, err error)

系统错误

func FieldTraceId ¶

func FieldTraceId(ctx interface{}) zap.Field

打日志用的trace id

func GetCache ¶

func GetCache(token string) string

func GetLoginSession ¶

func GetLoginSession(token string) (*model.User, error)

获取登录后的session

func Paginator ¶

func Paginator(page, pageSize int, count int64) map[string]interface{}

func ParseBody ¶

func ParseBody(ctx *gin.Context, header *proto.RequestHeader, request interface{}) error

解析body

func RenderJson ¶

func RenderJson(ctx *gin.Context, data interface{})

成功返回

func ResetCache ¶

func ResetCache(token string, expiration time.Duration) bool

func SetCache ¶

func SetCache(token, session string, expiration time.Duration) bool

func SetLoginSession ¶

func SetLoginSession(token string, data *model.User) error

func SwapGinContext ¶

func SwapGinContext(ctx2 *context.Context, ctx *gin.Context)

Types ¶

type AdminContext ¶

type AdminContext struct {
	TraceId string `json:"trace_id"`
	Token   string `json:"token"`
}

context通用存储结构

func GetAdminContext ¶

func GetAdminContext(ctx context.Context) *AdminContext

func GetAdminContextFromGin ¶

func GetAdminContextFromGin(ctx *gin.Context) *AdminContext

type AdminError ¶

type AdminError struct {
	// contains filtered or unexported fields
}

自定义错误

func NewAdminError ¶

func NewAdminError(code proto.RetCode, message string) *AdminError

生成一个带code的错误

func (*AdminError) Code ¶

func (a *AdminError) Code() proto.RetCode

func (*AdminError) Error ¶

func (a *AdminError) Error() string

type Request ¶

type Request struct {
	Header *proto.RequestHeader `json:"header"`
	Data   interface{}          `json:"data"`
}

JSON 请求通用格式

type Result ¶

type Result struct {
	Header *proto.ResponseHeader `json:"header"`
	Data   interface{}           `json:"data"`
}

JSON 返回通用格式

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
log

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL