goapp

README

goapp

The package is used to initialize an application to simply the creation.

Install

$ go get -u github.com/xgfone/goapp

Usage

package main

import (
	"github.com/xgfone/gconf/v5"
	"github.com/xgfone/gconf/v5/field"
	"github.com/xgfone/goapp"
	"github.com/xgfone/goapp/router"
	"github.com/xgfone/ship/v3"
)

// Define some options.
var (
	conf config
	opts = []gconf.Opt{
		gconf.StrOpt("opt1", "help doc"),
		gconf.IntOpt("opt2", "help doc"),
	}
)

type config struct {
	Addr field.StringOptField `default:":80" help:"The address to listen to."`
}

func main() {
	// Initialize the app configuration
	goapp.Init("app", &conf, opts)

	// Initialize and start the app router.
	app := router.InitRouter()
	app.Route("/path1").GET(ship.OkHandler())
	app.Route("/path2").GET(func(c *ship.Context) error { return c.Text(200, "OK") })
	app.Start(conf.Addr.Get()).Wait()
}

Build the application above by using the script build.sh like this,

$ ./build.sh

$ ./app --help
  --addr string
        The address to listen to. (default ":80")
  --config-file string
        the config file path.
  --logfile string
        The file path of the log. The default is stdout.
  --loglevel string
        The level of the log, such as debug, info (default "info")
  --opt1 string
        help doc
  --opt2 int
        help doc
  --version bool
        Print the version and exit.

Documentation

Index

• Variables
• func Init(appName string, configOptions ...interface{})
• func InitApp(appName, version string, options ...interface{})
• func InitApp2(appName, version, logfilesize string, logfilenum int, options ...interface{})
• func Unix(sec, nsec int64) time.Time

Variables

var AppRouter = router.App

AppRouter is the default app router.

Functions

func Init

func Init(appName string, configOptions ...interface{})

Init is equal to InitApp(appName, gover.Text(), configOptions...).

func InitApp

func InitApp(appName, version string, options ...interface{})

InitApp initializes the application, which is equal to

InitApp2(appName, version, "100M", 100, options...)

func InitApp2

func InitApp2(appName, version, logfilesize string, logfilenum int, options ...interface{})

InitApp2 initializes the application.

1. Register the log options.
2. Initialize configuration.
3. Initialize the logging.

func Unix

func Unix(sec, nsec int64) time.Time

Unix returns a time with unixstamp in UTC location.