You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rocketmq.apache.org by aa...@apache.org on 2022/12/28 07:02:04 UTC
[rocketmq-clients] branch master updated: Polish docs (#328)
This is an automated email from the ASF dual-hosted git repository.
aaronai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/rocketmq-clients.git
The following commit(s) were added to refs/heads/master by this push:
new 933c7bfa Polish docs (#328)
933c7bfa is described below
commit 933c7bfae56c87324f36db92aa309ceadc756ee1
Author: Aaron Ai <ya...@gmail.com>
AuthorDate: Wed Dec 28 15:02:00 2022 +0800
Polish docs (#328)
---
README.md => README-CN.md | 36 +++++++++++++++++++-----------------
README.md | 2 ++
java/README-CN.md | 26 ++++++++++++++------------
java/README.md | 6 ++++--
4 files changed, 39 insertions(+), 31 deletions(-)
diff --git a/README.md b/README-CN.md
similarity index 70%
copy from README.md
copy to README-CN.md
index b2febc47..179e61f5 100644
--- a/README.md
+++ b/README-CN.md
@@ -1,4 +1,4 @@
-# RocketMQ Clients - Collection of Client Bindings for Apache RocketMQ
+# Apache RocketMQ 客户端
[![License][license-image]][license-url]
[![CPP][cpp-image]][cpp-url]
@@ -11,20 +11,22 @@
[![Codecov-golang][codecov-golang-image]][codecov-url]
[![Maven Central][maven-image]][maven-url]
-## Overview
+[English](README.md) | 简体中文 | [RocketMQ 官网](https://rocketmq.apache.org/)
-Client bindings for [Apache RocketMQ](https://rocketmq.apache.org/), all of them follow the specification of [rocketmq-apis](https://github.com/apache/rocketmq-apis), replacing 4.x remoting-based counterparts. Clients in this repository are built on top of [Protocol Buffers](https://developers.google.com/protocol-buffers) and [gRPC](https://grpc.io/).
+## 概述
-## Goal
+[Apache RocketMQ](https://rocketmq.apache.org/) 的多语言客户端实现。遵从 [rocketmq-apis](https://github.com/apache/rocketmq-apis) 约束，使用 [Protocol Buffers](https://developers.google.com/protocol-buffers) 和 [gRPC](https://grpc.io/) 替代了 4.x 的旧有协议。
-Provide cloud-native and robust solutions for Java, C++, C#, Golang, Rust and all other mainstream programming languages.
+## 设计目标
-## Features and Status
+为 Apache RocketMQ 提供包含 Java，C++，C#，Golang，JavaScript，Rust 在内的所有主流编程语言在内的云原生的，健壮的客户端解决方案。
-* Ready - ✅
-* Work in progress - 🚧
+## 特性与进度
-| Feature | Java | C/C++ | C# | Golang | Rust | Node.js | Python |
+* 可用 - ✅
+* 进行中 - 🚧
+
+| 特性 | Java | C/C++ | C# | Golang | Rust | Node.js | Python |
| ---------------------------------------------- | :---: | :---: | :---: | :----: | :---: | :-----: | :----: |
| Producer with standard messages | ✅ | ✅ | ✅ | ✅ | 🚧 | 🚧 | 🚧 |
| Producer with FIFO messages | ✅ | ✅ | ✅ | ✅ | 🚧 | 🚧 | 🚧 |
@@ -34,18 +36,18 @@ Provide cloud-native and robust solutions for Java, C++, C#, Golang, Rust and al
| Push consumer with concurrent message listener | ✅ | ✅ | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 |
| Push consumer with FIFO message listener | ✅ | ✅ | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 |
-## Contributing
+## 参与贡献
-Similar to other projects of Apache RocketMQ, any attempt to make this project better is welcome, including but not limited to filing a bug report, correcting type error or document writing to complete feature implementation. Do not hesitate to make a pull request if this project catches your attention.
+与 Apache RocketMQ 的其他项目类似，我们欢迎任何形式的贡献，包括但不仅限于提交 bug 报告、勘误纠错、文档撰写或提交 feature。从第一个 issue/pull request 开始！
-## Related
+## 相关链接
-* [rocketmq](https://github.com/apache/rocketmq): The implementation of server-side.
-* [rocketmq-apis](https://github.com/apache/rocketmq-apis): Common communication protocol between server and client.
-* [RIP-37: New and Unified APIs](https://shimo.im/docs/m5kv92OeRRU8olqX): RocketMQ proposal of new and unified APIs crossing different languages.
-* [RIP-39: Support gRPC protocol](https://shimo.im/docs/gXqmeEPYgdUw5bqo): RocketMQ proposal of gRPC protocol support.
+* [rocketmq](https://github.com/apache/rocketmq): RocketMQ 主仓库（含服务端实现）。
+* [rocketmq-apis](https://github.com/apache/rocketmq-apis): RocketMQ 协议约束。
+* [RIP-37: New and Unified APIs](https://shimo.im/docs/m5kv92OeRRU8olqX): RocketMQ 关于统一精简 API 设计的 RIP。
+* [RIP-39: Support gRPC protocol](https://shimo.im/docs/gXqmeEPYgdUw5bqo): RocketMQ 关于 gRPC 协议支持的 RIP。
-## License
+## 开源许可证
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) Copyright (C) Apache Software Foundation
diff --git a/README.md b/README.md
index b2febc47..aef845fc 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,8 @@
[![Codecov-golang][codecov-golang-image]][codecov-url]
[![Maven Central][maven-image]][maven-url]
+English | [简体中文](README-CN.md) | [RocketMQ Website](https://rocketmq.apache.org/)
+
## Overview
Client bindings for [Apache RocketMQ](https://rocketmq.apache.org/), all of them follow the specification of [rocketmq-apis](https://github.com/apache/rocketmq-apis), replacing 4.x remoting-based counterparts. Clients in this repository are built on top of [Protocol Buffers](https://developers.google.com/protocol-buffers) and [gRPC](https://grpc.io/).
diff --git a/java/README-CN.md b/java/README-CN.md
index 64821cae..1ce1be29 100644
--- a/java/README-CN.md
+++ b/java/README-CN.md
@@ -1,13 +1,15 @@
# Java 客户端
-[English](README.md) | 简体中文
+[English](README.md) | 简体中文 | [RocketMQ 官网](https://rocketmq.apache.org/)
-不同于[基于 RemotingCommand 协议的客户端](https://github.com/apache/rocketmq/tree/develop/client)，当前的客户端是基于 RocektMQ 5.0 存算分离架构，是 RocketMQ 社区目前推荐的接入方式，也是未来客户端演进的主方向。
+## 概述
-在开始客户端的部分之前，可能需要的一些前期准备工作：
+不同于[基于 RemotingCommand 协议的版本](https://github.com/apache/rocketmq/tree/develop/client)，当前的客户端基于 RocektMQ 5.0 存算分离架构进行设计开发，是 RocketMQ 社区目前推荐的接入方式，也是未来客户端演进的主要方向。
-1. Java 8 是确保客户端运行的最小版本，Java 11 是确保客户端编译的最小版本；
-2. 提前部署好 namesrv，broker 以及 [proxy](https://github.com/apache/rocketmq/tree/develop/proxy) 组件。
+在开始客户端的部分之前，所需的一些前期工作（或者参照[这里](https://rocketmq.apache.org/zh/docs/quickStart/02quickstart/)）：
+
+1. 准备 Java 环境。Java 8 是确保客户端运行的最小版本，Java 11 是确保客户端编译的最小版本；
+2. 部署 namesrv，broker 以及 [proxy](https://github.com/apache/rocketmq/tree/develop/proxy) 组件。
## 快速开始
@@ -28,7 +30,9 @@ implementation("org.apache.rocketmq:rocketmq-client-java:${rocketmq.version}")
implementation 'org.apache.rocketmq:rocketmq-client-java:${rocketmq.version}'
```
-`rocketmq-client-java` 是一个经过 shade 之后的版本，这意味着它本身的依赖是不能被手动替换的。通常情况下，shade 是规避多个类库之间依赖冲突的有效方式。对于一些特殊场景，我们仍然提供了未经 shade 的版本。
+`rocketmq-client-java` 是一个经过 shade 的版本，这意味着它本身的依赖是不能被手动替换的。
+
+通常情况下，shade 是规避多个类库之间依赖冲突的有效方式。由于一些特殊场景的存在，客户端仍然提供未经 shade 的版本。如果不确定具体应该使用哪个版本，shade 之后的版本是首选。
```xml
<!-- For Apache Maven -->
@@ -45,15 +49,13 @@ implementation("org.apache.rocketmq:rocketmq-client-java-noshade:${rocketmq.vers
implementation 'org.apache.rocketmq:rocketmq-client-java-noshade:${rocketmq.version}'
```
-如果不确定是否应该使用哪个版本，那么请使用 shade 之后的版本，即 `rocketmq-client-java`。
-
-我们在这里提供了[代码示例](./client/src/main/java/org/apache/rocketmq/client/java/example)来帮助使用不同的客户端和不同的消息类型。
+内部的[代码示例](./client/src/main/java/org/apache/rocketmq/client/java/example)可以帮助你上手不同的客户端和消息类型。
-## 日志
+## 日志系统
-我们使用 [Logback](https://logback.qos.ch/) 来作为日志实现，为了保证日志能够始终被有效地持久化，我们将 Logback 集成到了内部。`rocketmq-client-java` 中使用了一个 shade 之后的 Logback，并会使用单独的配置文件。
+采用 [Logback](https://logback.qos.ch/) 来作为实现，为了保证日志能够始终被有效地持久化，`rocketmq-client-java` 中集成了一个 shade 之后的 Logback，并会为其使用单独的配置文件。
-在满足日志被有效持久化的前提下，以下是一些可以灵活配置的日志参数，所有参数均支持 JVM 系统参数（e.g. `java -Drocketmq.log.level=INFO -jar foobar.jar`）或环境变量进行指定。
+客户端提供了一些可配置的日志参数，均支持 JVM 系统参数（示例： `java -Drocketmq.log.level=INFO -jar foobar.jar`）或环境变量指定：
* `rocketmq.log.level`: 日志输出级别，默认为 INFO。
* `rocketmq.log.root`: 日志输出根目录，默认为当前用户的 HOME 目录。
diff --git a/java/README.md b/java/README.md
index 6e479da4..95fa9a7f 100644
--- a/java/README.md
+++ b/java/README.md
@@ -1,10 +1,12 @@
# The Java Implementation of Apache RocketMQ Client
-English | [简体中文](README-CN.md)
+English | [简体中文](README-CN.md) | [RocketMQ Website](https://rocketmq.apache.org/)
+
+## Overview
Here is the java implementation of the client for [Apache RocketMQ](https://rocketmq.apache.org/). Different from the [remoting-based client](https://github.com/apache/rocketmq/tree/develop/client), the current implementation is based on separating architecture for computing and storage, which is the more recommended way to access the RocketMQ service.
-Here are some preparations you may need to know.
+Here are some preparations you may need to know (or refer to [here](https://rocketmq.apache.org/docs/quickStart/02quickstart/https://rocketmq.apache.org/docs/quickStart/02quickstart/)).
1. Java 8+ for runtime, Java 11+ for the build;
2. Setup namesrv, broker, and [proxy](https://github.com/apache/rocketmq/tree/develop/proxy).