Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
https://github.com/gotomicro/ego

A simple and component-based microservice kit for go. 一个简单的基于组件的 Go 微服务套件。
https://github.com/gotomicro/ego
ego gin go gorm grpc http microservice redis resty
Last synced: about 1 month ago
JSON representation
A simple and component-based microservice kit for go. 一个简单的基于组件的 Go 微服务套件。
Host: GitHub
URL: https://github.com/gotomicro/ego
Owner: gotomicro
License: mit
Created: 2020-11-23T12:56:00.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2024-06-07T13:45:04.000Z (about 1 month ago)
Last Synced: 2024-06-08T04:55:04.063Z (about 1 month ago)
Topics: ego, gin, go, gorm, grpc, http, microservice, redis, resty
Language: Go
Homepage: https://ego-org.com
Size: 2.58 MB
Stars: 937
Watchers: 24
Forks: 155
Open Issues: 4
Metadata Files:
- Readme: README-zh.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Lists

awesome - gotomicro/ego - A simple and component-based microservice kit for go. 一个简单的基于组件的 Go 微服务套件。 (Go)
README

        ## EGO

[![All Contributors](https://img.shields.io/badge/all_contributors-11-orange.svg?style=flat-square)](#contributors-)

[![Go](https://github.com/gotomicro/ego/workflows/Go/badge.svg?branch=master)](https://github.com/gotomicro/ego/actions)

[![Go Report Card](https://goreportcard.com/badge/github.com/gotomicro/ego)](https://goreportcard.com/report/github.com/gotomicro/ego)

[![codecov](https://codecov.io/gh/gotomicro/ego/branch/master/graph/badge.svg)](https://codecov.io/gh/gotomicro/ego)

[![goproxy.cn](https://goproxy.cn/stats/github.com/gotomicro/ego/badges/download-count.svg)](https://goproxy.cn/stats/github.com/gotomicro/ego)

[![Release](https://img.shields.io/github/v/release/gotomicro/ego.svg?style=flat-square)](https://github.com/gotomicro/ego)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![Example](https://img.shields.io/badge/sample-%E6%A0%B7%E4%BE%8B-2ca5e0?style=flat&logo=appveyor)](https://github.com/gotomicro/ego/tree/master/examples)

[![Doc](https://img.shields.io/badge/doc-%E6%96%87%E6%A1%A3-2ca5e0?style=flat&logo=appveyor)](https://ego.gocn.vip)

## 1 帮助文档

[https://ego-org.com](https://ego-org.com)

## 2 介绍

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

使用EGO的优势

* 配置化驱动组件

* 屏蔽底层组件启动细节

* 微服务组件的可观测、可治理

* 可插拔的Ego-Component组件

* Fail Fast理念和错误友好提示

### 2.1 提升组件熟练度

我们工程师要想提升组件熟练度，首先要大量看开源组件文档和代码，然后坚持长时间使用，才能形成肌肉记忆，提升我们做业务的速度。而这一切所投入的时间和精力是非常大的。

要减少这个投入成本，让更多开发者使用好优秀的开源组件，EGO的做法是标准化所有开源组件，对其做一层封装，统一各种行为。

* 统一组件文件名

* 统一组件配置参数

* 统一组件调用API

* 统一组件错误行为

* 统一组件监控行为

让人掌握了一种组件，就可以举一反三使用其他组件。

### 2.2 提升故障排查效率

* 统一错误码

* 组件错误、慢响应、链路、常规请求拦截器埋点（服务端、客户端均会拦截）

* 收敛错误字段

* 注入组件关键信息：代码行号、配置名、目标地址、耗时、请求数据、响应数据

* 调试阶段，错误高亮、格式化友好提示

* 调试阶段，组件内置debug拦截器

### 2.3 自动生成重复代码

* 生成代码，配置、数据解析、模版分离

* 不依赖于语言，构建项目代码

* 利用Go1.16特性embed，启动web，生成代码

* 项目地址: [https://github.com/gotomicro/egoctl](https://github.com/gotomicro/egoctl)

## 3 Ego的组件

我们支持多种EGO组件，加快你的开发速度

| Component Name            | Code                                                                 | Example                                                                        | Doc                                                                                                                 |

|---------------------------|----------------------------------------------------------------------|--------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|

| HTTP Server               | [Code](https://github.com/gotomicro/ego/tree/master/server/egin)     | [Example](https://github.com/gotomicro/ego/tree/master/examples/server/http)   | [Doc](https://ego.gocn.vip/frame/server/http.html)                                                                  |

| gRPC Server               | [Code](https://github.com/gotomicro/ego/tree/master/server/egrpc)    | [Example](https://github.com/gotomicro/ego/tree/master/examples/server/grpc)   | [Doc](https://ego.gocn.vip/frame/server/grpc.html#example)                                                          |

| Governance Service        | [Code](https://github.com/gotomicro/ego/tree/master/server/egovernor) | [Example](https://github.com/gotomicro/ego/tree/master/examples/server/governor) | [Doc](https://ego.gocn.vip/frame/server/governor.html)                                                              |

| Job                       | [Code](https://github.com/gotomicro/ego/tree/master/task/ejob)       | [Example](https://github.com/gotomicro/ego/tree/master/examples/task/job)     | [Doc](https://ego.gocn.vip/frame/task/job.html)                                                                     |

| Corn job                  | [Code](https://github.com/gotomicro/ego/tree/master/task/ecron)      | [Example](https://github.com/gotomicro/ego/tree/master/examples/task/cron)     | [Doc](https://ego.gocn.vip/frame/task/cron.html#_3-%E5%B8%B8%E8%A7%84%E5%AE%9A%E6%97%B6%E4%BB%BB%E5%8A%A1)          |

| Distributed Scheduled Job | [Code](https://github.com/gotomicro/ego/tree/master/task/ecron)      | [Example](https://github.com/gotomicro/ego/tree/master/examples/task/cron)     | [Doc](https://ego.gocn.vip/frame/task/cron.html#_4-%E5%88%86%E5%B8%83%E5%BC%8F%E5%AE%9A%E6%97%B6%E4%BB%BB%E5%8A%A1) |

| HTTP Client               | [Code](https://github.com/gotomicro/ego/tree/master/client/ehttp)    | [Example](https://github.com/gotomicro/ego/tree/master/examples/http/client)   | [Doc](https://ego.gocn.vip/frame/client/http.html#example)                                                          |

| gRPC Client               | [Code](https://github.com/gotomicro/ego/tree/master/client/egrpc)    | [Example](https://github.com/gotomicro/ego/tree/master/examples/grpc/direct)   | [Doc](https://ego.gocn.vip/frame/client/grpc.html#_4-%E7%9B%B4%E8%BF%9Egrpc)                                        |

| gRPC Client using ETCD    | [Code](https://github.com/ego-component/eetcd/tree/master/)           | [Example](https://github.com/ego-component/eetcd/tree/master//examples)         | [Doc](https://ego.gocn.vip/frame/client/grpc.html#_5-%E4%BD%BF%E7%94%A8etcd%E7%9A%84grpc)                           |

| gRPC Client using k8s     | [Code](https://github.com/ego-component/ek8s/tree/master/)            | [Example](https://github.com/ego-component/ek8s/tree/master//examples)          | [Doc](https://ego.gocn.vip/frame/client/grpc.html#_6-%E4%BD%BF%E7%94%A8k8s%E7%9A%84grpc)                            |

| Sentinel                  | [Code](https://github.com/gotomicro/ego/tree/master/core/esentinel)  | [Example](https://github.com/gotomicro/ego/tree/master/examples/sentinel/http) | [Doc](https://ego.gocn.vip/frame/client/sentinel.html)                                                              |

| MySQL                     | [Code](https://github.com/ego-component/egorm/tree/master/)           | [Example](https://github.com/ego-component/egorm/tree/master//examples)         | [Doc](https://ego.gocn.vip/frame/client/gorm.html#example)                                                          |

| Redis                     | [Code](https://github.com/ego-component/eredis/tree/master/)          | [Example](https://github.com/ego-component/eredis/tree/master//examples)        | [Doc](https://ego.gocn.vip/frame/client/redis.html#example)                                                         |

| Redis Distributed lock    | [Code](https://github.com/ego-component/eredis/tree/master/)          | [Example](https://github.com/ego-component/eredis/tree/master//examples)        | [Doc](https://ego.gocn.vip/frame/client/redis.html#example)                                                         |

| Mongo                     | [Code](https://github.com/ego-component/emongo/tree/master/)          | [Example](https://github.com/ego-component/emongo/tree/master//examples)        | [Doc](https://ego.gocn.vip/frame/client/mongo.html)                                                                 |

| Kafka                     | [Code](https://github.com/ego-component/ekafka/tree/master/)          | [Example](https://github.com/ego-component/ekafka/tree/master//examples)        | [Doc](https://ego.gocn.vip/frame/client/kafka.html)                                                                 |

| ETCD                      | [Code](https://github.com/ego-component/eetcd/tree/master/)           | [Example](https://github.com/ego-component/eetcd/tree/master//examples)         | [Doc](https://ego.gocn.vip/frame/client/eetcd.html)                                                                 |

| K8S                       | [Code](https://github.com/ego-component/ek8s/tree/master/)            | [Example](https://github.com/ego-component/ek8s/tree/master//examples)          | [Doc](https://ego.gocn.vip/frame/client/ek8s.html)                                                                  |

| Oauth2                    | [Code](https://github.com/ego-component/eoauth2/tree/master/)         | [Example](https://github.com/ego-component/eoauth2/tree/master//examples)       ||

* 更多组件请查看:[https://github.com/ego-component](https://github.com/ego-component)

## 4 EGO的定义

### 4.1 框架分层

我们框架分为三个层次

* 核心层提供配置、日志、监控和链路，是其他组件的基石

* 组件层提供客户端、服务端、任务端里的各种组件

* 胶水层控制了各种组件的生命周期，错误处理

### 4.2 架构图

![](./docs/images/ego_frame.png)

### 4.3 生命周期

![](./docs/images/ego_flow.png)

### 4.4 组件分层

我们认为一切均是组件，我们将组件分为四个部分：

- Container 处理组件类型、组件配置、组件启动

- Config    配置参数

- Component 组件的调用方法

- Options   配置和组件可选项

## 5 版本要求

* v0.8.2以下  需要 go大于go1.13

* v0.8.3后   需要 go大于go1.16

* v1.0.0后   需要 go大于go1.17

## 6 下载工具

```bash

bash <(curl -L https://raw.githubusercontent.com/gotomicro/egoctl/main/getlatest.sh)

```

通过以上脚本，可以下载protoc工具全家桶，以及ego的protoc插件和egoctl

* /usr/local/bin/egoctl               EGO工具

* /usr/local/bin/protoc               生成Pb工具

* /usr/local/bin/protoc-gen-go        生成Pb工具

* /usr/local/bin/protoc-gen-go-grpc   生成gRPC工具

* /usr/local/bin/protoc-gen-go-errors 生成错误码工具

* /usr/local/bin/protoc-gen-openapiv2 生成HTTP工具

* /usr/local/bin/protoc-gen-go-http   生成HTTP工具

## 7 特性介绍

* 配置驱动

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

```go

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

```

* 友好的debug

  通过开启``debug``配置和命令行的``export EGO_DEBUG=true``，

  我们可以在测试环境里看到所有组件的请求里的行号、配置名、请求地址、耗时、请求数据、响应数据

![](docs/images/client_grpc1.png)

![](docs/images/client-http.png)

![](docs/images/client-mysql.png)

![](docs/images/client-redis.jpg)

并且使用``Goland``同学，可以直接通过行号点击到对应的代码路径(gRPC、HTTP客户端支持行号)

* 链路

  使用opentelemetry协议，自动将链路加入到日志里，支持oltp协议上报到阿里arms。

    * gRPC链路

        * 测试代码

          [gRPC直连查看链路id](https://github.com/gotomicro/ego/tree/master/examples/grpc/direct)

        * 服务端链路信息

      ![image](docs/images/trace-server-grpc.png)

        * 客户端链路信息

      ![image](docs/images/trace-client-grpc.png)

    * HTTP链路

      ![](docs/images/trace.png)

    * 阿里arms链路   

      自动记录各个组件的span信息

      ![](docs/images/trace-arms.png)

* [统一的错误信息](https://ego.gocn.vip/awesome/errors.html)

* 统一的监控信息

![](docs/images/metric.png)

## 8 Quick Start

### 8.1 HelloWorld

配置

```toml

[server.http]

    port = 9001

    host = "0.0.0.0"

```

代码

```go

package main

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))

   }

}

```

### 8.2 使用命令行运行

```

export EGO_DEBUG=true # 默认日志输出到logs目录，开启dev后日志输出到终端

go run main.go --config=config.toml

```

### 8.3 如下所示

![图片](./docs/images/startup.png)

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

```

➜  helloworld git:(master) ✗ curl http://127.0.0.1:9001/hello

"Hello Ego"%  

```

### 8.4 更加友好的包编译

使用scripts文件夹里的[包编译](examples/build)，可以看到优雅的version提示

![图片](./docs/images/version.png)

## 9 更新日志

[Releases](https://github.com/gotomicro/ego/releases)

## 10 加入我们

加入我们，请在验证信息里添加``ego``关键字

![image](./docs/images/join.jpeg)

## Contributors

Thanks for these wonderful people:

  

    
_askuy

    
_{Wei Zheng}

    
_shaoyuan

    
_Panda

    
_刘文哲

    
_zhangjunjun

    
_devincd

  

  

    
_{Ming Deng}

    
_Angelia

    
_Wbofeng

    
_clannadxr

    
_{Link Duan}

    
_Costa

    
_MEX7

  

  

    
_LincolnZhou

    
_{optimistic9527}

    
_soeluc