kratos

module
v1.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 2, 2020 License: MIT

README

kratos

Kratos

Kratos 是 B 站开源的一套 Go 微服务框架,包含大量微服务相关框架及工具。

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

Goals

我们致力于提供完整的微服务研发体验,整合相关框架及工具后,微服务治理相关部分可对整体业务开发周期无感,从而更加聚焦于业务交付。对每位开发者而言,整套Kratos 框架也是不错的学习仓库。

Features

  • HTTP Blademaster:核心基于gin进行模块化设计,简单易用、核心足够轻量;
  • GRPC Warden:基于官方gRPC开发,集成discovery服务发现,并融合P2C负载均衡;
  • Cache:优雅的接口化设计,非常方便的缓存序列化,推荐结合代理模式overlord
  • Database:集成MySQL/HBase/TiDB,添加熔断保护和统计支持,可快速发现数据层压力;
  • Config:方便易用的paladin sdk,可配合远程配置中心,实现配置版本管理和更新;
  • Log:类似zap的field实现高性能日志库,并结合log-agent实现远程日志管理;
  • Trace:基于opentracing,集成了全链路trace支持(gRPC/HTTP/MySQL/Redis/Memcached);
  • Kratos Tool:工具链,可快速生成标准项目,或者通过Protobuf生成代码,非常便捷使用gRPC、HTTP、swagger文档;

Quick start

Requirments
  1. Golang 版本要求:go version>=1.13
  2. 设置环境变量:
       # 强制使用 go module 模式
       export GO111MODULE=on
    
       # 将 GOPATH 加入环境路径
       export PATH=$PATH:$GOPATH/bin
    
       # 设置启用 goproxy 代理,加速国外包
       # https://goproxy.cn 是七牛维护的国内镜像代理,若有问题,还可使用官方代理:https://goproxy.io
       go env -w GOPROXY=https://goproxy.cn,direct 
    
       # 我们使用的是 coding 私有仓库,需设置以域名"github.com"开头的仓库为私有包,不走代理,不校验
       # 若未来迁移至其它私有仓库,也需要设置
       go env -w GOPRIVATE=github.com
    
  3. 安装 protobuffer 编译器 protoc(注意:高版本的 protobuf 会导致引用的 grpc 版本升高,导致编译失败)
       Linux:
       wget https://github.com/protocolbuffers/protobuf/releases/download/v3.7.1/protoc-3.7.1-linux-x86_64.zip
       unzip protoc-3.7.1-linux-x86_64.zip
       cd protoc-3.7.1 && mv bin/protoc $GOPATH/bin/ && mv include/ $GOPATH/
    
    
Installation
  1. 联系管理员申请 github.com/djienet/kratos 私有仓库权限。

  2. 根据访问私有 coding 仓库的方式,设置 git:

    • 方式一:配置通过私有证书访问 coding 仓库(使用 git clone git@github.com:azoya/xxx 方式)。但当我们执行 go get github.com/djienet/kratos 安装时,go 默认会使用 git clone https://github.com/azoya/xxx 的方式访问目标仓库,因此,需设置 git clone https 私用仓库时强制使用 SSH(git@github.com)协议。

         git config --global url.git@github.com:.insteadOf https://github.com/
      
    • 方式二:未配置证书访问 coding 仓库,每次克隆仓库时需手动输入用户名/密码(git clone https://github.com/azoya/xxx 方式)。需要设置 git 记住用户名密码,因为 go get github.com/djienet/kratos 时会屏蔽输入,你无法手动输入用户名密码。

         git config --global credential.helper store
      

      注意: 初次安装,请手动 git clone https://github.com/djienet/kratos 且输入用户名/密码,让 git 记住用户密码。

  3. 安装框架 kratos 工具:

       go get -u github.com/djienet/kratos/tool/kratos
    

    检查:

       kratos -v
    

    能输出版本信息,则安装成功。

Generate Demo & Build & Run
kratos new kratos-demo
cd kratos-demo/cmd
go build
./cmd -conf ../configs

打开浏览器访问:http://localhost:8000/kratos-demo/start,你会看到输出了Golang 大法好 !!!

Documentation

简体中文
FAQ

License

Kratos is under the MIT license. See the LICENSE file for details.


Please report bugs, concerns, suggestions by issues, or join QQ-group 716486124 to discuss problems around source code.

Directories

Path Synopsis
example
pkg
cache/memcache/test
Package proto is a generated protocol buffer package.
Package proto is a generated protocol buffer package.
cache/redis
Package redis is a client for the Redis database.
Package redis is a client for the Redis database.
conf/dsn
Package dsn implements dsn parse with struct bind DSN 格式类似 URI, DSN 结构如下图 network:[//[username[:password]@]address[:port][,address[:port]]][/path][?query][#fragment] 与 URI 的主要区别在于 scheme 被替换为 network, host 被替换为 address 并且支持多个 address.
Package dsn implements dsn parse with struct bind DSN 格式类似 URI, DSN 结构如下图 network:[//[username[:password]@]address[:port][,address[:port]]][/path][?query][#fragment] 与 URI 的主要区别在于 scheme 被替换为 network, host 被替换为 address 并且支持多个 address.
conf/env
Package env get env & app config, all the public field must after init() finished and flag.Parse().
Package env get env & app config, all the public field must after init() finished and flag.Parse().
container/group
Package group provides a sample lazy load container.
Package group provides a sample lazy load container.
log
Package log 是kratos日志库.
Package log 是kratos日志库.
log/internal/core
Package core houses zap's shared internal buffer pool.
Package core houses zap's shared internal buffer pool.
net/http/blademaster/binding/example
Package example is a generated protocol buffer package.
Package example is a generated protocol buffer package.
net/http/blademaster/render
Package render is a generated protocol buffer package.
Package render is a generated protocol buffer package.
net/rpc/warden/internal/benchmark/bench/proto
Package grpc is a generated protocol buffer package.
Package grpc is a generated protocol buffer package.
net/rpc/warden/internal/proto/testproto
Package testproto is a generated protocol buffer package.
Package testproto is a generated protocol buffer package.
str
sync/errgroup
Package errgroup provides synchronization, error propagation, and Context errgroup 包为一组子任务的 goroutine 提供了 goroutine 同步,错误取消功能.
Package errgroup provides synchronization, error propagation, and Context errgroup 包为一组子任务的 goroutine 提供了 goroutine 同步,错误取消功能.
tool
kratos-gen-project
You can use the "packr clean" command to clean up this, and any other packr generated files.
You can use the "packr clean" command to clean up this, and any other packr generated files.
kratos-gen-project/packrd
You can use the "packr2 clean" command to clean up this, and any other packr generated files.
You can use the "packr2 clean" command to clean up this, and any other packr generated files.
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL