common

package

v0.0.0-...-25ebaee Latest Latest Go to latest Published: Jul 13, 2019 License: MIT Imports: 12 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

github.com/nuaa-open-source/gin-boilerplate

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func DefaultConfig() error
func ErrorHandling() gin.HandlerFunc
func FuncHandler(c *gin.Context, i interface{}, judge interface{}, option ...interface{}) bool
func GetLogFile() *os.File
func GetMySQL() *gorm.DB
func InitLogger()
func InitMySQL() *gorm.DB
func InitSentry()
func MaintenanceHandling() gin.HandlerFunc
func SetConfig() error
func WatchConfig() error
type Database
type GeneralReturn

Constants ¶

View Source

const (
	CSRF_SESSION_NAME string = "example-session"
	CSRF_SECRET       string = "example-secret"
)

View Source

const VERSION = "1.0.0-alpha"

application version

Variables ¶

View Source

var CORS_ALLOW_DEBUG_ORIGINS = []string{
	"http://*",
	"https://*",
}

View Source

var CORS_ALLOW_HEADERS = []string{
	"Origin",
	"Content-Length",
	"Content-Type",
	"Token",
	"X-CSRF-TOKEN",
	"withCredentials",
}

View Source

var CORS_ALLOW_METHODS = []string{
	"GET",
	"POST",
	"PUT",
	"PATCH",
	"DELETE",
	"HEAD",
}

View Source

var CORS_ALLOW_ORIGINS = []string{
	"https://example.a2os.club",
	"https://test.example.a2os.club",
	"http://example.a2os.club",
	"http://test.example.a2os.club",
}

Cross-sites resource sharing settings

View Source

var CORS_EXPOSE_HEADERS = []string{
	"X-CSRF-TOKEN",
	"Token",
}

View Source

var CSRF_COOKIE_SECRET = []byte("csrf-secret")

View Source

var Errors = map[int]string{

	0: "OK",

	10001: "System error",
	10002: "Service unavailable",
	10003: "Parameter error",
	10004: "Parameter value invalid",
	10005: "Missing required parameter",
	10006: "Resource unavailable",
	10007: "CSRF token mismatch",
	10008: "This service is undergoing maintenance",

	20000: "Application error",
}

Errors 错误码

View Source

var (
	MySQL *gorm.DB
)

Functions ¶

func DefaultConfig ¶

func DefaultConfig() error

func ErrorHandling ¶

func ErrorHandling() gin.HandlerFunc

ErrorHandling 错误处理中间件

func FuncHandler ¶

func FuncHandler(c *gin.Context, i interface{}, judge interface{}, option ...interface{}) bool

FuncHandler 统一错误处理 i 传入error,bool,int judge 触发正确值非error环境下有效如果触发了错误 return True Example: 1. common.FuncHandler(c, c.BindJSON(&x), nil, http.StatusBadRequest, 20301)

==   if(c.BindJSON(&x) != nil){
			c.JSON(http.StatusBadRequest, gin.H{
			"err_code": 20301,
			"message":  common.Errors[20301],
			})
	 	}

2. common.FuncHandler(c, c.BindJSON(&x), nil, http.StatusBadRequest, 20301,fmt.Sprintf("BindJson fail with %v",x))

==   if(c.BindJSON(&x) != nil){
			log.Println(fmt.Sprintf("BindJson fail with %v",x))
			c.JSON(http.StatusBadRequest, gin.H{
			"err_code": 20301,
			"message":  common.Errors[20301],
			})
	 	}

3. common.FuncHandler(c, isOdd(2), true, fmt.Sprintf("%d is even",2))

==   if(isOdd(2) != true){
			log.Println(fmt.Sprintf("%d is even",2))
	 	}

func GetLogFile ¶

func GetLogFile() *os.File

func GetMySQL ¶

func GetMySQL() *gorm.DB

func InitLogger ¶

func InitLogger()

func InitMySQL ¶

func InitMySQL() *gorm.DB

func InitSentry ¶

func InitSentry()

func MaintenanceHandling ¶

func MaintenanceHandling() gin.HandlerFunc

func SetConfig ¶

func SetConfig() error

func WatchConfig ¶

func WatchConfig() error

Types ¶

type Database ¶

type Database struct {
	*gorm.DB
}

type GeneralReturn ¶

type GeneralReturn struct {
	CustomMessage string
	HTTPStatus    int
	AppErrJSON    appErrJSON
}

GeneralReturn 通用码

Source Files ¶

View all Source files

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