goio

README

go.io

framework interfaces and configurations for libraries

package main

import (
	"github.com/gif-gif/go.io/goio"
	"github.com/gif-gif/go.io/goio/test/router"
)

func main() {
	startSever()
}

func startSever() {
	goio.Init(goio.DEVELOPMENT)
	s := goio.NewServer(
		goio.ServerNameOption("serverName"),
		goio.EnvOption(goio.Env),
		//goio.EnableEncryptionOption(),
		goio.PProfEnableOption(false),
		goio.NoLogPathsOption("/captcha/get"),
	)

	// 路由
	router.Routes(s.Group("/"))
	// 启动
	s.Run(":1000")
}

curl --location --request POST 'http://127.0.0.1:1000/health' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)'

Documentation

Index

• Constants
• Variables
• func ClientIP(c *gin.Context) string
• func CreateToken(appId string, openid int64) (tokenStr string, err error)
• func FlagInit()
• func GrpcContext(c *gin.Context) context.Context
• func Handler(controller iController) gin.HandlerFunc
• func Init(env Environment)
• func LoadJsonConfig(jsonFile string, conf interface{}) (err error)
• func LoadYamlConfig(yamlFile string, conf interface{}) (err error)
• func RequestBody(c *gin.Context) interface{}
• func RequestId(c *gin.Context) string
• func ValidationMessage(err error, messages map[string]string) string
• type Config
• type Encryption
  • func (enc *Encryption) Decode(str string) (b []byte, err error)
  • func (enc *Encryption) Encode(b []byte) (str string, err error)
• type Environment
  • func (env Environment) String() string
  • func (env Environment) Tag() string
• type LocalUpload
  • func (lu LocalUpload) Upload(c *gin.Context, uploadDir string) *Response
• type Option
  • func CorsHeaderOption(corsHeaders ...string) Option
  • func EnableEncryptionOption(encryptKey, encryptSecret string, excludeUris ...string) Option
  • func EnvOption(env Environment) Option
  • func NoAccessPathsOption(noAccessPaths ...string) Option
  • func NoLogPathsOption(noLogPaths ...string) Option
  • func PProfEnableOption(pprofEnable bool) Option
  • func ServerNameOption(serverName string) Option
• type Response
  • func Error(code int32, message string, v ...interface{}) *Response
  • func ErrorWithValidate(err error, messages map[string]string) *Response
  • func Success(data interface{}) *Response
  • func (rsp *Response) Copy() *Response
  • func (rsp *Response) String() string
• type Server
  • func NewServer(opt ...Option) *Server
  • func (s *Server) Run(addr string)
• type Token
  • func ParseToken(tokenStr, appId string) (token *Token, err error)
  • func (t *Token) Bytes() []byte
  • func (t *Token) String() string

Constants

const ERROR_DATABASE int64 = 555

const ERROR_FORBIDDEN int64 = 403

const ERROR_INVALID int64 = -1

const ERROR_NOTFOUND int64 = 404

const ERROR_PARAMS int64 = 700

const ERROR_REDIS int64 = 556

const ERROR_REQUEST int64 = 400

client

const ERROR_SERVER int64 = 500

server

const ERROR_UNAUTHORIZED int64 = 401

const SUCCESS_REQUEST = 0

Variables

var (
	Version     string
	VersionFlag = flag.Bool("v", false, "version")

	HelpFlag = flag.Bool("h", false, "help")
)

var (
	UnknownStatus = 0
	StatusValid   = 1
	StatusInValid = 2
)

Functions

func ClientIP

func ClientIP(c *gin.Context) string

客户端IP

func CreateToken

func CreateToken(appId string, openid int64) (tokenStr string, err error)

func FlagInit

func FlagInit()

func GrpcContext

func GrpcContext(c *gin.Context) context.Context

func Handler

func Handler(controller iController) gin.HandlerFunc

定义控制器调用实现

func Init

func Init(env Environment)

func LoadJsonConfig

func LoadJsonConfig(jsonFile string, conf interface{}) (err error)

func LoadYamlConfig

func LoadYamlConfig(yamlFile string, conf interface{}) (err error)

