goapp

README

goapp

The package is used to initialize an application to simply the creation. Support Go1.12+.

Install

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

Usage

package main

import (
	"github.com/xgfone/gconf/v6"
	"github.com/xgfone/go-atexit"
	"github.com/xgfone/go-log"
	"github.com/xgfone/goapp"
	"github.com/xgfone/goapp/router"
	"github.com/xgfone/ship/v5"
)

var opts = []gconf.Opt{
	gconf.StrOpt("opt1", "help doc"),
	gconf.IntOpt("opt2", "help doc"),
}

func main() {
	addr := gconf.NewString("addr", ":80", "The address to listen to.")
	goapp.Init("app", opts...)

	// Initialize the app router.
	app := router.InitRouter(nil)
	app.Logger = log.DefalutLogger
	app.Use(router.Logger(true), router.Recover)
	app.Route("/path1").GET(ship.OkHandler())
	app.Route("/path2").GET(func(c *ship.Context) error { return c.Text(200, "OK") })

	// Start the HTTP server.
	runner := ship.NewRunner(app)
	runner.RegisterOnShutdown(atexit.Execute)
	runner.Start(addr.Get())
}

Build the application above by Makefile like this,

$ make

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

Documentation

Index

• func CallInit() (err error)
• func GetCallStack(depth int) stack.CallStack
• func Init(appName string, opts ...gconf.Opt)
• func InitApp(appName, version string, opts ...gconf.Opt)
• func InitApp2(appName, version, logfilesize string, logfilenum int, opts ...gconf.Opt)
• func InitConfig(app, version string, opts ...gconf.Opt)
• func Must(err error, msg string, args ...interface{})
• func Panic(err error, msg string, args ...interface{})
• func RegisterInit(initfuncs ...func() error)
• func Unix(sec, nsec int64) time.Time
• type PanicError
  • func NewPanicError(panic interface{}, depth int) PanicError
  • func (pe PanicError) Error() string

Functions

func CallInit

func CallInit() (err error)

CallInit calls the registered initialization functions.

func GetCallStack

func GetCallStack(depth int) stack.CallStack

GetCallStack returns the stacks of the caller.

func Init

func Init(appName string, opts ...gconf.Opt)

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

func InitApp

func InitApp(appName, version string, opts ...gconf.Opt)

InitApp initializes the application, which is equal to

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

func InitApp2

func InitApp2(appName, version, logfilesize string, logfilenum int, opts ...gconf.Opt)

InitApp2 initializes the application.

1. Register the log options.
2. Initialize configuration.
3. Initialize the logging.
4. Call the registered initialization functions.

func InitConfig

func InitConfig(app, version string, opts ...gconf.Opt)

InitConfig initializes the configuration, which will set the version, register the options, parse the CLI arguments with "flag", load the "flag", "env" and "file" sources.

func Must

func Must(err error, msg string, args ...interface{})

Must logs the error with the msg and the program exits if err is not nil. Or do nothing.

func Panic

func Panic(err error, msg string, args ...interface{})

Panic panics with the msg if err is not nil. Or do nothing.

func RegisterInit

func RegisterInit(initfuncs ...func() error)

RegisterInit registers the initialization functions.

func Unix

func Unix(sec, nsec int64) time.Time

Unix returns a time with unixstamp in UTC location.

Types

type PanicError

type PanicError struct {
	Panic interface{}
	Stack stack.CallStack
}

PanicError is used to represent the panic error.

func NewPanicError

func NewPanicError(panic interface{}, depth int) PanicError

NewPanicError returns a new PanicError.

func (PanicError) Error

func (pe PanicError) Error() string