Skip to content

Latest commit

 

History

History
149 lines (118 loc) · 6.59 KB

README_zh.md

File metadata and controls

149 lines (118 loc) · 6.59 KB
Raw

Build Status GoDoc codeCov Go Report Card License Awesome Go Discord

Go Kratos - A Go framework for microservices. | Product Hunt

Translations: English | 简体中文

Kratos

Kratos 一套轻量级 Go 微服务框架，包含大量微服务相关功能及工具。

名字来源于:《战神》游戏以希腊神话为背景，讲述由凡人成为战神的奎托斯（Kratos）成为战神并展开弑神屠杀的冒险历程。

Goals

我们致力于提供完整的微服务研发体验，整合相关框架及工具后，微服务治理相关部分可对整体业务开发周期无感，从而更加聚焦于业务交付。对每位开发者而言，整套 Kratos 框架也是不错的学习仓库，可以了解和参考到微服务方面的技术积累和经验。

Principles

  • 简单：不过度设计，代码平实简单；
  • 通用：通用业务开发所需要的基础库的功能；
  • 高效：提高业务迭代的效率；
  • 稳定：基础库可测试性高，覆盖率高，有线上实践安全可靠；
  • 健壮：通过良好的基础库设计，减少错用；
  • 高性能：性能高，但不特定为了性能做 hack 优化，引入 unsafe ；
  • 扩展性：良好的接口设计，来扩展实现，或者通过新增基础库目录来扩展功能；
  • 容错性：为失败设计，大量引入对 SRE 的理解，鲁棒性高；
  • 工具链：包含大量工具链，比如 cache 代码生成，lint 工具等等；

Features

  • APIs：协议通信以 HTTP/gRPC 为基础，通过 Protobuf 进行定义；
  • Errors：通过 Protobuf 的 Enum 作为错误码定义，以及工具生成判定接口；
  • Metadata：在协议通信 HTTP/gRPC 中，通过 Middleware 规范化服务元信息传递；
  • Config：支持多数据源方式，进行配置合并铺平，通过 Atomic 方式支持动态配置；
  • Logger：标准日志接口，可方便集成三方 log 库，并可通过 fluentd 收集日志；
  • Metrics：统一指标接口，可以实现各种指标系统，默认集成 Prometheus；
  • Tracing：遵循 OpenTelemetry 规范定义，以实现微服务链路追踪；
  • Encoding：支持 Accept 和 Content-Type 进行自动选择内容编码；
  • Transport：通用的 HTTP/gRPC 传输层，实现统一的 Middleware 插件支持；
  • Registry：实现统一注册中心接口，可插件化对接各种注册中心；
  • Validation: 通过Protobuf统一定义校验规则，并同时适用于HTTP/gRPC服务.
  • SwaggerAPI: 通过集成第三方Swagger插件能够自动生成Swagger API json并启动一个内置的Swaager UI服务.

Getting Started

Required

Installing

go install 安装：
go install github.com/go-kratos/kratos/cmd/kratos/v2@latest
kratos upgrade
源码编译安装：
git clone https://github.com/go-kratos/kratos
cd kratos
make install

Create a service

# 创建项目模板
kratos new helloworld

cd helloworld
# 拉取项目依赖
go mod download

# 生成proto模板
kratos proto add api/helloworld/helloworld.proto
# 生成proto源码
kratos proto client api/helloworld/helloworld.proto
# 生成server模板
kratos proto server api/helloworld/helloworld.proto -t internal/service

# 生成所有proto源码、wire等等
go generate ./...

# 运行程序
kratos run

Kratos Boot

import "github.com/go-kratos/kratos/v2"
import "github.com/go-kratos/kratos/v2/transport/grpc"
import "github.com/go-kratos/kratos/v2/transport/http"

httpSrv := http.NewServer(http.Address(":8000"))
grpcSrv := grpc.NewServer(grpc.Address(":9000"))

app := kratos.New(
    kratos.Name("kratos"),
    kratos.Version("latest"),
    kratos.Server(httpSrv, grpcSrv),
)
app.Run()

Related

Community

WeChat Official Account

kratos

Conventional commits

提交信息的结构应该如下所示:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

提交信息应按照下面的格式:

  • fix: simply describe the problem that has been fixed
  • feat(log): simple describe of new features
  • deps(examples): simple describe the change of the dependency
  • break(http): simple describe the reasons for breaking change

Sponsors and Backers

kratos

License

Kratos is MIT licensed. See the LICENSE file for details.