Introduction

​ This project is the package of the basic project framework of the company’s go iris, including configuration file reading, database transaction package, graceful shutdown, basic return parameter package, http package and many other new features. Currently, business systems are recommended to use this System. At the beginning of the project, in order to unify the framework and technology stack of the company, the project will inevitably have bugs or issues. If there are related problems, welcome to point out. I believe that on top of our continuous optimization and iterative version, he will become more The better.

History

Version	Date	type	description
1.0.0	2020-07-20	common

Architecture

Software architecture description.

Guide

1. go get github.com/m2c/kiplestar

Instructions

1. Conditions of use: go SDK version >=14
2. application.yaml is a public file
3. application-dev.yaml represents the dev environment, application-prod.yaml represents the production environment, application-xxx.yaml represents the relationship between the xxx environment and the user's custom environment, and there is an option profile in the application-dev.yaml configuration : dev means the configuration file that activates the xxx environment

Get Start

func main() {
    // init servver
	server := kiplestar.GetKipleServerInstance()
	server.Default()
	
    // if you use mysql or redis
	server.StartServer(kiplestar.Mysql_service, kiplestar.Redis_service)
	// if you want to load your own config.
    server.LoadCustomizeConfig(&{your struct name})

    // init mvc controller
    server.RegisterController(router.RegisterGlobalModel) // paramter 'router.RegisterGlobalModel' is func(app *iris.Application)
    // start iris app
	server.WaitClose()
}

Core function Example

1. Transfer() API description

func Transfer(values url.Values, s interface{}) error
1.first define the struct
type User struct {
    Name string    `param:"name,xiaohong" json:"name"`// the first tag name(name) means that the request name and the second name(zfh) means that the request has no  the request name we will get the default value.
	No int         `param:"no,100" json:"no"`
	Time time.Time `param:"time,2029-09-02T15:04:05Z" json:"time"`
}
2.call the Transfer function
    u:=User{}
	if err:=utils.Transfer(slf.Ctx.Request().URL.Query(),&u);err!=nil{
		slf.Ctx.JSON(commons.BuildFailedWithMsg(commons.ParameterError,err.Error()))
		return
	}
	// todo: do some business
	slf.Ctx.JSON(commons.BuildSuccess(u))
3. call the string append function
   Append(source string, strings... string)
   example:
   s, err := Append("string1", "string2")
   if er!=nil{
    // todo: handle the error
   }
4. produce the random uppercase and lowercase letters
   func RandomSixString(length int) string
   length: the random string
   example:
   func TestRandomSixString(t *testing.T) {
   	fmt.Println(RandomSixString(6))

   }

Project structure

├─commons //common package
│  ├─error//error wrap
│  ├─log  // log 
│  ├─time // time format
│  └─utils //often utils tools
├─config   //configration file parse
├─database //gorm datasource
├─iris //iris
├─kafka //kafka client 
├─kipledb //dao base struct
├─middleware// often middlewares
└─redis  //redis

Contact :

mark：mark.jiang@greenpacket.com.cn

seven: seven.zhang@greenpacket.com.cn