crane

README

Crane

Configurable integration tool

Description

Crane It is not a framework, but a layer of three-party libraries that may be needed for daily use, so that some libraries can support automatic reloading by modifying the configuration, making web development more convenient, instead of integrating various libraries before development Tools, bother

Installation

• go get

go get -u github.com/kenretto/crane

• git submodule
  • git submodule add

    git submodule add https://github.com/kenretto/crane.git 
    

  • go.mod replace (open go.mod)

    replace (
    	github.com/kenretto/crane version hash => your submodule crane path
    )
    

Examples

• see https://github.com/kenretto/crane/tree/master/example

Usage

If you are using the method build in the example, launch the Crane.Run method start, Then, using buildout-binary start will make the service separate from the parent process that started it, and run in the mode of daemon, If you run with buildout-binary start --daemon=false, the service will remain in the current session(this will facilitate debugging at development time, such as using GoLand)

Documentation

Overview

Package crane ...

Index

• type Crane
  • func NewCrane(config string) (crane *Crane, err error)
  • func (crane *Crane) Captcha() *captcha.Captcha
  • func (crane *Crane) Handler(handler func(router *gin.Engine))
  • func (crane *Crane) Logger() *logrus.Logger
  • func (crane *Crane) ORM(db ...string) *gorm.DB
  • func (crane *Crane) Run()
  • func (crane *Crane) Sessions() *sessions.Sessions
• type Logger
  • func (logger *Logger) WithFields(fields server.Fields) server.ILogger

Types

type Crane

type Crane struct {
	Configurator *configurator.Configurator

	Password *password.Password
	Redis    *redis.Redis
	// contains filtered or unexported fields
}

Crane summarize sub-package configuration

func NewCrane

func NewCrane(config string) (crane *Crane, err error)

NewCrane 子目录的每个库其实都是可以单独使用的, 如果想要整个依赖, 建议使用这个方法来初始化

func (*Crane) Captcha

func (crane *Crane) Captcha() *captcha.Captcha

Captcha 获取验证码操作

func (*Crane) Handler

func (crane *Crane) Handler(handler func(router *gin.Engine))

Handler set handler

func (*Crane) Logger

func (crane *Crane) Logger() *logrus.Logger

Logger 获取 logger

func (*Crane) ORM

func (crane *Crane) ORM(db ...string) *gorm.DB

ORM 获取 gorm 的操作

func (*Crane) Run

func (crane *Crane) Run()

Run start service

func (*Crane) Sessions

func (crane *Crane) Sessions() *sessions.Sessions

Sessions get sessions

type Logger

type Logger struct {
	*logrus.Logger
}

Logger encapsulating logrus

func (*Logger) WithFields

func (logger *Logger) WithFields(fields server.Fields) server.ILogger

WithFields encapsulating logrus