ego

README

EGO

帮助文档

https://ego.gocn.vip

介绍

EGO是一个集成里各种工程实践的框架。通过组件化的设计模式，保证了业务方能够统一的调用方式启动各种组件

使用EGO的优势

• 配置化驱动组件
• 屏蔽底层组件启动细节
• 微服务组件的可观测、可治理
• 可插拔的Ego-Component组件
• Fail Fast理念和错误友好提示

功能

• server HTTP
  • 例子
  • 使用方式
  • 错误日志
• server gRPC
  • 例子
  • 使用方式
  • 错误日志
• task job
  • 例子
  • 使用方式
• task cron
  • 例子
  • 使用方式
• client HTTP
  • 例子
  • 使用方式
  • 错误日志
• client gRPC
  • 直连例子
  • ETCD例子
  • 使用方式
  • 错误日志
• client mysql
  • 例子
  • 使用方式
  • 错误日志
• client redis
  • 例子
  • 使用方式
  • 错误日志
• client mongo
  • 例子

特性介绍

• 配置驱动 所有组件启动方式为组件名称.Load("配置名称").Build()，可以创建一个组件实例。如以下http server，egin是组件名称，server.http是配置名称

egin.Load("server.http").Build()

• 友好的debug 可以看到所有组件的请求参数和响应参数信息
• 链路 使用opentrace协议，自动将链路加入到日志里
• 统一的错误信息
• 统一的监控信息
  

Quick Start

HelloWorld

import (
   "github.com/gin-gonic/gin"
   "github.com/gotomicro/ego"
   "github.com/gotomicro/ego/core/elog"
   "github.com/gotomicro/ego/server"
   "github.com/gotomicro/ego/server/egin"
)
//  export EGO_DEBUG=true && go run main.go --config=config.toml
func main() {
   if err := ego.New().Serve(func() *egin.Component {
      server := egin.Load("server.http").Build()
      server.GET("/hello", func(ctx *gin.Context) {
         ctx.JSON(200, "Hello EGO")
         return
      })
      return server
   }()).Run(); err != nil {
      elog.Panic("startup", elog.FieldErr(err))
   }
}

使用命令行运行

export EGO_DEBUG=true # 默认日志输出到logs目录，开启dev后日志输出到终端
go run main.go --config=config.toml

如下所示

这个时候我们可以发送一个指令，得到如下结果

➜  helloworld git:(master) ✗ curl http://127.0.0.1:9001/hello
"Hello Ego"%  

更加友好的包编译

使用scripts文件夹里的包编译，可以看到优雅的version提示

Documentation

Index

• func New(options ...Option) *ego
• type Option
  • func WithAfterStopClean(fns ...func() error) Option
  • func WithBeforeStopClean(fns ...func() error) Option
  • func WithConfigPrefix(configPrefix string) Option
  • func WithDisableBanner(disableBanner bool) Option
  • func WithHang(flag bool) Option
  • func WithShutdownSignal(signals ...os.Signal) Option
  • func WithStopTimeout(timeout time.Duration) Option

Functions

func New

func New(options ...Option) *ego

New new ego

Types

type Option

type Option func(a *ego)

func WithAfterStopClean

func WithAfterStopClean(fns ...func() error) Option

设置运行后清理

func WithBeforeStopClean

func WithBeforeStopClean(fns ...func() error) Option

设置运行前清理

func WithConfigPrefix

func WithConfigPrefix(configPrefix string) Option

func WithDisableBanner

func WithDisableBanner(disableBanner bool) Option

func WithHang

func WithHang(flag bool) Option

是否允许系统悬挂起来，0 表示不悬挂， 1 表示悬挂。目的是一些脚本操作的时候，不想主线程停止

func WithShutdownSignal

func WithShutdownSignal(signals ...os.Signal) Option

func WithStopTimeout

func WithStopTimeout(timeout time.Duration) Option