This is an automated email from the ASF dual-hosted git repository.
alexstocks pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/dubbo-go.git
The following commit(s) were added to refs/heads/develop by this push:
new 28ae4cc17 docs: Update README to include tools for Dubbo-Go
development (#2954)
28ae4cc17 is described below
commit 28ae4cc1761e72a3049f7de181ea5514277c62d0
Author: Xuetao Li <[email protected]>
AuthorDate: Fri Jul 18 09:52:05 2025 +0800
docs: Update README to include tools for Dubbo-Go development (#2954)
* docs: Update README to include tools for Dubbo-Go development
* docs: Add Chinese translation of README and enhance English version
* docs: Update README
---
README.md | 67 ++++++++++++--
README_CN.md | 285 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 346 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index c2966f506..a417c0c25 100644
--- a/README.md
+++ b/README.md
@@ -8,13 +8,11 @@
---
-Apache Dubbo is an easy-to-use Web and RPC framework that provides multiple
-language implementations(Go, [Java](https://github.com/apache/dubbo),
[Rust](https://github.com/apache/dubbo-rust),
[Node.js](https://github.com/apache/dubbo-js),
[Web](https://github.com/apache/dubbo-js)) for communication, service
discovery, traffic management,
-observability, security, tools, and best practices for building
enterprise-ready microservices.
+English | [中文](README_CN.md)
-Dubbo-go is the Go implementation of [triple
protocol](https://dubbo.apache.org/zh-cn/overview/reference/protocols/triple-spec/)(a
fully gRPC compatible and HTTP-friendly protocol) and the various features for
building microservice architecture designed by Dubbo.
+Dubbo-go is a high-performance RPC framework for Go language microservices,
covering various network protocols: Triple, Dubbo, JSONRPC, gRPC, HTTP, HTTP2,
etc. It is the ideal choice for writing microservices in Go.
-Visit [the official website](https://dubbo.apache.org/) for more information.
+You can visit [the official website](https://dubbo.apache.org/) for more
information.
## Getting started
@@ -83,6 +81,63 @@ See the
[samples](https://github.com/apache/dubbo-go-samples) for detailed infor
- **Observability**: metrics(Prometheus, Grafana) and tracing(Jaeger, Zipkin).
- **HA Strategy**: Failover, Failfast, Failsafe/Failback, Available,
Broadcast, Forking
+
+## ️ Tools
+
+The `tools/` directory and the `dubbogo/tools` repository provide several
utilities to streamline your Dubbo-Go development experience.
+
+###
[dubbo-go-schema](https://github.com/apache/dubbo-go/tree/main/tools/dubbo-go-schema)
+
+A tool that provides JSON Schema for Dubbo-Go configuration files. This
simplifies the configuration process by enabling editor assistance.
+
+**Features:**
+
+* **Intelligent Assistance:** Enables code completion, hints, and real-time
validation for configuration files in supported IDEs.
+* **Simplified Configuration:** Helps you write valid and accurate
configurations with ease.
+
+For usage details, see the [dubbo-go-schema
README](./tools/dubbo-go-schema/README.md).
+
+
+###
[dubbogo-cli-v2](https://github.com/dubbogo/tools/tree/master/cmd/dubbogo-cli-v2)
+
+A comprehensive command-line tool for bootstrapping, managing, and debugging
your Dubbo-Go applications.
+
+**Features:**
+
+* **Project Scaffolding:** Quickly create new application templates.
+* **Tool Management:** Install and manage essential development tools.
+* **Interface Debugging:** Provides commands to debug your services.
+
+*Note: This tool replaces the deprecated
[dubbogo-cli](https://github.com/dubbogo/tools/tree/master/cmd/dubbogo-cli).*
+
+For usage details, see the [dubbogo-cli-v2
README](https://github.com/dubbogo/tools/tree/master/cmd/dubbogo-cli-v2).
+
+
+### [protoc-gen-go-triple](https://github.com/dubbogo/protoc-gen-go-triple)
+
+A `protoc` plugin that generates golang code for the Triple protocol from your
`.proto` (Protocol Buffer) definition files.
+
+**Features:**
+
+* **Code Generation:** Generates golang client and server stubs for the Triple
protocol.
+* **Seamless Integration:** Works alongside the official `protoc-gen-go` to
produce both Protobuf message code (`.pb.go`) and Triple interface code
(`.triple.go`).
+
+*Note: This tool replaces the deprecated
[protoc-gen-dubbo3grpc](https://github.com/dubbogo/tools/tree/master/cmd/protoc-gen-dubbo3grpc)
and deprecated
[protoc-gen-go-triple](https://github.com/dubbogo/tools/tree/master/cmd/protoc-gen-go-triple).*
+
+For usage details, see the [protoc-gen-go-triple
README](https://github.com/dubbogo/protoc-gen-go-triple).
+
+
+###
[imports-formatter](https://github.com/dubbogo/tools?tab=readme-ov-file#imports-formatter)
+
+This is a plugin for dubbo-go developers. A code formatting tool that
organizes golang `import` blocks according to the Dubbo-Go community style
guide.
+
+**Features:**
+
+* **Automatic Formatting:** Splits `import` statements into three distinct
groups: golang standard library, third-party libraries, and internal project
packages.
+* **Code Consistency:** Enforces a clean and consistent import style across
the codebase.
+
+For usage details, see the [imports-formatter
README](https://github.com/dubbogo/tools?tab=readme-ov-file#imports-formatter).
+
## Ecosystem
- [dubbo-go-samples](https://github.com/apache/dubbo-go-samples)
- [dubbo-go-pixiu which acting as a proxy to solve Dubbo multi-language
interoperability](https://github.com/apache/dubbo-go-pixiu)
@@ -231,4 +286,4 @@ If you are using
[apache/dubbo-go](https://github.com/apache/dubbo-go) and think
## License
-Apache Dubbo-go software is licensed under the Apache License Version 2.0. See
the LICENSE file for details.
+Apache Dubbo-go software is licensed under the Apache License Version 2.0. See
the [LICENSE](./LICENSE) file for details.
diff --git a/README_CN.md b/README_CN.md
new file mode 100644
index 000000000..9ed9ad174
--- /dev/null
+++ b/README_CN.md
@@ -0,0 +1,285 @@
+# Apache Dubbo for Golang
+
+[](https://travis-ci.org/apache/dubbo-go)
+[](https://codecov.io/gh/apache/dubbo-go)
+[](https://pkg.go.dev/github.com/apache/dubbo-go?tab=doc)
+[](https://goreportcard.com/report/github.com/apache/dubbo-go)
+
+
+---
+
+[English](README.md) | 中文
+
+Dubbo-go 是一款高性能 Go 语言微服务 RPC
框架，生态覆盖多种网络协议：Triple、Dubbo、JSONRPC、gRPC、HTTP、HTTP2等，是编写 go 语言微服务的不二之选。
+
+您可以访问[官网](https://dubbo.apache.org/)以获取更多信息。
+
+## 快速开始
+
+您可以跟随我们的[快速开始](https://github.com/apache/dubbo-go-samples/tree/main/helloworld)示例，在
5 分钟内逐步学习如何开发一个 dubbo-go RPC 应用。
+
+过程如下方代码所示，非常简单：您使用 Protobuf 定义一个服务，提供您自己的服务实现，将其注册到服务器，然后启动服务器。
+
+```go
+func (srv *GreetTripleServer) Greet(ctx context.Context, req
*greet.GreetRequest) (*greet.GreetResponse, error) {
+ resp := &greet.GreetResponse{Greeting: req.Name}
+ return resp, nil
+}
+
+func main() {
+ srv, _ := server.NewServer(
+ server.WithServerProtocol(
+ protocol.WithPort(20000),
+ protocol.WithTriple(),
+ ),
+ )
+
+ _ := greet.RegisterGreetServiceHandler(srv, &GreetTripleServer{})
+
+ if err := srv.Serve(); err != nil {
+ logger.Error(err)
+ }
+}
+```
+
+服务器启动并运行后，您可以通过 cURL 调用您的服务：
+
+```shell
+curl \
+ --header "Content-Type: application/json" \
+ --data '{"name": "Dubbo"}' \
+ http://localhost:20000/greet.GreetService/Greet
+```
+
+或者，您也可以启动一个标准的 dubbo-go 客户端来调用该服务：
+
+```go
+func main() {
+ cli, _ := client.NewClient(
+ client.WithClientURL("127.0.0.1:20000"),
+ )
+
+ svc, _ := greet.NewGreetService(cli)
+
+ resp, _ := svc.Greet(context.Background(), &greet.GreetRequest{Name:
"hello world"})
+
+ logger.Infof("Greet response: %s", resp.Greeting)
+}
+```
+
+有关详细用法，请参阅[示例](https://github.com/apache/dubbo-go-samples)。接下来，请访问官网，了解如何部署、监控和管理您的
dubbo-go 应用的流量。
+
+## 功能特性
+
+
+
+- **RPC 协议**: Triple 协议，兼容 gRPC 且对 HTTP 友好
+- **服务发现**: Nacos、Zookeeper、Etcd、Polaris-mesh、Consul
+- **负载均衡**: 自适应、随机、轮询、最少活跃调用、一致性哈希
+- **流量管理**: 流量切分、超时设置、速率限制、金丝雀发布
+- **配置**: YAML 文件、动态配置（Nacos、Zookeeper 等）
+- **可观测性**: 指标（Prometheus、Grafana）和追踪（Jaeger、Zipkin）
+- **高可用策略**: 故障转移 (Failover)、快速失败 (Failfast)、失败安全/失败自动恢复
(Failsafe/Failback)、可用性优先 (Available)、广播 (Broadcast)、并行调用 (Forking)
+
+## ️ 工具
+
+`tools/` 目录和 `dubbogo/tools` 仓库提供了一些实用工具，以简化您的 Dubbo-Go 开发体验。
+
+###
[dubbo-go-schema](https://github.com/apache/dubbo-go/tree/main/tools/dubbo-go-schema)
+
+该工具为 Dubbo-Go 配置文件提供 JSON Schema，通过编辑器辅助功能简化配置过程。
+
+**功能：**
+
+* **智能辅助：** 在支持的 IDE 中为配置文件启用代码补全、提示和实时校验。
+* **简化配置：** 帮助您轻松编写有效且准确的配置。
+
+有关使用详情，请参阅 [dubbo-go-schema
README](https://www.google.com/search?q=./tools/dubbo-go-schema/README.md)。
+
+###
[dubbogo-cli-v2](https://github.com/dubbogo/tools/tree/master/cmd/dubbogo-cli-v2)
+
+一个功能全面的命令行工具，用于引导、管理和调试您的 Dubbo-Go 应用。
+
+**功能：**
+
+* **项目脚手架：** 快速创建新的应用模板。
+* **工具管理：** 安装和管理必要的开发工具。
+* **接口调试：** 提供命令来调试您的服务。
+
+*注意：该工具取代了已废弃的
[dubbogo-cli](https://github.com/dubbogo/tools/tree/master/cmd/dubbogo-cli)。*
+
+有关使用详情，请参阅 [dubbogo-cli-v2
README](https://github.com/dubbogo/tools/tree/master/cmd/dubbogo-cli-v2)。
+
+### [protoc-gen-go-triple](https://github.com/dubbogo/protoc-gen-go-triple)
+
+一个 `protoc` 插件，用于从您的 `.proto` (Protocol Buffer) 定义文件为 Triple 协议生成 Golang 代码。
+
+**功能：**
+
+* **代码生成：** 为 Triple 协议生成 Golang 客户端和服务器存根（stub）。
+* **无缝集成：** 与官方的 `protoc-gen-go` 协同工作，同时生成 Protobuf 消息代码（`.pb.go`）和 Triple
接口代码（`.triple.go`）。
+
+*注意：该工具取代了已废弃的
[protoc-gen-dubbo3grpc](https://github.com/dubbogo/tools/tree/master/cmd/protoc-gen-dubbo3grpc)
和已废弃的
[protoc-gen-go-triple](https://github.com/dubbogo/tools/tree/master/cmd/protoc-gen-go-triple)。*
+
+有关使用详情，请参阅 [protoc-gen-go-triple
README](https://github.com/dubbogo/protoc-gen-go-triple)。
+
+###
[imports-formatter](https://github.com/dubbogo/tools?tab=readme-ov-file#imports-formatter)
+
+这是一个面向 Dubbo-Go 开发者的插件，它是一款代码格式化工具，它根据 Dubbo-Go 社区的风格指南来组织 Golang 的 `import`
代码块。
+
+**功能：**
+
+* **自动格式化：** 将 `import` 语句分为三个独立的组：Golang 标准库、第三方库和项目内部包。
+* **代码一致性：** 在整个代码库中强制执行干净、一致的导入风格。
+
+有关使用详情，请参阅 [imports-formatter
README](https://github.com/dubbogo/tools?tab=readme-ov-file#imports-formatter)。
+
+## 生态系统
+
+- [dubbo-go-samples](https://github.com/apache/dubbo-go-samples)
+- [dubbo-go-pixiu: 作为代理解决 Dubbo
多语言互通问题](https://github.com/apache/dubbo-go-pixiu)
+- [与 Dubbo Java
互通](https://dubbo-next.staged.apache.org/zh-cn/overview/mannual/golang-sdk/tutorial/interop-dubbo/)
+- [Protoc-gen-go-triple](https://github.com/dubbogo/protoc-gen-go-triple/)
+- [控制台 (Console)](https://github.com/apache/dubbo-kubernetes)，开发中
+
+## 贡献代码
+
+关于提交补丁和贡献流程的详细信息，请访问
[CONTRIBUTING](https://www.google.com/search?q=./CONTRIBUTING.md)。
+
+## 联系我们
+
+通过钉钉、微信或 Discord 加入我们的讨论组。
+
+discord https://discord.gg/C5ywvytg
+
+
+
+## [用户列表](https://github.com/apache/dubbo-go/issues/2)
+
+如果您正在使用 [apache/dubbo-go](https://github.com/apache/dubbo-go) 并且它对您有所帮助，或者您想为
Dubbo-go
贡献代码，请将您的公司添加到[用户列表](https://github.com/apache/dubbo-go/issues/2)，让我们了解您的需求。
+
+<div>
+<table>
+ <tbody>
+ <tr></tr>
+ <tr>
+ <td align="center" valign="middle">
+ <a href="" target="_blank">
+ <img width="222px" src="./doc/imgs/usecase-beike.png">
+ </a>
+ </td>
+ <td align="center" valign="middle">
+ <a href="" target="_blank">
+ <img width="222px" src="./doc/imgs/usecase-gaode.png">
+ </a>
+ </td>
+ <td align="center" valign="middle">
+ <a href="" target="_blank">
+ <img width="222px" src="./doc/imgs/usecase-eht.png">
+ </a>
+ </td>
+ <td align="center" valign="middle">
+ <a href="https://github.com/mosn"; target="_blank">
+ <img width="222px" src="./doc/imgs/usecase-mosn.png">
+ </a>
+ </td>
+ <td align="center" valign="middle">
+ <a href="" target="_blank">
+ <img width="222px" src="./doc/imgs/usecase-pdd.png">
+ </a>
+ </td>
+ </tr>
+ <tr></tr>
+ <tr>
+ <td align="center" valign="middle">
+ <a href="http://www.j.cn"; target="_blank">
+ <img width="222px" src="./doc/imgs/usecase-jd.png">
+ </a>
+ </td>
+ <td align="center" valign="middle">
+ <a href="" target="_blank">
+ <img width="222px" src="./doc/imgs/usecase-kaikele.png">
+ </a>
+ </td>
+ <td align="center" valign="middle">
+ <a href="" target="_blank">
+ <img width="222px" src="./doc/imgs/usecase-sohu.png">
+ </a>
+ </td>
+ <td align="center" valign="middle">
+ <a href="https://www.zto.com"; target="_blank">
+ <img width="222px" src="./doc/imgs/usecase-zto.png">
+ </a>
+ </td>
+ <td align="center" valign="middle">
+ <a href="" target="_blank">
+ <img width="222px" src="./doc/imgs/usecase-tianyi.png">
+ </a>
+ </td>
+ </tr>
+ <tr></tr>
+ <tr>
+ <td align="center" valign="middle">
+ <a href="http://www.mgtv.com"; target="_blank">
+ <img width="222px" src="./doc/imgs/usecase-mgtv.png">
+ </a>
+ </td>
+ <td align="center" valign="middle">
+ <a href="" target="_blank">
+ <img width="222px" src="./doc/imgs/usecase-vivo.png">
+ </a>
+ </td>
+ <td align="center" valign="middle">
+ <a href="http://www.ruubypay.com"; target="_blank">
+ <img width="222px" src="./doc/imgs/usecase-tuya.png">
+ </a>
+ </td>
+ <td align="center" valign="middle">
+ <a href="https://www.dingtalk.com"; target="_blank">
+ <img width="222px" src="./doc/imgs/usecase-xiecheng.png">
+ </a>
+ </td>
+ <td align="center" valign="middle">
+ <a href="https://www.autohome.com.cn"; target="_blank">
+ <img width="222px" src="./doc/imgs/usecase-autohome.png">
+ </a>
+ </td>
+ </tr>
+ <tr></tr>
+ <tr>
+ <td align="center" valign="middle">
+ <a href="https://www.mi.com/"; target="_blank">
+ <img width="222px" src="./doc/imgs/usecase-mi.png">
+ </a>
+ </td>
+ <td align="center" valign="middle">
+ <a href="https://opayweb.com/"; target="_blank">
+ <img width="222px" src="./doc/imgs/usecase-zonghengwenxue.png">
+ </a>
+ </td>
+ <td align="center" valign="middle">
+ <a href="" target="_blank">
+ <img width="222px" src="./doc/imgs/usecase-tiger-brokers.png">
+ </a>
+ </td>
+ <td align="center" valign="middle">
+ <a href="" target="_blank">
+ <img width="222px" src="./doc/imgs/usecase-zhanzhang.png" >
+ </a>
+ </td>
+ <td align="center" valign="middle">
+ <a href="" target="_blank">
+ <img width="222px" src="./doc/imgs/usecase-genshuixue.png" >
+ </a>
+ </td>
+ </tr>
+ <tr></tr>
+ </tbody>
+</table>
+</div>
+
+[查看更多用户案例](https://github.com/apache/dubbo-go/issues/2)
+
+## 许可证
+
+Apache Dubbo-go 软件基于 Apache 许可证 2.0 版本进行许可。详情请参阅 [LICENSE](./LICENSE) 文件。
\ No newline at end of file
