ginApp

README

gin-app（开发中）

基于gin的app框架

Documentation

Index

• type GinApp
  • func Instance() *GinApp
  • func (app *GinApp) DefaultLoadConfig(configDirPath string)
  • func (app *GinApp) Engine() *gin.Engine
  • func (app *GinApp) GetCommonPath() string
  • func (app *GinApp) GetDb() *gorm.DB
  • func (app *GinApp) GetRootPath() string
  • func (app *GinApp) InitIdentify(expirePeriod, gcPeriod time.Duration)
  • func (app *GinApp) InitSession() error
  • func (app *GinApp) Mode() string
  • func (app *GinApp) Run(addr ...string) *GinApp
  • func (app *GinApp) SetCommonPath(commonPath string)
  • func (app *GinApp) SetMode(mode string)
  • func (app *GinApp) SetRootPath(root string)

Types

type GinApp

type GinApp struct {
	AppConfig *config.AppConfig // app的配置信息
	Db        *gorm.DB          // 默认数据库，主库
	// contains filtered or unexported fields
}

func Instance

func Instance() *GinApp

* app单例

func (*GinApp) DefaultLoadConfig

func (app *GinApp) DefaultLoadConfig(configDirPath string)

func (*GinApp) Engine

func (app *GinApp) Engine() *gin.Engine

func (*GinApp) GetCommonPath

func (app *GinApp) GetCommonPath() string

func (*GinApp) GetDb

func (app *GinApp) GetDb() *gorm.DB

* 获取默认db

func (*GinApp) GetRootPath

func (app *GinApp) GetRootPath() string

* 读取项目根目录

func (*GinApp) InitIdentify

func (app *GinApp) InitIdentify(expirePeriod, gcPeriod time.Duration)

* 初始化验证码模块

func (*GinApp) InitSession

func (app *GinApp) InitSession() error

* 初始化session配置

func (*GinApp) Mode

func (app *GinApp) Mode() string

func (*GinApp) Run

func (app *GinApp) Run(addr ...string) *GinApp

func (*GinApp) SetCommonPath

func (app *GinApp) SetCommonPath(commonPath string)

* 设置common文件夹

func (*GinApp) SetMode

func (app *GinApp) SetMode(mode string)

* 设置当前运行环境：debug、test、release

func (*GinApp) SetRootPath

func (app *GinApp) SetRootPath(root string)

* 设置项目根目录，通常是web所在目录