开源推荐 YoyoGo (web&grpc) 微服务框架

yoyofx · 2021年04月30日 · 243 次阅读

中文 / English

YoyoGo 简单、轻量、快速、基于依赖注入的微服务框架

特色

  • 漂亮又快速的路由器
  • 中间件支持 (handler func & custom middleware)
  • 微服务框架抽象了分层,在一个框架体系兼容各种 server 实现,如 rest,grpc 等
  • 受到许多出色的 Go Web 框架的启发,server 可替换,目前实现了 fasthttpnet.http
  • 已更新 grpc 支持

QQ 交流群: 780385870 (Go 浪文学院) , 在这里感谢贾国锦帮忙设计的 logo 很漂亮。

框架安装

go get github.com/yoyofx/yoyogo

安装依赖 (由于某些原因国内下载不了依赖)

go version < 1.13

window 下在 cmd 中执行:
set GO111MODULE=on
set GOPROXY=https://goproxy.io,direct,https://mirrors.aliyun.com/goproxy/,https://goproxy.cn,https://athens.azurefd.net,https://gonexus.dev 
linux  下执行:
export GO111MODULE=on
export GOPROXY=https://goproxy.cn

go version >= 1.14

go env -w GOPROXY=https://goproxy.io,direct,https://mirrors.aliyun.com/goproxy/,https://goproxy.cn,https://athens.azurefd.net,https://gonexus.dev

vendor

go mod vendor       // 将依赖包拷贝到项目目录中去

简单的例子

package main
import ...

func main() {
    WebApplication.CreateDefaultBuilder(func(rb router.IRouterBuilder) {
        rb.GET("/info",func (ctx *context.HttpContext) {    // 支持Group方式
            ctx.JSON(200, context.H{"info": "ok"})
        })
    }).Build().Run()       //默认端口号 :8080
}

实现进度

标准功能

  • [X] 打印 Logo 和日志(YoyoGo)
  • [X] 统一程序输入参数和环境变量 (YoyoGo)
  • [X] 简单路由器绑定句柄功能
  • [X] HttpContext 上下文封装 (请求,响应)
  • [X] 静态文件端点(静态文件服务器)
  • [X] JSON 序列化结构(Context.H)
  • [X] 获取请求文件并保存
  • [X] 获取请求数据(form-data,x-www-form-urlencoded,Json ,XML,Protobuf 等)
  • [X] Http 请求的绑定模型(Url, From,JSON,XML,Protobuf) ### 响应渲染功能
  • [X] Render Interface
  • [X] JSON Render
  • [X] JSONP Render
  • [X] Indented Json Render
  • [X] Secure Json Render
  • [X] Ascii Json Render
  • [X] Pure Json Render
  • [X] Binary Data Render
  • [X] TEXT
  • [X] Protobuf
  • [X] MessagePack
  • [X] XML
  • [X] YAML
  • [X] File
  • [X] Image
  • [X] Template
  • [X] Auto formater Render

中间件

  • [X] Logger
  • [X] StaticFile
  • [X] Router Middleware
  • [X] CORS
  • [X] Binding
  • [X] JWT
  • [X] RequestId And Tracker for SkyWorking

路由

  • [x] GET,POST,HEAD,PUT,DELETE 方法支持
  • [x] 路由解析树与表达式支持
  • [x] RouteData 路由数据 (/api/:version/) 与 Binding 的集成
  • [x] 路由组功能
  • [x] MVC 默认模板功能
  • [x] 路由过滤器 Filter

MVC

  • [x] 路由请求触发 Controller&Action
  • [x] Action 方法参数绑定
  • [x] 内部对象的 DI 化
  • [x] 关键对象的参数传递

Dependency injection

  • [X] 抽象集成第三方 DI 框架
  • [X] MVC 模式集成
  • [X] 框架级的 DI 支持功能

扩展

  • [X] 配置
  • [X] WebSocket
  • [X] JWT
  • [ ] swagger
  • [x] GRpc
  • [X] Prometheus

进阶范例

package main

import
...

func main() {
    webHost := CreateCustomWebHostBuilder().Build()
    webHost.Run()
}