func RequestBody

func RequestBody(c *gin.Context) interface{}

请求数据

func RequestId

func RequestId(c *gin.Context) string

唯一ID

func ValidationMessage

func ValidationMessage(err error, messages map[string]string) string

Types

type Config

type Config struct {
	Env Environment `yaml:"env"`

	Server struct {
		Addr string `yaml:"addr"`
		Name string `yaml:"name"`
	} `yaml:"server"`

	Prometheus  prometheusx.Config  `yaml:"prometheus"`
	MongoDB     gomongo.Config      `yaml:"mongodb"`
	Mysql       gogorm.Config       `yaml:"mysql"`
	Postgres    gogorm.Config       `yaml:"postgres"`
	Sqlite      gogorm.Config       `yaml:"sqlite"`
	Clickhouse1 gogorm.Config       `yaml:"clickhouse1"`
	Redis       goredis.Config      `yaml:"redis"`
	Kafka       gokafka.Config      `yaml:"kafka"`
	Clickhouse  goclickhouse.Config `yaml:"clickhouse"`
	Es          goes.Config         `yaml:"es"`

	Etcd goetcd.Config `yaml:"etcd"`

	FeiShu string `yaml:"feishu"`
}

type Encryption

type Encryption struct {
	Key    string
	Secret string
}

func (*Encryption) Decode

func (enc *Encryption) Decode(str string) (b []byte, err error)

func (*Encryption) Encode

func (enc *Encryption) Encode(b []byte) (str string, err error)

type Environment

type Environment string

const (
	PRODUCTION  Environment = "pro"
	PRE         Environment = "pre"
	RT          Environment = "rt"
	TEST        Environment = "test"
	DEVELOPMENT Environment = "dev"
)

库运行模式 dev|test|rt|pre|pro go-zero

var Env Environment //string `json:",default=pro,options=dev|test|rt|pre|pro"`

当前运行环境

func (Environment) String

func (env Environment) String() string

func (Environment) Tag

func (env Environment) Tag() string

type LocalUpload

type LocalUpload struct {
}

func (LocalUpload) Upload

func (lu LocalUpload) Upload(c *gin.Context, uploadDir string) *Response

type Option

type Option interface {
	// contains filtered or unexported methods
}

func CorsHeaderOption

func CorsHeaderOption(corsHeaders ...string) Option

跨域

func EnableEncryptionOption

func EnableEncryptionOption(encryptKey, encryptSecret string, excludeUris ...string) Option

启用加密传输

func EnvOption

func EnvOption(env Environment) Option

运行环境

func NoAccessPathsOption

func NoAccessPathsOption(noAccessPaths ...string) Option

禁止访问的path

func NoLogPathsOption

func NoLogPathsOption(noLogPaths ...string) Option

不记录日志的path

func PProfEnableOption

func PProfEnableOption(pprofEnable bool) Option

开启分析

func ServerNameOption

func ServerNameOption(serverName string) Option

服务名称

type Response

type Response struct {
	Code    int32         `json:"code"`
	Message string        `json:"message"`
	Data    interface{}   `json:"data"`
	Errors  []interface{} `json:"-"`
}

func Error

func Error(code int32, message string, v ...interface{}) *Response

func ErrorWithValidate

func ErrorWithValidate(err error, messages map[string]string) *Response

func Success

func Success(data interface{}) *Response

func (*Response) Copy

func (rsp *Response) Copy() *Response

func (*Response) String

func (rsp *Response) String() string

type Server

type Server struct {
	*gin.Engine
}

自己定义web服务

func NewServer

func NewServer(opt ...Option) *Server

func (*Server) Run

func (s *Server) Run(addr string)

启动服务

type Token

type Token struct {
	AppId     string `json:"app_id"`
	OpenId    int64  `json:"data"`
	NonceStr  string `json:"nonce"`
	Timestamp int64  `json:"ts"`
}

func ParseToken

func ParseToken(tokenStr, appId string) (token *Token, err error)

func (*Token) Bytes

func (t *Token) Bytes() []byte

func (*Token) String

func (t *Token) String() string