Skip to content

Latest commit

 

History

History
200 lines (145 loc) · 6.44 KB

README_CN.md

File metadata and controls

200 lines (145 loc) · 6.44 KB

English | 中文

core

Package core 是一个服务容器，在 Go 中优雅地引导和协调 12-factor 应用程序。

背景简介

12-factor 多年来证明了它的价值。自从它发明以来，许多技术领域都发生了变化，其中许多领域都焕发着光辉和激动人心。 在Kubernetes、service mesh 和 serverless architectures,的时代，12-factor 不但并没有消失，而且这些强大的平台提供很好了帮助。

对于经验丰富的工程师来说，构建一个包含 12-factor 的 go 应用程序可能不是一项困难的任务，但对年轻人来说无疑是一个挑战。 对于那些有能力安排事情的人来说，还有很多决定要做，还有很多选择要在团队内部达成一致。

本包core核心目标引导和协调构建符合 12-factor 的服务。

Feature

包 core 与您的应用程序有共同的关注点：

  • Configuration management: env, flags, files, etc.
  • Pluggable transports: HTTP, gRPC, etc.
  • Dependency injection
  • Job management: Cron, long-running, one-off commandline, etc.
  • Events and Queues
  • Metrics
  • Distributed Tracing
  • Database migrations and seedings
  • Distributed transactions
  • Leader election

概述

无论什么 app 引导阶段大致由以下部分组成：

  • 从二进制外读取配置信息。如：flags、环境变量或(和)配置文件。
  • 初始化依赖项。如：数据库、消息队列、服务发现等。
  • 定义如何运行应用程序。如：HTTP、RPC、命令行、cron jobs 或更混合运行。

本包core对那些重复的步骤进行了抽象，使它们简洁、可移植但又明确。让我们看看下面的代码片段：

package main

import (
  "context"
  "net/http"

  "github.com/DoNewsCode/core"
  "github.com/DoNewsCode/core/observability"
  "github.com/DoNewsCode/core/otgorm"
  "github.com/gorilla/mux"
)

func main() {
  // 步骤一: 创建core从配置文件
  c := core.New(core.WithYamlFile("config.yaml"))

  // 步骤二: 绑定依赖
  c.Provide(otgorm.Providers())

  // 步骤三: 定义服务
  c.AddModule(core.HttpFunc(func(router *mux.Router) {
    router.HandleFunc("/", func(writer http.ResponseWriter, request *http.Request) {
      writer.Write([]byte("hello world"))
    })
  }))

  // 步骤四: 启动
  c.Serve(context.Background())
}

在几行代码中，就启动了一个 HTTP 服务。它是简单的、明确的，在某种程度上是声明性的。

上面演示的服务使用内联处理函数突出显示该点。通常，对于实际项目，我们将使用模块代替。 package core 术语表中的module不一定是go模块（尽管可以）。它只是一组服务。

您可能会注意到，HTTP 服务并不真正使用依赖。

让我们重写 HTTP 服务，使其使用上依赖。

package main

import (
  "context"
  "net/http"

  "github.com/DoNewsCode/core"
  "github.com/DoNewsCode/core/otgorm"
  "github.com/DoNewsCode/core/srvhttp"
  "github.com/gorilla/mux"
  "gorm.io/gorm"
)

type User struct {
  Id   string
  Name string
}

type Repository struct {
  DB *gorm.DB
}

func (r Repository) Find(id string) (*User, error) {
  var user User
  if err := r.DB.First(&user, id).Error; err != nil {
    return nil, err
  }
  return &user, nil
}

type Handler struct {
  R Repository
}

func (h Handler) ServeHTTP(writer http.ResponseWriter, request *http.Request) {
  encoder := srvhttp.NewResponseEncoder(writer)
  encoder.Encode(h.R.Find(request.URL.Query().Get("id")))
}

type Module struct {
  H Handler
}

func New(db *gorm.DB) Module {
  return Module{Handler{Repository{db}}}
}

func (m Module) ProvideHTTP(router *mux.Router) {
  router.HandleFunc("/", m.H)
}

func main() {
  // 步骤一: 从配置文件创建核心
  c := core.New(core.WithYamlFile("config.yaml"))

  // 步骤二: 绑定依赖
  c.Provide(otgorm.Providers())

  // 步骤三: 定义服务
  c.AddModuleFunc(New)

  // 步骤四: 启动
  c.Serve(context.Background())
}

第三阶段已经被c.AddModuleFunc(New)所取代。AddModuleFunc将参数从依赖项容器填充到New，并将返回的模块实例添加到内部模块注册表。

当调用c.Serve()时，将扫描所有注册的模块以查找实现的接口。示例中的模块实现如下 HTTPProvider 接口：

type HTTPProvider interface {
	ProvideHTTP(router *mux.Router)
}

因此，core知道该模块想要公开 HTTP 服务，并随后通过路由器调用 ProvideHTTP。您可以注册多个模块，每个模块可以实现一个或多个服务。

现在我们有了一个完全可行的项目，包括 handler、repository 和 entity。如果这是一个 DDD workshop，我们将进一步扩展这个例子。

让我们重新把注意力转移回 core 包 提供的其他好处上：

  • core本身支持多路模块复用。您可以将项目作为一个包含多个模块的整体开始，然后逐渐将它们迁移到微服务中。
  • core不锁定在传输或框架中。例如，您可以使用go kit构建服务，并利用 gRPC、AMPQ、thrift 等。还支持 CLI 和 Cron 等非网络服务。
  • core初始化后对服务进行托管，该职责包括但不限于distributed tracing,metrics exporting,error handling,event-dispatching and leader election。

文档

设计原则

  • 不包含全局状态。
  • 推崇依赖注入。
  • 可测试代码。
  • 极简 interface 设计。易于装饰和更换。
  • 与 Go 的生态系统合作，而不是重新发明轮子。
  • 端到端上下文传递。

非目标

  • 试图成为 Spring、Laravel 或 Ruby 的 Rails。
  • 试图关心服务细节。
  • 试图重新实现现代平台提供的功能。

建议的服务框架

  • Gin （如果仅限于 HTTP）
  • Go Kit （如果有多个运输工具）
  • kratos (当前 v2 已经可以使用)

感谢 JetBrains 开源证书支持