pharnexbase
/
kratos
11
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add ENG readme (#725)

Browse Source 
Co-authored-by: cacosub7 <cacosub7@gmail.com>
pull/727/head
Tony Chen 4 years ago committed by chenzhihui
parent 1aa4dee6d8
commit ad5198999b
2 changed files with 143 additions and 36 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 70
      README.md
  2. 109
      README_zh.md

70
README.md
Unescape View File

@ -1,4 +1,4 @@
![kratos](docs/images/kratos.png) ![kratos](docs/images/kratos.png)
[![Language](https://img.shields.io/badge/Language-Go-blue.svg)](https://golang.org/) [![Language](https://img.shields.io/badge/Language-Go-blue.svg)](https://golang.org/)
[![Build Status](https://github.com/go-kratos/kratos/workflows/Go/badge.svg)](https://github.com/go-kratos/kratos/actions) [![Build Status](https://github.com/go-kratos/kratos/workflows/Go/badge.svg)](https://github.com/go-kratos/kratos/actions)
@ -6,39 +6,41 @@
[![Go Report Card](https://goreportcard.com/badge/github.com/go-kratos/kratos/v2)](https://goreportcard.com/report/github.com/go-kratos/kratos/v2) [![Go Report Card](https://goreportcard.com/badge/github.com/go-kratos/kratos/v2)](https://goreportcard.com/report/github.com/go-kratos/kratos/v2)
[![Discord](https://img.shields.io/discord/766619759214854164?label=chat&logo=discord)](https://discord.gg/BWzJsUJ) [![Discord](https://img.shields.io/discord/766619759214854164?label=chat&logo=discord)](https://discord.gg/BWzJsUJ)
Translations: [English](README.md) | [简体中文](README_zh.md)
# Kratos # Kratos
Kratos is a microservice-oriented governance framework implements by golang, which offers convenient capabilities to help you quickly build a bulletproof application from scratch.
Kratos 一套轻量级 Go 微服务框架，包含大量微服务相关框架及工具。 >The name is inspired by the game God of War which is based on Greek myths, tells the Kratos from mortals to become a God of War and launches the adventure of killing god.
> 名字来源于:《战神》游戏以希腊神话为背景，讲述由凡人成为战神的奎托斯（Kratos）成为战神并展开弑神屠杀的冒险历程。
## Goals ## Goals
我们致力于提供完整的微服务研发体验，整合相关框架及工具后，微服务治理相关部分可对整体业务开发周期无感，从而更加聚焦于业务交付。对每位开发者而言，整套 Kratos 框架也是不错的学习仓库，可以了解和参考到微服务方面的技术积累和经验。 Kratos boosts your productivity. With the integration of excellent resources and further support, you can get rid of most issues you might encounter in the field of distributed systems and software engineering, so that you can focus on business delivery. For each developer, Kratos is an ideal one for learning as well. You can navigate the diverse knowledge of microservice and accumulate engineering experience.
### Principles ### Principles
* 简单：不过度设计，代码平实简单； * **Simple**: appropriate design, plain and simple code.
* 通用：通用业务开发所需要的基础库的功能； * **General**: cover the various utilities for business development.
* 高效：提高业务迭代的效率； * **Reliable**: higher testability and greater test coverage of base libs validated in the production environment.
* 稳定：基础库可测试性高，覆盖率高，有线上实践安全可靠； * **Robust**: base libs are designed reasonably to reduce misuse.
* 健壮：通过良好的基础库设计，减少错用； * **High-performance**: We give you optimal performance without using the hack-way approach like adding the *unsafe* package and guarantee compatibility and stability at the same time.
* 高性能：性能高，但不特定为了性能做 hack 优化，引入 unsafe ； * **Expandable**: appropriate API design, you can expand utilities such as base libs to meet your further requirements.
* 扩展性：良好的接口设计，来扩展实现，或者通过新增基础库目录来扩展功能； * **Fault-tolerance**: designed against failure, enhance the understanding and exercising of SRE within Kratos to achieve more robustness.
* 容错性：为失败设计，大量引入对 SRE 的理解，鲁棒性高； * **Toolchain**: Includes an extensive toolchain, such as cache code generation, lint tools, etc.
* 工具链：包含大量工具链，比如 cache 代码生成，lint 工具等等；
## Features ## Features
* APIs：协议通信以 HTTP/gRPC 为基础，通过 Protobuf 进行定义； * APIs: HTTP/gRPC based transport and Protobuf defined communication protocol.
* Errors：通过 Protobuf 的 Enum 作为错误码定义，以及工具生成判定接口； * Errors: We use ProtoBuf Enum to define error code and generate error handle code.
* Metadata：在协议通信 HTTP/gRPC 中，通过 Middleware 规范化服务元信息传递； * Metadata: Normalize the service metadata transmission by excellent middleware.
* Config：支持多数据源方式，进行配置合并铺平，通过 Atomic 方式支持动态配置； * Config: Multi-data source Support, well arranged, dynamic configuration via *Atomic* package.
* Logger：标准日志接口，可方便集成三方 log 库，并可通过 fluentd 收集日志； * Logger: Standard log API, easily integrate with third-party log lib, *Fluentd* logs collection.
* Metrics：统一指标接口，可以实现各种指标系统，默认集成 Prometheus； * Metrics: *Prometheus* integration by default. Furthermore, with the unified Metrics interface, you can implement your metrics system more flexible
* Tracing：遵循 OpenTracing 规范定义，以实现微服务链路追踪； * Tracing: Complete micro-service link tracing followed by *OpenTracing* specification.
* Encoding：支持 Accept 和 Content-Type 进行自动选择内容编码； * Encoding: Support *Accept* and *Content-Type* for auto content encoding.
* Transport：通用的 HTTP/gRPC 传输层，实现统一的 Middleware 插件支持； * Transport: Common HTTP/ GRPC transport layer offers you powerful Middleware support.
* Registry：实现统一注册中心接口，可插件化对接各种注册中心； * Registry: One pluggable API for the different registry.
## Getting Started ## Getting Started
### Required ### Required
@ -48,27 +50,27 @@ Kratos 一套轻量级 Go 微服务框架，包含大量微服务相关框架及
### Installing ### Installing
``` ```
go get github.com/go-kratos/kratos/cmd/kratos/v2 go get github.com/go-kratos/kratos/cmd/kratos/v2@latest
``` ```
### Create a service ### Create a service
``` ```
# 创建项目模板 # create project template
kratos new helloworld kratos new helloworld
cd helloworld cd helloworld
# 生成proto模板 # generate Proto template
kratos proto add api/helloworld/helloworld.proto kratos proto add api/helloworld/helloworld.proto
# 生成proto源码 # generate Proto source code
kratos proto client api/helloworld/helloworld.proto kratos proto client api/helloworld/helloworld.proto
# 生成server模板 # generate server template
kratos proto server api/helloworld/helloworld.proto -t internal/service kratos proto server api/helloworld/helloworld.proto -t internal/service
# 生成所有proto源码、wire等等 # Generate all proto source code, wire, etc.
go generate ./... go generate ./...
# 编译成可执行文件 # compile
go build -o ./bin/ ./... go build -o ./bin/ ./...
# 运行程序 # run
./bin/helloworld -conf configs/ ./bin/helloworld -conf ./configs
``` ```
### Kratos Boot ### Kratos Boot
@ -99,9 +101,5 @@ app.Run()
* [Discord Group](https://discord.gg/BWzJsUJ) * [Discord Group](https://discord.gg/BWzJsUJ)
* QQ Group: 716486124 * QQ Group: 716486124
## Sponsors and Backers
![kratos](docs/images/alipay.png)
## License ## License
Kratos is MIT licensed. See the [LICENSE](./LICENSE) file for details. Kratos is MIT licensed. See the [LICENSE](./LICENSE) file for details.

109
README_zh.md
Unescape View File

@ -0,0 +1,109 @@
![kratos](docs/images/kratos.png)
[![Language](https://img.shields.io/badge/Language-Go-blue.svg)](https://golang.org/)
[![Build Status](https://github.com/go-kratos/kratos/workflows/Go/badge.svg)](https://github.com/go-kratos/kratos/actions)
[![GoDoc](https://pkg.go.dev/badge/github.com/go-kratos/kratos/v2)](https://pkg.go.dev/github.com/go-kratos/kratos/v2)
[![Go Report Card](https://goreportcard.com/badge/github.com/go-kratos/kratos/v2)](https://goreportcard.com/report/github.com/go-kratos/kratos/v2)
[![Discord](https://img.shields.io/discord/766619759214854164?label=chat&logo=discord)](https://discord.gg/BWzJsUJ)
Translations: [English](README.md) | [简体中文](README_zh.md)
# 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：遵循 OpenTracing 规范定义，以实现微服务链路追踪；
* Encoding：支持 Accept 和 Content-Type 进行自动选择内容编码；
* Transport：通用的 HTTP/gRPC 传输层，实现统一的 Middleware 插件支持；
* Registry：实现统一注册中心接口，可插件化对接各种注册中心；
## Getting Started
### Required
- [go](https://golang.org/dl/)
- [protoc](https://github.com/protocolbuffers/protobuf)
- [protoc-gen-go](https://github.com/protocolbuffers/protobuf-go)
### Installing
```
go get github.com/go-kratos/kratos/cmd/kratos/v2@latest
```
### Create a service
```
# 创建项目模板
kratos new helloworld
cd helloworld
# 生成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 ./...
# 编译成可执行文件
go build -o ./bin/ ./...
# 运行程序
./bin/helloworld -conf ./configs
```
### 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
* [Docs](https://go-kratos.dev/)
* [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
![kratos](docs/images/alipay.png)
## License
Kratos is MIT licensed. See the [LICENSE](./LICENSE) file for details.
Write Preview
Loading…
Cancel
Save