app

Documentation

Overview

Package app define the App interface NOTE: your config like [app.yaml] if you use the package

app:
	name: your-app-name

log:
	filename: /tmp/your-app-name.log
	maxSize: 500
	maxBackups: 3
	maxAge: 3
	level: debug
	stdout: true

Index

• type Application
  • func New(name string, logger *zap.Logger, ss ...Server) (*Application, error)
  • func (a *Application) AwaitSingal()
  • func (a *Application) Start() error
• type Server

Examples

• Application

Types

type Application

type Application struct {
	// contains filtered or unexported fields
}

Application define application , run on test,aliyun,online

Example

ExampleApplicationn create a new application you need config[app.yaml]:

package main

import (
	"fmt"

	"github.com/feiquan123/go-program-framework/src/pkg/app"
	"github.com/feiquan123/go-program-framework/src/pkg/config"
	"github.com/feiquan123/go-program-framework/src/pkg/log"
)

// Server implement pkg.app.Server
type Server struct {
	desc string
}

func NewServer() app.Server {
	return &Server{"http、rpc、dns... server"}
}

func (s *Server) Start() error {
	fmt.Println("[START]", s.desc)
	return nil
}

func (s *Server) Stop() error {
	fmt.Println("[STOP]", s.desc)
	return nil
}

func (s *Server) Desc() string {
	return s.desc
}

// ExampleApplicationn create a new application
// you need config[app.yaml]:
func main() {
	/* app.yamls
	app:
		name: your-app-name

	log:
		filename: /tmp/your-app-name.log
		maxSize: 500
		maxBackups: 3
		maxAge: 3
		level: debug
		stdout: true
	*/
	configPath := "./testdata/app.yaml"
	viper, err := config.New(configPath)
	if err != nil {
		panic(err)
	}
	options, err := log.NewOptions(viper)
	if err != nil {
		panic(err)
	}
	logger, err := log.New(options)
	if err != nil {
		panic(err)
	}
	server := NewServer()
	application, err := app.New(viper.GetString("app.name"), logger, server)
	if err != nil {
		panic(err)
	}

	if err := application.Start(); err != nil {
		panic(err)
	}

	application.AwaitSingal()

}

Output:

2020/08/06 14:06:28 use local config file -> ./testdata/app.yaml
2020/08/06 14:06:28 read remote config error from 127.0.0.1:7888: Remote Configurations Error: No Files Found
2020/08/06 14:06:28 app config:
app:
name: your-app-name
log:
filename: /tmp/your-app-name.log
level: debug
maxage: 3
maxbackups: 3
maxsize: 500
stdout: true

[START] http、rpc、dns... server
2020-08-06T14:06:28.901+0800    INFO    http、rpc、dns... server start success  {"type": "Application"}
Ctrl+C
2020-08-06T14:07:15.048+0800  INFO    receive a signal        {"type": "Application", "signal": "interrupt"}
[STOP] http、rpc、dns... server
2020-08-06T14:07:15.048+0800    INFO    http、rpc、dns... server shutdown success       {"type": "Application"}

func New

func New(name string, logger *zap.Logger, ss ...Server) (*Application, error)

New is constructor of application

func (*Application) AwaitSingal

func (a *Application) AwaitSingal()

AwaitSingal graceful shutodwn when receive termainal signal kill -15

func (*Application) Start

func (a *Application) Start() error

Start application

type Server

type Server interface {
	Desc() string
	Start() error
	Stop() error
}

Server define register server interface