Skip to content
Snippets Groups Projects
README_CN.md 4.45 KiB
Newer Older
zonghaishang's avatar
zonghaishang committed
# Apache Dubbo-go [English](./README.md) #

[![Build Status](https://travis-ci.org/apache/dubbo-go.svg?branch=master)](https://travis-ci.org/apache/dubbo-go)
[![codecov](https://codecov.io/gh/apache/dubbo-go/branch/master/graph/badge.svg)](https://codecov.io/gh/apache/dubbo-go)

---
Apache Dubbo Go 语言实现

## 证书 ##

Apache License, Version 2.0

## 发布日志 ##

[v1.0.0 - 2019年5月29日 兼容dubbo v2.6.5 版本](https://github.com/apache/dubbo-go/releases/tag/v1.0.0)

## 工程架构 ##

基于dubbo的extension模块和分层的代码设计(包括 protocol layer, registry layer, cluster layer, config 等等)。我们的目标是:你可以对这些分层接口进行新的实现,并通过调用 extension 模块的“ extension.SetXXX ”方法来覆盖 dubbo-go [同 go-for-apache-dubbo ]的默认实现,以完成自己的特殊需求而无需修改源代码。同时,欢迎你为社区贡献有用的拓展实现。

![框架设计](https://raw.githubusercontent.com/wiki/dubbo/dubbo-go/dubbo-go%E4%BB%A3%E7%A0%81%E5%88%86%E5%B1%82%E8%AE%BE%E8%AE%A1.png)

关于详细设计请阅读 [code layered design](https://github.com/apache/dubbo-go/wiki/dubbo-go-V1.0-design)

## 功能列表 ##

实现列表:

vito.he's avatar
vito.he committed
- 角色端: Consumer, Provider
- 传输协议: HTTP, TCP
- 序列化协议: JsonRPC v2, Hessian v2
vito.he's avatar
vito.he committed
- 注册中心: ZooKeeper/[etcd v3](https://github.com/apache/dubbo-go/pull/148)/[nacos](https://github.com/apache/dubbo-go/pull/151)/[consul](https://github.com/apache/dubbo-go/pull/121)
vito.he's avatar
vito.he committed
- 动态配置中心与服务治理配置器(config center): Zookeeper
vito.he's avatar
vito.he committed
- 集群策略: Failover/[Failfast](https://github.com/apache/dubbo-go/pull/140)/[Failsafe/Failback](https://github.com/apache/dubbo-go/pull/136)/[Available](https://github.com/apache/dubbo-go/pull/155)/[Broadcast](https://github.com/apache/dubbo-go/pull/158)/[Forking](https://github.com/apache/dubbo-go/pull/161)
vito.he's avatar
vito.he committed
- 负载均衡策略: Random/[RoundRobin](https://github.com/apache/dubbo-go/pull/66)/[LeastActive](https://github.com/apache/dubbo-go/pull/65)
- 过滤器: Echo Health Check/[服务熔断&降级](https://github.com/apache/dubbo-go/pull/133)/[TokenFilter](https://github.com/apache/dubbo-go/pull/202)/[AccessLogFilter](https://github.com/apache/dubbo-go/pull/214)/[TpsLimitFilter](https://github.com/apache/dubbo-go/pull/237)
vito.he's avatar
vito.he committed
- 其他功能支持: [泛化调用](https://github.com/apache/dubbo-go/pull/122)/启动时检查/服务直连/多服务协议/多注册中心/多服务版本/服务分组
zonghaishang's avatar
zonghaishang committed

开发中列表:

vito.he's avatar
vito.he committed
- 集群策略: Forking
- 负载均衡策略: ConsistentHash
- 过滤器: CountFilter/ExecuteLimitFilter
AlexStocks's avatar
AlexStocks committed
- 注册中心: k8s
vito.he's avatar
vito.he committed
- 配置中心: apollo
vito.he's avatar
vito.he committed
- 元数据中心 (dubbo v2.7.x)
AlexStocks's avatar
AlexStocks committed
- Metrics: Promethus(dubbo v2.7.x)
zonghaishang's avatar
zonghaishang committed

任务列表:

vito.he's avatar
vito.he committed
- 注册中心: kubernetes
AlexStocks's avatar
AlexStocks committed
- Routing: istio
zonghaishang's avatar
zonghaishang committed
- tracing (dubbo ecosystem)

你可以通过访问 [roadmap](https://github.com/apache/dubbo-go/wiki/Roadmap) 知道更多关于 dubbo-go 的信息

fangyincheng's avatar
fangyincheng committed
## 文档

vito.he's avatar
vito.he committed
TODO
fangyincheng's avatar
fangyincheng committed

zonghaishang's avatar
zonghaishang committed
## 快速开始 ##

amudong's avatar
amudong committed
[dubbogo-samples](https://github.com/dubbogo/dubbogo-samples)这个项目的事例展示了如何使用 dubbo-go 。请仔细阅读 [dubbogo-samples/README.md](https://github.com/dubbogo/dubbogo-samples/blob/master/README.md) 学习如何处理配置并编译程序。
zonghaishang's avatar
zonghaishang committed

fangyincheng's avatar
fangyincheng committed
## 运行单测

### 准备

Mac/Linux
fangyincheng's avatar
fangyincheng committed
```bash
vito.he's avatar
vito.he committed
sh ./before_ut.sh
```

Windows
```bash
before_ut.bat
```

# 执行
fangyincheng's avatar
fangyincheng committed
```bash
go test ./...

# coverage
fangyincheng's avatar
fangyincheng committed
go test ./... -coverprofile=coverage.txt -covermode=atomic
```

## 如何贡献

如果您愿意给 [Apache/dubbo-go](https://github.com/apache/dubbo-go) 贡献代码或者文档,我们都热烈欢迎。具体请参考 [contribution intro](https://github.com/apache/dubbo-go/blob/master/contributing.md)
zonghaishang's avatar
zonghaishang committed
## 性能测试 ##

AlexStocks's avatar
AlexStocks committed
性能测试项目是 [dubbo-go-benchmark](https://github.com/dubbogo/dubbo-go-benchmark)
zonghaishang's avatar
zonghaishang committed

AlexStocks's avatar
AlexStocks committed
关于 dubbo-go 性能测试报告,请阅读 [dubbo benchmarking report](https://github.com/apache/dubbo-go/wiki/pressure-test-report-for-dubbo) & [jsonrpc benchmarking report](https://github.com/apache/dubbo-go/wiki/pressure-test-report-for-jsonrpc)
zonghaishang's avatar
zonghaishang committed

## [User List](https://github.com/apache/dubbo-go/issues/2)

yuyu's avatar
yuyu committed
若你正在使用 [apache/dubbo-go](github.com/apache/dubbo-go) 且认为其有用或者向对其做改进,请忝列贵司信息于 [用户列表](https://github.com/apache/dubbo-go/issues/2),以便我们知晓之。

zonghaishang's avatar
zonghaishang committed
![ctrip](https://pic.c-ctrip.com/common/c_logo2013.png)

## Stargazers

[![Stargazers over time](https://starchart.cc/apache/dubbo-go.svg)](https://starchart.cc/apache/dubbo-go)