// 自定义HostBuilder并支持 MVC 和 自动参数绑定功能,简单情况也可以直接使用CreateDefaultBuilder 。
func CreateCustomBuilder() *abstractions.HostBuilder {

    configuration := abstractions.NewConfigurationBuilder().
        AddEnvironment().
        AddYamlFile("config").Build()

    return WebApplication.NewWebHostBuilder().
        UseConfiguration(configuration).
        Configure(func(app *WebApplication.WebApplicationBuilder) {
            app.UseMiddleware(middlewares.NewCORS())
            //WebApplication.UseMiddleware(middlewares.NewRequestTracker())
            app.UseStaticAssets()
            app.UseEndpoints(registerEndpointRouterConfig)
            app.UseMvc(func(builder *mvc.ControllerBuilder) {
                //builder.AddViews(&view.Option{Path: "./static/templates"})
                builder.AddViewsByConfig()
                builder.AddController(contollers.NewUserController)
                builder.AddFilter("/v1/user/info", &contollers.TestActionFilter{})
            })
        }).
        ConfigureServices(func(serviceCollection *dependencyinjection.ServiceCollection) {
            serviceCollection.AddTransientByImplements(models.NewUserAction, new(models.IUserAction))
            //eureka.UseServiceDiscovery(serviceCollection)
            //consul.UseServiceDiscovery(serviceCollection)
            nacos.UseServiceDiscovery(serviceCollection)
        }).
        OnApplicationLifeEvent(getApplicationLifeEvent)
}

//region endpoint 路由绑定函数
func registerEndpoints(rb router.IRouterBuilder) {
    Endpoints.UseHealth(rb)
    Endpoints.UseViz(rb)
    Endpoints.UsePrometheus(rb)
    Endpoints.UsePprof(rb)
    Endpoints.UseJwt(rb)

    rb.GET("/error", func(ctx *context.HttpContext) {
        panic("http get error")
    })

    //POST 请求: /info/:id ?q1=abc&username=123
    rb.POST("/info/:id", func(ctx *context.HttpContext) {
        qs_q1 := ctx.Query("q1")
        pd_name := ctx.Param("username")

        userInfo := &UserInfo{}

        _ = ctx.Bind(userInfo) // 手动绑定请求对象

        strResult := fmt.Sprintf("Name:%s , Q1:%s , bind: %s", pd_name, qs_q1, userInfo)

        ctx.JSON(200, context.H{"info": "hello world", "result": strResult})
    })

    // 路由组功能实现绑定 GET 请求:  /v1/api/info
    rb.Group("/v1/api", func(router *router.RouterGroup) {
        router.GET("/info", func(ctx *context.HttpContext) {
            ctx.JSON(200, context.H{"info": "ok"})
        })
    })

    // GET 请求: HttpContext.RequiredServices获取IOC对象
    rb.GET("/ioc", func(ctx *context.HttpContext) {
        var userAction models.IUserAction
        _ = ctx.RequiredServices.GetService(&userAction)
        ctx.JSON(200, context.H{"info": "ok " + userAction.Login("zhang")})
    })
}

//endregion

//region 请求对象
type UserInfo struct {
    UserName string `param:"username"`
    Number   string `param:"q1"`
    Id       string `param:"id"`
}

// ----------------------------------------- MVC 定义 ------------------------------------------------------

// 定义Controller
type UserController struct {
    *mvc.ApiController
    userAction models.IUserAction // IOC 对象参数
}

// 构造器依赖注入
func NewUserController(userAction models.IUserAction) *UserController {
    return &UserController{userAction: userAction}
}

// 请求对象的参数化绑定
type RegiserRequest struct {
    mvc.RequestBody
    UserName string `param:"username"`
    Password string `param:"password"`
}

// Register函数自动绑定参数
func (this *UserController) Register(ctx *context.HttpContext, request *RegiserRequest) actionresult.IActionResult {
    result := mvc.ApiResult{Success: true, Message: "ok", Data: request}
    return actionresult.Json{Data: result}
}

// use userAction interface by ioc  
func (this *UserController) GetInfo() mvc.ApiResult {
    return this.OK(this.userAction.Login("zhang"))
}

// Web程序的开始与停止事件
func fireApplicationLifeEvent(life *abstractions.ApplicationLife) {
    printDataEvent := func(event abstractions.ApplicationEvent) {
        fmt.Printf("[yoyogo] Topic: %s; Event: %v\n", event.Topic, event.Data)
    }
    for {
        select {
        case ev := <-life.ApplicationStarted:
            go printDataEvent(ev)
        case ev := <-life.ApplicationStopped:
            go printDataEvent(ev)
            break
        }
    }
}

更多原创文章干货分享,请关注公众号
  • 加微信实战群请加微信(注明:实战群):gocnio
kevin GoCN 每日新闻 (2021-05-02) 中提及了此贴 05月02日 00:51
需要 登录 后方可回复, 如果你还没有账号请点击这里 注册