README
¶
Kratos
Kratos是bilibili开源的一套Go微服务框架,包含大量微服务相关框架及工具。
名字来源于:《战神》游戏以希腊神话为背景,讲述由凡人成为战神的奎托斯(Kratos)成为战神并展开弑神屠杀的冒险历程。
Goals
我们致力于提供完整的微服务研发体验,整合相关框架及工具后,微服务治理相关部分可对整体业务开发周期无感,从而更加聚焦于业务交付。对每位开发者而言,整套Kratos框架也是不错的学习仓库,可以了解和参考到bilibili在微服务方面的技术积累和经验。
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
Go version>=1.13
Installation
GO111MODULE=on && go get -u github.com/gdchenli/kratos/tool/kratos
cd $GOPATH/src
kratos new kratos-demo
通过 kratos new
会快速生成基于kratos库的脚手架代码,如生成 kratos-demo
Build & Run
cd kratos-demo/cmd
go build
./cmd -conf ../configs
打开浏览器访问:http://localhost:8000/kratos-demo/start,你会看到输出了Golang 大法好 !!!
Documentation
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日志库. |
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. |
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. |
Click to show internal directories.
Click to hide internal directories.