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 FlagInit()
• func Init(env Environment, name ...string)
• func Setup(feishu string)
• func SetupLogDefault()
• type Environment
  • func (env Environment) String() string
  • func (env Environment) Tag() 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
)

var Name string

Functions

func FlagInit

func FlagInit()

func Init

func Init(env Environment, name ...string)

func Setup

func Setup(feishu string)

日志级别一键设置， 测试环境和生产环境发送飞书消息

也可以不用这个方法，项目中可以自定义， golog.WithHook 多次调用不会覆盖，每次调用都会生效

func SetupLogDefault

func SetupLogDefault()

Types

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 = "dev" //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