You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
113 lines
4.4 KiB
113 lines
4.4 KiB
|
|
|
|
[](https://golang.org/)
|
|
[](https://github.com/go-kratos/kratos/actions)
|
|
[](https://pkg.go.dev/github.com/go-kratos/kratos/v2)
|
|
[](https://goreportcard.com/report/github.com/go-kratos/kratos/v2)
|
|
[](https://discord.gg/BWzJsUJ)
|
|
|
|
# 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：通过KeyValue方式实现，对多种配置源进行铺平，以Atomic方式支持动态配置；
|
|
* Logger：标准日志接口，可方便集成三方 log 库，并可通过 fluentd 收集日志；
|
|
* Metrics：统一指标接口，可以实现各种指标系统，默认集成 Prometheus；
|
|
* Tracing：遵循 OpenTracing 规范定义，以实现微服务链路追踪；
|
|
* Encoding：支持Accept和Content-Type进行自动选择内容编码；
|
|
* Transport：通用的 HTTP/gRPC 传输层，实现统一的 Middleware 插件支持；
|
|
|
|
## Getting Started
|
|
### Required
|
|
- [go](https://golang.org/dl/)
|
|
- [protoc](https://github.com/protocolbuffers/protobuf)
|
|
- [protoc-gen-go](https://github.com/protocolbuffers/protobuf-go)
|
|
|
|
### Install Kratos
|
|
```
|
|
# 安装生成工具
|
|
go get github.com/go-kratos/kratos/cmd/kratos/v2
|
|
go get github.com/go-kratos/kratos/cmd/protoc-gen-go-http/v2
|
|
go get github.com/go-kratos/kratos/cmd/protoc-gen-go-errors/v2
|
|
|
|
# 或者通过 Source 安装
|
|
cd cmd/kratos && go install
|
|
cd cmd/protoc-gen-go-http && go install
|
|
cd cmd/protoc-gen-go-errors && go install
|
|
```
|
|
### Create a service
|
|
```
|
|
# 创建项目模板
|
|
kratos new helloworld
|
|
|
|
cd helloworld
|
|
# 生成proto模板
|
|
kratos proto add api/helloworld/helloworld.proto
|
|
# 生成service模板
|
|
kratos proto service api/helloworld/helloworld.proto -t internal/service
|
|
|
|
# 安装生成工具
|
|
make init
|
|
# 生成api下所有proto文件
|
|
make proto
|
|
# 编译cmd下所有main文件
|
|
make build
|
|
# 进行单元测试
|
|
make test
|
|
```
|
|
|
|
### Kratos Run
|
|
```
|
|
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()
|
|
```
|
|
|
|
## Example Usage
|
|
|
|
* [Examples](https://github.com/go-kratos/examples)
|
|
* [Service Layout](https://github.com/go-kratos/kratos-layout)
|
|
|
|
## Community
|
|
* [Wechat Group](https://github.com/go-kratos/kratos/issues/682)
|
|
* [Discord Group](https://discord.gg/BWzJsUJ)
|
|
* QQ Group: 716486124
|
|
|
|
## Sponsors and Backers
|
|
|
|
|
|
|
|
## License
|
|
Kratos is MIT licensed. See the [LICENSE](./LICENSE) file for details.
|
|
|